code.delx.au - gnu-emacs/blob - lisp/gnus/gnus.el

   1 ;;; gnus.el --- a newsreader for GNU Emacs
   2
   3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
   4 ;; 1998, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
   5
   6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   7 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
   8 ;; Keywords: news, mail
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software; you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation; either version 2, or (at your option)
  15 ;; any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  25 ;; Boston, MA 02111-1307, USA.
  26
  27 ;;; Commentary:
  28
  29 ;;; Code:
  30
  31 (eval '(run-hooks 'gnus-load-hook))
  32
  33 (eval-when-compile (require 'cl))
  34 (require 'wid-edit)
  35 (require 'mm-util)
  36 (require 'nnheader)
  37 (autoload 'message-y-or-n-p "message" nil nil 'macro)
  38
  39 (defgroup gnus nil
  40   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
  41   :group 'news
  42   :group 'mail)
  43
  44 (defgroup gnus-format nil
  45   "Dealing with formatting issues."
  46   :group 'gnus)
  47
  48 (defgroup gnus-charset nil
  49   "Group character set issues."
  50   :link '(custom-manual "(gnus)Charsets")
  51   :version "21.1"
  52   :group 'gnus)
  53
  54 (defgroup gnus-cache nil
  55   "Cache interface."
  56   :link '(custom-manual "(gnus)Article Caching")
  57   :group 'gnus)
  58
  59 (defgroup gnus-registry nil
  60   "Article Registry."
  61   :group 'gnus)
  62
  63 (defgroup gnus-start nil
  64   "Starting your favorite newsreader."
  65   :group 'gnus)
  66
  67 (defgroup gnus-start-server nil
  68   "Server options at startup."
  69   :group 'gnus-start)
  70
  71 ;; These belong to gnus-group.el.
  72 (defgroup gnus-group nil
  73   "Group buffers."
  74   :link '(custom-manual "(gnus)Group Buffer")
  75   :group 'gnus)
  76
  77 (defgroup gnus-group-foreign nil
  78   "Foreign groups."
  79   :link '(custom-manual "(gnus)Foreign Groups")
  80   :group 'gnus-group)
  81
  82 (defgroup gnus-group-new nil
  83   "Automatic subscription of new groups."
  84   :group 'gnus-group)
  85
  86 (defgroup gnus-group-levels nil
  87   "Group levels."
  88   :link '(custom-manual "(gnus)Group Levels")
  89   :group 'gnus-group)
  90
  91 (defgroup gnus-group-select nil
  92   "Selecting a Group."
  93   :link '(custom-manual "(gnus)Selecting a Group")
  94   :group 'gnus-group)
  95
  96 (defgroup gnus-group-listing nil
  97   "Showing slices of the group list."
  98   :link '(custom-manual "(gnus)Listing Groups")
  99   :group 'gnus-group)
 100
 101 (defgroup gnus-group-visual nil
 102   "Sorting the group buffer."
 103   :link '(custom-manual "(gnus)Group Buffer Format")
 104   :group 'gnus-group
 105   :group 'gnus-visual)
 106
 107 (defgroup gnus-group-various nil
 108   "Various group options."
 109   :link '(custom-manual "(gnus)Scanning New Messages")
 110   :group 'gnus-group)
 111
 112 ;; These belong to gnus-sum.el.
 113 (defgroup gnus-summary nil
 114   "Summary buffers."
 115   :link '(custom-manual "(gnus)Summary Buffer")
 116   :group 'gnus)
 117
 118 (defgroup gnus-summary-exit nil
 119   "Leaving summary buffers."
 120   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
 121   :group 'gnus-summary)
 122
 123 (defgroup gnus-summary-marks nil
 124   "Marks used in summary buffers."
 125   :link '(custom-manual "(gnus)Marking Articles")
 126   :group 'gnus-summary)
 127
 128 (defgroup gnus-thread nil
 129   "Ordering articles according to replies."
 130   :link '(custom-manual "(gnus)Threading")
 131   :group 'gnus-summary)
 132
 133 (defgroup gnus-summary-format nil
 134   "Formatting of the summary buffer."
 135   :link '(custom-manual "(gnus)Summary Buffer Format")
 136   :group 'gnus-summary)
 137
 138 (defgroup gnus-summary-choose nil
 139   "Choosing Articles."
 140   :link '(custom-manual "(gnus)Choosing Articles")
 141   :group 'gnus-summary)
 142
 143 (defgroup gnus-summary-maneuvering nil
 144   "Summary movement commands."
 145   :link '(custom-manual "(gnus)Summary Maneuvering")
 146   :group 'gnus-summary)
 147
 148 (defgroup gnus-picon nil
 149   "Show pictures of people, domains, and newsgroups."
 150   :group 'gnus-visual)
 151
 152 (defgroup gnus-summary-mail nil
 153   "Mail group commands."
 154   :link '(custom-manual "(gnus)Mail Group Commands")
 155   :group 'gnus-summary)
 156
 157 (defgroup gnus-summary-sort nil
 158   "Sorting the summary buffer."
 159   :link '(custom-manual "(gnus)Sorting the Summary Buffer")
 160   :group 'gnus-summary)
 161
 162 (defgroup gnus-summary-visual nil
 163   "Highlighting and menus in the summary buffer."
 164   :link '(custom-manual "(gnus)Summary Highlighting")
 165   :group 'gnus-visual
 166   :group 'gnus-summary)
 167
 168 (defgroup gnus-summary-various nil
 169   "Various summary buffer options."
 170   :link '(custom-manual "(gnus)Various Summary Stuff")
 171   :group 'gnus-summary)
 172
 173 (defgroup gnus-summary-pick nil
 174   "Pick mode in the summary buffer."
 175   :link '(custom-manual "(gnus)Pick and Read")
 176   :prefix "gnus-pick-"
 177   :group 'gnus-summary)
 178
 179 (defgroup gnus-summary-tree nil
 180   "Tree display of threads in the summary buffer."
 181   :link '(custom-manual "(gnus)Tree Display")
 182   :prefix "gnus-tree-"
 183   :group 'gnus-summary)
 184
 185 ;; Belongs to gnus-uu.el
 186 (defgroup gnus-extract-view nil
 187   "Viewing extracted files."
 188   :link '(custom-manual "(gnus)Viewing Files")
 189   :group 'gnus-extract)
 190
 191 ;; Belongs to gnus-score.el
 192 (defgroup gnus-score nil
 193   "Score and kill file handling."
 194   :group 'gnus)
 195
 196 (defgroup gnus-score-kill nil
 197   "Kill files."
 198   :group 'gnus-score)
 199
 200 (defgroup gnus-score-adapt nil
 201   "Adaptive score files."
 202   :group 'gnus-score)
 203
 204 (defgroup gnus-score-default nil
 205   "Default values for score files."
 206   :group 'gnus-score)
 207
 208 (defgroup gnus-score-expire nil
 209   "Expiring score rules."
 210   :group 'gnus-score)
 211
 212 (defgroup gnus-score-decay nil
 213   "Decaying score rules."
 214   :group 'gnus-score)
 215
 216 (defgroup gnus-score-files nil
 217   "Score and kill file names."
 218   :group 'gnus-score
 219   :group 'gnus-files)
 220
 221 (defgroup gnus-score-various nil
 222   "Various scoring and killing options."
 223   :group 'gnus-score)
 224
 225 ;; Other
 226 (defgroup gnus-visual nil
 227   "Options controlling the visual fluff."
 228   :group 'gnus
 229   :group 'faces)
 230
 231 (defgroup gnus-agent nil
 232   "Offline support for Gnus."
 233   :group 'gnus)
 234
 235 (defgroup gnus-files nil
 236   "Files used by Gnus."
 237   :group 'gnus)
 238
 239 (defgroup gnus-dribble-file nil
 240   "Auto save file."
 241   :link '(custom-manual "(gnus)Auto Save")
 242   :group 'gnus-files)
 243
 244 (defgroup gnus-newsrc nil
 245   "Storing Gnus state."
 246   :group 'gnus-files)
 247
 248 (defgroup gnus-server nil
 249   "Options related to newsservers and other servers used by Gnus."
 250   :group 'gnus)
 251
 252 (defgroup gnus-server-visual nil
 253   "Highlighting and menus in the server buffer."
 254   :group 'gnus-visual
 255   :group 'gnus-server)
 256
 257 (defgroup gnus-message '((message custom-group))
 258   "Composing replies and followups in Gnus."
 259   :group 'gnus)
 260
 261 (defgroup gnus-meta nil
 262   "Meta variables controlling major portions of Gnus.
 263 In general, modifying these variables does not take affect until Gnus
 264 is restarted, and sometimes reloaded."
 265   :group 'gnus)
 266
 267 (defgroup gnus-various nil
 268   "Other Gnus options."
 269   :link '(custom-manual "(gnus)Various Various")
 270   :group 'gnus)
 271
 272 (defgroup gnus-mime nil
 273   "Variables for controlling the Gnus MIME interface."
 274   :group 'gnus)
 275
 276 (defgroup gnus-exit nil
 277   "Exiting gnus."
 278   :link '(custom-manual "(gnus)Exiting Gnus")
 279   :group 'gnus)
 280
 281 (defgroup gnus-fun nil
 282   "Frivolous Gnus extensions."
 283   :link '(custom-manual "(gnus)Exiting Gnus")
 284   :group 'gnus)
 285
 286 (defconst gnus-version-number "5.11"
 287   "Version number for this version of Gnus.")
 288
 289 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
 290   "Version string for this version of Gnus.")
 291
 292 (defcustom gnus-inhibit-startup-message nil
 293   "If non-nil, the startup message will not be displayed.
 294 This variable is used before `.gnus.el' is loaded, so it should
 295 be set in `.emacs' instead."
 296   :group 'gnus-start
 297   :type 'boolean)
 298
 299 (defcustom gnus-play-startup-jingle nil
 300   "If non-nil, play the Gnus jingle at startup."
 301   :group 'gnus-start
 302   :type 'boolean)
 303
 304 (unless (fboundp 'gnus-group-remove-excess-properties)
 305   (defalias 'gnus-group-remove-excess-properties 'ignore))
 306
 307 (unless (fboundp 'gnus-set-text-properties)
 308   (defalias 'gnus-set-text-properties 'set-text-properties))
 309
 310 (unless (featurep 'gnus-xmas)
 311   (defalias 'gnus-make-overlay 'make-overlay)
 312   (defalias 'gnus-delete-overlay 'delete-overlay)
 313   (defalias 'gnus-overlay-put 'overlay-put)
 314   (defalias 'gnus-move-overlay 'move-overlay)
 315   (defalias 'gnus-overlay-buffer 'overlay-buffer)
 316   (defalias 'gnus-overlay-start 'overlay-start)
 317   (defalias 'gnus-overlay-end 'overlay-end)
 318   (defalias 'gnus-extent-detached-p 'ignore)
 319   (defalias 'gnus-extent-start-open 'ignore)
 320   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
 321   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
 322   (defalias 'gnus-character-to-event 'identity)
 323   (defalias 'gnus-assq-delete-all 'assq-delete-all)
 324   (defalias 'gnus-add-text-properties 'add-text-properties)
 325   (defalias 'gnus-put-text-property 'put-text-property)
 326   (defvar gnus-mode-line-image-cache t)
 327   (if (fboundp 'find-image)
 328       (defun gnus-mode-line-buffer-identification (line)
 329         (let ((str (car-safe line))
 330               (load-path (mm-image-load-path)))
 331           (if (and (stringp str)
 332                    (string-match "^Gnus:" str))
 333               (progn (add-text-properties
 334                       0 5
 335                       (list 'display
 336                             (if (eq t gnus-mode-line-image-cache)
 337                                 (setq gnus-mode-line-image-cache
 338                                       (find-image
 339                                        '((:type xpm :file "gnus-pointer.xpm"
 340                                                 :ascent center)
 341                                          (:type xbm :file "gnus-pointer.xbm"
 342                                                 :ascent center))))
 343                               gnus-mode-line-image-cache)
 344                             'help-echo (format
 345                                         "This is %s, %s."
 346                                         gnus-version (gnus-emacs-version)))
 347                       str)
 348                      (list str))
 349             line)))
 350     (defalias 'gnus-mode-line-buffer-identification 'identity))
 351   (defalias 'gnus-characterp 'numberp)
 352   (defalias 'gnus-deactivate-mark 'deactivate-mark)
 353   (defalias 'gnus-window-edges 'window-edges)
 354   (defalias 'gnus-key-press-event-p 'numberp)
 355   ;;(defalias 'gnus-decode-rfc1522 'ignore)
 356   )
 357
 358 ;; We define these group faces here to avoid the display
 359 ;; update forced when creating new faces.
 360
 361 (defface gnus-group-news-1-face
 362   '((((class color)
 363       (background dark))
 364      (:foreground "PaleTurquoise" :bold t))
 365     (((class color)
 366       (background light))
 367      (:foreground "ForestGreen" :bold t))
 368     (t
 369      ()))
 370   "Level 1 newsgroup face.")
 371
 372 (defface gnus-group-news-1-empty-face
 373   '((((class color)
 374       (background dark))
 375      (:foreground "PaleTurquoise"))
 376     (((class color)
 377       (background light))
 378      (:foreground "ForestGreen"))
 379     (t
 380      ()))
 381   "Level 1 empty newsgroup face.")
 382
 383 (defface gnus-group-news-2-face
 384   '((((class color)
 385       (background dark))
 386      (:foreground "turquoise" :bold t))
 387     (((class color)
 388       (background light))
 389      (:foreground "CadetBlue4" :bold t))
 390     (t
 391      ()))
 392   "Level 2 newsgroup face.")
 393
 394 (defface gnus-group-news-2-empty-face
 395   '((((class color)
 396       (background dark))
 397      (:foreground "turquoise"))
 398     (((class color)
 399       (background light))
 400      (:foreground "CadetBlue4"))
 401     (t
 402      ()))
 403   "Level 2 empty newsgroup face.")
 404
 405 (defface gnus-group-news-3-face
 406   '((((class color)
 407       (background dark))
 408      (:bold t))
 409     (((class color)
 410       (background light))
 411      (:bold t))
 412     (t
 413      ()))
 414   "Level 3 newsgroup face.")
 415
 416 (defface gnus-group-news-3-empty-face
 417   '((((class color)
 418       (background dark))
 419      ())
 420     (((class color)
 421       (background light))
 422      ())
 423     (t
 424      ()))
 425   "Level 3 empty newsgroup face.")
 426
 427 (defface gnus-group-news-4-face
 428   '((((class color)
 429       (background dark))
 430      (:bold t))
 431     (((class color)
 432       (background light))
 433      (:bold t))
 434     (t
 435      ()))
 436   "Level 4 newsgroup face.")
 437
 438 (defface gnus-group-news-4-empty-face
 439   '((((class color)
 440       (background dark))
 441      ())
 442     (((class color)
 443       (background light))
 444      ())
 445     (t
 446      ()))
 447   "Level 4 empty newsgroup face.")
 448
 449 (defface gnus-group-news-5-face
 450   '((((class color)
 451       (background dark))
 452      (:bold t))
 453     (((class color)
 454       (background light))
 455      (:bold t))
 456     (t
 457      ()))
 458   "Level 5 newsgroup face.")
 459
 460 (defface gnus-group-news-5-empty-face
 461   '((((class color)
 462       (background dark))
 463      ())
 464     (((class color)
 465       (background light))
 466      ())
 467     (t
 468      ()))
 469   "Level 5 empty newsgroup face.")
 470
 471 (defface gnus-group-news-6-face
 472   '((((class color)
 473       (background dark))
 474      (:bold t))
 475     (((class color)
 476       (background light))
 477      (:bold t))
 478     (t
 479      ()))
 480   "Level 6 newsgroup face.")
 481
 482 (defface gnus-group-news-6-empty-face
 483   '((((class color)
 484       (background dark))
 485      ())
 486     (((class color)
 487       (background light))
 488      ())
 489     (t
 490      ()))
 491   "Level 6 empty newsgroup face.")
 492
 493 (defface gnus-group-news-low-face
 494   '((((class color)
 495       (background dark))
 496      (:foreground "DarkTurquoise" :bold t))
 497     (((class color)
 498       (background light))
 499      (:foreground "DarkGreen" :bold t))
 500     (t
 501      ()))
 502   "Low level newsgroup face.")
 503
 504 (defface gnus-group-news-low-empty-face
 505   '((((class color)
 506       (background dark))
 507      (:foreground "DarkTurquoise"))
 508     (((class color)
 509       (background light))
 510      (:foreground "DarkGreen"))
 511     (t
 512      ()))
 513   "Low level empty newsgroup face.")
 514
 515 (defface gnus-group-mail-1-face
 516   '((((class color)
 517       (background dark))
 518      (:foreground "aquamarine1" :bold t))
 519     (((class color)
 520       (background light))
 521      (:foreground "DeepPink3" :bold t))
 522     (t
 523      (:bold t)))
 524   "Level 1 mailgroup face.")
 525
 526 (defface gnus-group-mail-1-empty-face
 527   '((((class color)
 528       (background dark))
 529      (:foreground "aquamarine1"))
 530     (((class color)
 531       (background light))
 532      (:foreground "DeepPink3"))
 533     (t
 534      (:italic t :bold t)))
 535   "Level 1 empty mailgroup face.")
 536
 537 (defface gnus-group-mail-2-face
 538   '((((class color)
 539       (background dark))
 540      (:foreground "aquamarine2" :bold t))
 541     (((class color)
 542       (background light))
 543      (:foreground "HotPink3" :bold t))
 544     (t
 545      (:bold t)))
 546   "Level 2 mailgroup face.")
 547
 548 (defface gnus-group-mail-2-empty-face
 549   '((((class color)
 550       (background dark))
 551      (:foreground "aquamarine2"))
 552     (((class color)
 553       (background light))
 554      (:foreground "HotPink3"))
 555     (t
 556      (:bold t)))
 557   "Level 2 empty mailgroup face.")
 558
 559 (defface gnus-group-mail-3-face
 560   '((((class color)
 561       (background dark))
 562      (:foreground "aquamarine3" :bold t))
 563     (((class color)
 564       (background light))
 565      (:foreground "magenta4" :bold t))
 566     (t
 567      (:bold t)))
 568   "Level 3 mailgroup face.")
 569
 570 (defface gnus-group-mail-3-empty-face
 571   '((((class color)
 572       (background dark))
 573      (:foreground "aquamarine3"))
 574     (((class color)
 575       (background light))
 576      (:foreground "magenta4"))
 577     (t
 578      ()))
 579   "Level 3 empty mailgroup face.")
 580
 581 (defface gnus-group-mail-low-face
 582   '((((class color)
 583       (background dark))
 584      (:foreground "aquamarine4" :bold t))
 585     (((class color)
 586       (background light))
 587      (:foreground "DeepPink4" :bold t))
 588     (t
 589      (:bold t)))
 590   "Low level mailgroup face.")
 591
 592 (defface gnus-group-mail-low-empty-face
 593   '((((class color)
 594       (background dark))
 595      (:foreground "aquamarine4"))
 596     (((class color)
 597       (background light))
 598      (:foreground "DeepPink4"))
 599     (t
 600      (:bold t)))
 601   "Low level empty mailgroup face.")
 602
 603 ;; Summary mode faces.
 604
 605 (defface gnus-summary-selected-face '((t
 606                                        (:underline t)))
 607   "Face used for selected articles.")
 608
 609 (defface gnus-summary-cancelled-face
 610   '((((class color))
 611      (:foreground "yellow" :background "black")))
 612   "Face used for cancelled articles.")
 613
 614 (defface gnus-summary-high-ticked-face
 615   '((((class color)
 616       (background dark))
 617      (:foreground "pink" :bold t))
 618     (((class color)
 619       (background light))
 620      (:foreground "firebrick" :bold t))
 621     (t
 622      (:bold t)))
 623   "Face used for high interest ticked articles.")
 624
 625 (defface gnus-summary-low-ticked-face
 626   '((((class color)
 627       (background dark))
 628      (:foreground "pink" :italic t))
 629     (((class color)
 630       (background light))
 631      (:foreground "firebrick" :italic t))
 632     (t
 633      (:italic t)))
 634   "Face used for low interest ticked articles.")
 635
 636 (defface gnus-summary-normal-ticked-face
 637   '((((class color)
 638       (background dark))
 639      (:foreground "pink"))
 640     (((class color)
 641       (background light))
 642      (:foreground "firebrick"))
 643     (t
 644      ()))
 645   "Face used for normal interest ticked articles.")
 646
 647 (defface gnus-summary-high-ancient-face
 648   '((((class color)
 649       (background dark))
 650      (:foreground "SkyBlue" :bold t))
 651     (((class color)
 652       (background light))
 653      (:foreground "RoyalBlue" :bold t))
 654     (t
 655      (:bold t)))
 656   "Face used for high interest ancient articles.")
 657
 658 (defface gnus-summary-low-ancient-face
 659   '((((class color)
 660       (background dark))
 661      (:foreground "SkyBlue" :italic t))
 662     (((class color)
 663       (background light))
 664      (:foreground "RoyalBlue" :italic t))
 665     (t
 666      (:italic t)))
 667   "Face used for low interest ancient articles.")
 668
 669 (defface gnus-summary-normal-ancient-face
 670   '((((class color)
 671       (background dark))
 672      (:foreground "SkyBlue"))
 673     (((class color)
 674       (background light))
 675      (:foreground "RoyalBlue"))
 676     (t
 677      ()))
 678   "Face used for normal interest ancient articles.")
 679
 680 (defface gnus-summary-high-undownloaded-face
 681    '((((class color)
 682        (background light))
 683       (:bold t :foreground "cyan4"))
 684      (((class color) (background dark))
 685       (:bold t :foreground "LightGray"))
 686      (t (:inverse-video t :bold t)))
 687   "Face used for high interest uncached articles.")
 688
 689 (defface gnus-summary-low-undownloaded-face
 690    '((((class color)
 691        (background light))
 692       (:italic t :foreground "cyan4" :bold nil))
 693      (((class color) (background dark))
 694       (:italic t :foreground "LightGray" :bold nil))
 695      (t (:inverse-video t :italic t)))
 696   "Face used for low interest uncached articles.")
 697
 698 (defface gnus-summary-normal-undownloaded-face
 699    '((((class color)
 700        (background light))
 701       (:foreground "cyan4" :bold nil))
 702      (((class color) (background dark))
 703       (:foreground "LightGray" :bold nil))
 704      (t (:inverse-video t)))
 705   "Face used for normal interest uncached articles.")
 706
 707 (defface gnus-summary-high-unread-face
 708   '((t
 709      (:bold t)))
 710   "Face used for high interest unread articles.")
 711
 712 (defface gnus-summary-low-unread-face
 713   '((t
 714      (:italic t)))
 715   "Face used for low interest unread articles.")
 716
 717 (defface gnus-summary-normal-unread-face
 718   '((t
 719      ()))
 720   "Face used for normal interest unread articles.")
 721
 722 (defface gnus-summary-high-read-face
 723   '((((class color)
 724       (background dark))
 725      (:foreground "PaleGreen"
 726                   :bold t))
 727     (((class color)
 728       (background light))
 729      (:foreground "DarkGreen"
 730                   :bold t))
 731     (t
 732      (:bold t)))
 733   "Face used for high interest read articles.")
 734
 735 (defface gnus-summary-low-read-face
 736   '((((class color)
 737       (background dark))
 738      (:foreground "PaleGreen"
 739                   :italic t))
 740     (((class color)
 741       (background light))
 742      (:foreground "DarkGreen"
 743                   :italic t))
 744     (t
 745      (:italic t)))
 746   "Face used for low interest read articles.")
 747
 748 (defface gnus-summary-normal-read-face
 749   '((((class color)
 750       (background dark))
 751      (:foreground "PaleGreen"))
 752     (((class color)
 753       (background light))
 754      (:foreground "DarkGreen"))
 755     (t
 756      ()))
 757   "Face used for normal interest read articles.")
 758
 759
 760 ;;;
 761 ;;; Gnus buffers
 762 ;;;
 763
 764 (defvar gnus-buffers nil)
 765
 766 (defun gnus-get-buffer-create (name)
 767   "Do the same as `get-buffer-create', but store the created buffer."
 768   (or (get-buffer name)
 769       (car (push (get-buffer-create name) gnus-buffers))))
 770
 771 (defun gnus-add-buffer ()
 772   "Add the current buffer to the list of Gnus buffers."
 773   (push (current-buffer) gnus-buffers))
 774
 775 (defmacro gnus-kill-buffer (buffer)
 776   "Kill BUFFER and remove from the list of Gnus buffers."
 777   `(let ((buf ,buffer))
 778      (when (gnus-buffer-exists-p buf)
 779        (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
 780        (kill-buffer buf))))
 781
 782 (defun gnus-buffers ()
 783   "Return a list of live Gnus buffers."
 784   (while (and gnus-buffers
 785               (not (buffer-name (car gnus-buffers))))
 786     (pop gnus-buffers))
 787   (let ((buffers gnus-buffers))
 788     (while (cdr buffers)
 789       (if (buffer-name (cadr buffers))
 790           (pop buffers)
 791         (setcdr buffers (cddr buffers)))))
 792   gnus-buffers)
 793
 794 ;;; Splash screen.
 795
 796 (defvar gnus-group-buffer "*Group*")
 797
 798 (eval-and-compile
 799   (autoload 'gnus-play-jingle "gnus-audio"))
 800
 801 (defface gnus-splash-face
 802   '((((class color)
 803       (background dark))
 804      (:foreground "#888888"))
 805     (((class color)
 806       (background light))
 807      (:foreground "#888888"))
 808     (t
 809      ()))
 810   "Face for the splash screen.")
 811
 812 (defun gnus-splash ()
 813   (save-excursion
 814     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
 815     (let ((buffer-read-only nil))
 816       (erase-buffer)
 817       (unless gnus-inhibit-startup-message
 818         (gnus-group-startup-message)
 819         (sit-for 0)
 820         (when gnus-play-startup-jingle
 821           (gnus-play-jingle))))))
 822
 823 (defun gnus-indent-rigidly (start end arg)
 824   "Indent rigidly using only spaces and no tabs."
 825   (save-excursion
 826     (save-restriction
 827       (narrow-to-region start end)
 828       (let ((tab-width 8))
 829         (indent-rigidly start end arg)
 830         ;; We translate tabs into spaces -- not everybody uses
 831         ;; an 8-character tab.
 832         (goto-char (point-min))
 833         (while (search-forward "\t" nil t)
 834           (replace-match "        " t t))))))
 835
 836 (defvar gnus-simple-splash nil)
 837
 838 ;;(format "%02x%02x%02x" 114 66 20) "724214"
 839
 840 (defvar gnus-logo-color-alist
 841   '((flame "#cc3300" "#ff2200")
 842     (pine "#c0cc93" "#f8ffb8")
 843     (moss "#a1cc93" "#d2ffb8")
 844     (irish "#04cc90" "#05ff97")
 845     (sky "#049acc" "#05deff")
 846     (tin "#6886cc" "#82b6ff")
 847     (velvet "#7c68cc" "#8c82ff")
 848     (grape "#b264cc" "#cf7df")
 849     (labia "#cc64c2" "#fd7dff")
 850     (berry "#cc6485" "#ff7db5")
 851     (dino "#724214" "#1e3f03")
 852     (oort "#cccccc" "#888888")
 853     (storm "#666699" "#99ccff")
 854     (pdino "#9999cc" "#99ccff")
 855     (purp "#9999cc" "#666699")
 856     (no "#000000" "#ff0000")
 857     (neutral "#b4b4b4" "#878787")
 858     (september "#bf9900" "#ffcc00"))
 859   "Color alist used for the Gnus logo.")
 860
 861 (defcustom gnus-logo-color-style 'oort
 862   "*Color styles used for the Gnus logo."
 863   :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
 864                            gnus-logo-color-alist))
 865   :group 'gnus-xmas)
 866
 867 (defvar gnus-logo-colors
 868   (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
 869   "Colors used for the Gnus logo.")
 870
 871 (defun gnus-group-startup-message (&optional x y)
 872   "Insert startup message in current buffer."
 873   ;; Insert the message.
 874   (erase-buffer)
 875   (cond
 876    ((and
 877      (fboundp 'find-image)
 878      (display-graphic-p)
 879      (let* ((data-directory (nnheader-find-etc-directory "images/gnus"))
 880             (image (find-image
 881                     `((:type xpm :file "gnus.xpm"
 882                              :color-symbols
 883                              (("thing" . ,(car gnus-logo-colors))
 884                               ("shadow" . ,(cadr gnus-logo-colors))
 885                               ("oort" . "#eeeeee")
 886                               ("background" . ,(face-background 'default))))
 887                       (:type pbm :file "gnus.pbm"
 888                              ;; Account for the pbm's blackground.
 889                              :background ,(face-foreground 'gnus-splash-face)
 890                              :foreground ,(face-background 'default))
 891                       (:type xbm :file "gnus.xbm"
 892                              ;; Account for the xbm's blackground.
 893                              :background ,(face-foreground 'gnus-splash-face)
 894                              :foreground ,(face-background 'default))))))
 895        (when image
 896          (let ((size (image-size image)))
 897            (insert-char ?\n (max 0 (round (- (window-height)
 898                                              (or y (cdr size)) 1) 2)))
 899            (insert-char ?\  (max 0 (round (- (window-width)
 900                                              (or x (car size))) 2)))
 901            (insert-image image))
 902          (setq gnus-simple-splash nil)
 903          t))))
 904    (t
 905     (insert
 906      (format "              %s
 907           _    ___ _             _
 908           _ ___ __ ___  __    _ ___
 909           __   _     ___    __  ___
 910               _           ___     _
 911              _  _ __             _
 912              ___   __            _
 913                    __           _
 914                     _      _   _
 915                    _      _    _
 916                       _  _    _
 917                   __  ___
 918                  _   _ _     _
 919                 _   _
 920               _    _
 921              _    _
 922             _
 923           __
 924
 925 "
 926              ""))
 927     ;; And then hack it.
 928     (gnus-indent-rigidly (point-min) (point-max)
 929                          (/ (max (- (window-width) (or x 46)) 0) 2))
 930     (goto-char (point-min))
 931     (forward-line 1)
 932     (let* ((pheight (count-lines (point-min) (point-max)))
 933            (wheight (window-height))
 934            (rest (- wheight pheight)))
 935       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
 936     ;; Fontify some.
 937     (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
 938     (setq gnus-simple-splash t)))
 939   (goto-char (point-min))
 940   (setq mode-line-buffer-identification (concat " " gnus-version))
 941   (set-buffer-modified-p t))
 942
 943 (eval-when (load)
 944   (let ((command (format "%s" this-command)))
 945     (when (string-match "gnus" command)
 946       (if (string-match "gnus-other-frame" command)
 947           (gnus-get-buffer-create gnus-group-buffer)
 948         (gnus-splash)))))
 949
 950 ;;; Do the rest.
 951
 952 (require 'gnus-util)
 953 (require 'nnheader)
 954
 955 (defcustom gnus-parameters nil
 956   "Alist of group parameters.
 957
 958 For example:
 959    ((\"mail\\\\..*\"  (gnus-show-threads nil)
 960                   (gnus-use-scoring nil)
 961                   (gnus-summary-line-format
 962                         \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
 963                   (gcc-self . t)
 964                   (display . all))
 965      (\"mail\\\\.me\" (gnus-use-scoring  t))
 966      (\"list\\\\..*\" (total-expire . t)
 967                   (broken-reply-to . t)))"
 968   :version "22.1"
 969   :group 'gnus-group-various
 970   :type '(repeat (cons regexp
 971                        (repeat sexp))))
 972
 973 (defvar gnus-group-parameters-more nil)
 974
 975 (defmacro gnus-define-group-parameter (param &rest rest)
 976   "Define a group parameter PARAM.
 977 REST is a plist of following:
 978 :type               One of `bool', `list' or nil.
 979 :function           The name of the function.
 980 :function-document  The documentation of the function.
 981 :parameter-type     The type for customizing the parameter.
 982 :parameter-document The documentation for the parameter.
 983 :variable           The name of the variable.
 984 :variable-document  The documentation for the variable.
 985 :variable-group     The group for customizing the variable.
 986 :variable-type      The type for customizing the variable.
 987 :variable-default   The default value of the variable."
 988   (let* ((type (plist-get rest :type))
 989          (parameter-type (plist-get rest :parameter-type))
 990          (parameter-document (plist-get rest :parameter-document))
 991          (function (or (plist-get rest :function)
 992                        (intern (format "gnus-parameter-%s" param))))
 993          (function-document (or (plist-get rest :function-document) ""))
 994          (variable (or (plist-get rest :variable)
 995                        (intern (format "gnus-parameter-%s-alist" param))))
 996          (variable-document (or (plist-get rest :variable-document) ""))
 997          (variable-group (plist-get rest :variable-group))
 998          (variable-type (or (plist-get rest :variable-type)
 999                             `(quote (repeat
1000                                      (list (regexp :tag "Group")
1001                                            ,(car (cdr parameter-type)))))))
1002          (variable-default (plist-get rest :variable-default)))
1003     (list
1004      'progn
1005      `(defcustom ,variable ,variable-default
1006         ,variable-document
1007         :group 'gnus-group-parameter
1008         :group ',variable-group
1009         :type ,variable-type)
1010      `(setq gnus-group-parameters-more
1011             (delq (assq ',param gnus-group-parameters-more)
1012                   gnus-group-parameters-more))
1013      `(add-to-list 'gnus-group-parameters-more
1014                    (list ',param
1015                          ,parameter-type
1016                          ,parameter-document))
1017      (if (eq type 'bool)
1018          `(defun ,function (name)
1019             ,function-document
1020             (let ((params (gnus-group-find-parameter name))
1021                   val)
1022               (cond
1023                ((memq ',param params)
1024                 t)
1025                ((setq val (assq ',param params))
1026                 (cdr val))
1027                ((stringp ,variable)
1028                 (string-match ,variable name))
1029                (,variable
1030                 (let ((alist ,variable)
1031                       elem value)
1032                   (while (setq elem (pop alist))
1033                     (when (and name
1034                                (string-match (car elem) name))
1035                       (setq alist nil
1036                             value (cdr elem))))
1037                   (if (consp value) (car value) value))))))
1038        `(defun ,function (name)
1039           ,function-document
1040           (and name
1041                (or (gnus-group-find-parameter name ',param ,(and type t))
1042                    (let ((alist ,variable)
1043                          elem value)
1044                      (while (setq elem (pop alist))
1045                        (when (and name
1046                                   (string-match (car elem) name))
1047                          (setq alist nil
1048                                value (cdr elem))))
1049                      ,(if type
1050                           'value
1051                         '(if (consp value) (car value) value))))))))))
1052
1053 (defcustom gnus-home-directory "~/"
1054   "Directory variable that specifies the \"home\" directory.
1055 All other Gnus file and directory variables are initialized from this variable."
1056   :group 'gnus-files
1057   :type 'directory)
1058
1059 (defcustom gnus-directory (or (getenv "SAVEDIR")
1060                               (nnheader-concat gnus-home-directory "News/"))
1061   "*Directory variable from which all other Gnus file variables are derived.
1062
1063 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1064 This means that other directory variables that are initialized from
1065 this variable won't be set properly if you set this variable in `.gnus.el'.
1066 Set this variable in `.emacs' instead."
1067   :group 'gnus-files
1068   :type 'directory)
1069
1070 (defcustom gnus-default-directory nil
1071   "*Default directory for all Gnus buffers."
1072   :group 'gnus-files
1073   :type '(choice (const :tag "current" nil)
1074                  directory))
1075
1076 ;; Site dependent variables.  These variables should be defined in
1077 ;; paths.el.
1078
1079 (defvar gnus-default-nntp-server nil
1080   "Specify a default NNTP server.
1081 This variable should be defined in paths.el, and should never be set
1082 by the user.
1083 If you want to change servers, you should use `gnus-select-method'.
1084 See the documentation to that variable.")
1085
1086 ;; Don't touch this variable.
1087 (defvar gnus-nntp-service "nntp"
1088   "NNTP service name (\"nntp\" or 119).
1089 This is an obsolete variable, which is scarcely used.  If you use an
1090 nntp server for your newsgroup and want to change the port number
1091 used to 899, you would say something along these lines:
1092
1093  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1094
1095 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1096   "A file with only the name of the nntp server in it."
1097   :group 'gnus-files
1098   :group 'gnus-server
1099   :type 'file)
1100
1101 (defun gnus-getenv-nntpserver ()
1102   "Find default nntp server.
1103 Check the NNTPSERVER environment variable and the
1104 `gnus-nntpserver-file' file."
1105   (or (getenv "NNTPSERVER")
1106       (and (file-readable-p gnus-nntpserver-file)
1107            (with-temp-buffer
1108              (insert-file-contents gnus-nntpserver-file)
1109              (when (re-search-forward "[^ \t\n\r]+" nil t)
1110                (match-string 0))))))
1111
1112 (defcustom gnus-select-method
1113   (condition-case nil
1114       (nconc
1115        (list 'nntp (or (condition-case nil
1116                            (gnus-getenv-nntpserver)
1117                          (error nil))
1118                        (when (and gnus-default-nntp-server
1119                                   (not (string= gnus-default-nntp-server "")))
1120                          gnus-default-nntp-server)
1121                        "news"))
1122        (if (or (null gnus-nntp-service)
1123                (equal gnus-nntp-service "nntp"))
1124            nil
1125          (list gnus-nntp-service)))
1126     (error nil))
1127   "Default method for selecting a newsgroup.
1128 This variable should be a list, where the first element is how the
1129 news is to be fetched, the second is the address.
1130
1131 For instance, if you want to get your news via \"flab.flab.edu\" using
1132 NNTP, you could say:
1133
1134 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1135
1136 If you want to use your local spool, say:
1137
1138 \(setq gnus-select-method (list 'nnspool (system-name)))
1139
1140 If you use this variable, you must set `gnus-nntp-server' to nil.
1141
1142 There is a lot more to know about select methods and virtual servers -
1143 see the manual for details."
1144   :group 'gnus-server
1145   :type 'gnus-select-method)
1146
1147 (defcustom gnus-message-archive-method "archive"
1148   "*Method used for archiving messages you've sent.
1149 This should be a mail method."
1150   :group 'gnus-server
1151   :group 'gnus-message
1152   :type '(choice (const :tag "Default archive method" "archive")
1153                  gnus-select-method))
1154
1155 (defcustom gnus-message-archive-group nil
1156   "*Name of the group in which to save the messages you've written.
1157 This can either be a string; a list of strings; or an alist
1158 of regexps/functions/forms to be evaluated to return a string (or a list
1159 of strings).  The functions are called with the name of the current
1160 group (or nil) as a parameter.
1161
1162 If you want to save your mail in one group and the news articles you
1163 write in another group, you could say something like:
1164
1165  \(setq gnus-message-archive-group
1166         '((if (message-news-p)
1167               \"misc-news\"
1168             \"misc-mail\")))
1169
1170 Normally the group names returned by this variable should be
1171 unprefixed -- which implicitly means \"store on the archive server\".
1172 However, you may wish to store the message on some other server.  In
1173 that case, just return a fully prefixed name of the group --
1174 \"nnml+private:mail.misc\", for instance."
1175   :group 'gnus-message
1176   :type '(choice (const :tag "none" nil)
1177                  function
1178                  sexp
1179                  string))
1180
1181 (defcustom gnus-secondary-servers nil
1182   "List of NNTP servers that the user can choose between interactively.
1183 To make Gnus query you for a server, you have to give `gnus' a
1184 non-numeric prefix - `C-u M-x gnus', in short."
1185   :group 'gnus-server
1186   :type '(repeat string))
1187
1188 (defcustom gnus-nntp-server nil
1189   "*The name of the host running the NNTP server.
1190 This variable is semi-obsolete.  Use the `gnus-select-method'
1191 variable instead."
1192   :group 'gnus-server
1193   :type '(choice (const :tag "disable" nil)
1194                  string))
1195
1196 (defcustom gnus-secondary-select-methods nil
1197   "A list of secondary methods that will be used for reading news.
1198 This is a list where each element is a complete select method (see
1199 `gnus-select-method').
1200
1201 If, for instance, you want to read your mail with the nnml back end,
1202 you could set this variable:
1203
1204 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1205   :group 'gnus-server
1206   :type '(repeat gnus-select-method))
1207
1208 (defvar gnus-backup-default-subscribed-newsgroups
1209   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1210   "Default default new newsgroups the first time Gnus is run.
1211 Should be set in paths.el, and shouldn't be touched by the user.")
1212
1213 (defcustom gnus-local-domain nil
1214   "Local domain name without a host name.
1215 The DOMAINNAME environment variable is used instead if it is defined.
1216 If the function `system-name' returns the full Internet name, there is
1217 no need to set this variable."
1218   :group 'gnus-message
1219   :type '(choice (const :tag "default" nil)
1220                  string))
1221
1222 (defvar gnus-local-organization nil
1223   "String with a description of what organization (if any) the user belongs to.
1224 Obsolete variable; use `message-user-organization' instead.")
1225
1226 ;; Customization variables
1227
1228 (defcustom gnus-refer-article-method nil
1229   "Preferred method for fetching an article by Message-ID.
1230 If you are reading news from the local spool (with nnspool), fetching
1231 articles by Message-ID is painfully slow.  By setting this method to an
1232 nntp method, you might get acceptable results.
1233
1234 The value of this variable must be a valid select method as discussed
1235 in the documentation of `gnus-select-method'.
1236
1237 It can also be a list of select methods, as well as the special symbol
1238 `current', which means to use the current select method.  If it is a
1239 list, Gnus will try all the methods in the list until it finds a match."
1240   :group 'gnus-server
1241   :type '(choice (const :tag "default" nil)
1242                  (const current)
1243                  (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1244                  gnus-select-method
1245                  (repeat :menu-tag "Try multiple"
1246                          :tag "Multiple"
1247                          :value (current (nnweb "refer" (nnweb-type google)))
1248                          (choice :tag "Method"
1249                                  (const current)
1250                                  (const :tag "Google"
1251                                         (nnweb "refer" (nnweb-type google)))
1252                                  gnus-select-method))))
1253
1254 (defcustom gnus-group-faq-directory
1255   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1256     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1257     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1258     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1259     "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1260     "/ftp@rtfm.mit.edu:/pub/usenet/"
1261     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1262     "/ftp@ftp.sunet.se:/pub/usenet/"
1263     "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1264     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1265     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1266   "*Directory where the group FAQs are stored.
1267 This will most commonly be on a remote machine, and the file will be
1268 fetched by ange-ftp.
1269
1270 This variable can also be a list of directories.  In that case, the
1271 first element in the list will be used by default.  The others can
1272 be used when being prompted for a site.
1273
1274 Note that Gnus uses an aol machine as the default directory.  If this
1275 feels fundamentally unclean, just think of it as a way to finally get
1276 something of value back from them.
1277
1278 If the default site is too slow, try one of these:
1279
1280    North America: mirrors.aol.com                /pub/rtfm/usenet
1281                   ftp.seas.gwu.edu               /pub/rtfm
1282                   rtfm.mit.edu                   /pub/usenet
1283    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1284                   src.doc.ic.ac.uk               /usenet/news-FAQS
1285                   ftp.sunet.se                   /pub/usenet
1286                   ftp.pasteur.fr                 /pub/FAQ
1287    Asia:          nctuccca.nctu.edu.tw           /pub/Documents/rtfm/usenet-by-group/
1288                   hwarang.postech.ac.kr          /pub/usenet
1289                   ftp.hk.super.net               /mirror/faqs"
1290   :group 'gnus-group-various
1291   :type '(choice directory
1292                  (repeat directory)))
1293
1294 (defcustom gnus-group-charter-alist
1295   '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1296     ("de" . (concat "http://purl.net/charta/" name ".html"))
1297     ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1298     ("england" . (concat "http://england.news-admin.org/charters/" name))
1299     ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1300     ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1301                         (gnus-replace-in-string name "europa\\." "") ".html"))
1302     ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1303     ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1304     ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1305     ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1306     ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1307     ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1308     ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1309     ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1310                     (gnus-replace-in-string name "\\." "_") ".html"))
1311     ("milw" . (concat "http://usenet.mil.wi.us/"
1312                       (gnus-replace-in-string name "milw\\." "") "-charter"))
1313     ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1314     ("netins" . (concat "http://www.netins.net/usenet/charter/"
1315                         (gnus-replace-in-string name "\\." "-") "-charter.html")))
1316   "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1317 When FORM is evaluated `name' is bound to the name of the group."
1318   :version "22.1"
1319   :group 'gnus-group-various
1320   :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1321
1322 (defcustom gnus-group-fetch-control-use-browse-url nil
1323   "*Non-nil means that control messages are displayed using `browse-url'.
1324 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1325 group."
1326   :version "22.1"
1327   :group 'gnus-group-various
1328   :type 'boolean)
1329
1330 (defcustom gnus-use-cross-reference t
1331   "*Non-nil means that cross referenced articles will be marked as read.
1332 If nil, ignore cross references.  If t, mark articles as read in
1333 subscribed newsgroups.  If neither t nor nil, mark as read in all
1334 newsgroups."
1335   :group 'gnus-server
1336   :type '(choice (const :tag "off" nil)
1337                  (const :tag "subscribed" t)
1338                  (sexp :format "all"
1339                        :value always)))
1340
1341 (defcustom gnus-process-mark ?#
1342   "*Process mark."
1343   :group 'gnus-group-visual
1344   :group 'gnus-summary-marks
1345   :type 'character)
1346
1347 (defcustom gnus-large-newsgroup 200
1348   "*The number of articles which indicates a large newsgroup.
1349 If the number of articles in a newsgroup is greater than this value,
1350 confirmation is required for selecting the newsgroup.
1351 If it is nil, no confirmation is required."
1352   :group 'gnus-group-select
1353   :type '(choice (const :tag "No limit" nil)
1354                  integer))
1355
1356 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1357   "*Non-nil means that the default name of a file to save articles in is the group name.
1358 If it's nil, the directory form of the group name is used instead.
1359
1360 If this variable is a list, and the list contains the element
1361 `not-score', long file names will not be used for score files; if it
1362 contains the element `not-save', long file names will not be used for
1363 saving; and if it contains the element `not-kill', long file names
1364 will not be used for kill files.
1365
1366 Note that the default for this variable varies according to what system
1367 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1368 to nil while on all other systems it defaults to t."
1369   :group 'gnus-start
1370   :type '(radio (sexp :format "Non-nil\n"
1371                       :match (lambda (widget value)
1372                                (and value (not (listp value))))
1373                       :value t)
1374                 (const nil)
1375                 (checklist (const :format "%v " not-score)
1376                            (const :format "%v " not-save)
1377                            (const not-kill))))
1378
1379 (defcustom gnus-kill-files-directory gnus-directory
1380   "*Name of the directory where kill files will be stored (default \"~/News\")."
1381   :group 'gnus-score-files
1382   :group 'gnus-score-kill
1383   :type 'directory)
1384
1385 (defcustom gnus-save-score nil
1386   "*If non-nil, save group scoring info."
1387   :group 'gnus-score-various
1388   :group 'gnus-start
1389   :type 'boolean)
1390
1391 (defcustom gnus-use-undo t
1392   "*If non-nil, allow undoing in Gnus group mode buffers."
1393   :group 'gnus-meta
1394   :type 'boolean)
1395
1396 (defcustom gnus-use-adaptive-scoring nil
1397   "*If non-nil, use some adaptive scoring scheme.
1398 If a list, then the values `word' and `line' are meaningful.  The
1399 former will perform adaption on individual words in the subject
1400 header while `line' will perform adaption on several headers."
1401   :group 'gnus-meta
1402   :group 'gnus-score-adapt
1403   :type '(set (const word) (const line)))
1404
1405 (defcustom gnus-use-cache 'passive
1406   "*If nil, Gnus will ignore the article cache.
1407 If `passive', it will allow entering (and reading) articles
1408 explicitly entered into the cache.  If anything else, use the
1409 cache to the full extent of the law."
1410   :group 'gnus-meta
1411   :group 'gnus-cache
1412   :type '(choice (const :tag "off" nil)
1413                  (const :tag "passive" passive)
1414                  (const :tag "active" t)))
1415
1416 (defcustom gnus-use-trees nil
1417   "*If non-nil, display a thread tree buffer."
1418   :group 'gnus-meta
1419   :type 'boolean)
1420
1421 (defcustom gnus-use-grouplens nil
1422   "*If non-nil, use GroupLens ratings."
1423   :group 'gnus-meta
1424   :type 'boolean)
1425
1426 (defcustom gnus-keep-backlog 20
1427   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1428 If it is a number N, then Gnus will only keep the last N articles
1429 read.  If it is neither nil nor a number, Gnus will keep all read
1430 articles.  This is not a good idea."
1431   :group 'gnus-meta
1432   :type '(choice (const :tag "off" nil)
1433                  integer
1434                  (sexp :format "all"
1435                        :value t)))
1436
1437 (defcustom gnus-use-nocem nil
1438   "*If non-nil, Gnus will read NoCeM cancel messages."
1439   :group 'gnus-meta
1440   :type 'boolean)
1441
1442 (defcustom gnus-suppress-duplicates nil
1443   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1444   :group 'gnus-meta
1445   :type 'boolean)
1446
1447 (defcustom gnus-use-scoring t
1448   "*If non-nil, enable scoring."
1449   :group 'gnus-meta
1450   :type 'boolean)
1451
1452 (defcustom gnus-summary-prepare-exit-hook
1453   '(gnus-summary-expire-articles)
1454   "*A hook called when preparing to exit from the summary buffer.
1455 It calls `gnus-summary-expire-articles' by default."
1456   :group 'gnus-summary-exit
1457   :type 'hook)
1458
1459 (defcustom gnus-novice-user t
1460   "*Non-nil means that you are a Usenet novice.
1461 If non-nil, verbose messages may be displayed and confirmations may be
1462 required."
1463   :group 'gnus-meta
1464   :type 'boolean)
1465
1466 (defcustom gnus-expert-user nil
1467   "*Non-nil means that you will never be asked for confirmation about anything.
1468 That doesn't mean *anything* anything; particularly destructive
1469 commands will still require prompting."
1470   :group 'gnus-meta
1471   :type 'boolean)
1472
1473 (defcustom gnus-interactive-catchup t
1474   "*If non-nil, require your confirmation when catching up a group."
1475   :group 'gnus-group-select
1476   :type 'boolean)
1477
1478 (defcustom gnus-interactive-exit t
1479   "*If non-nil, require your confirmation when exiting Gnus."
1480   :group 'gnus-exit
1481   :type 'boolean)
1482
1483 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1484   "*Function for extracting address components from a From header.
1485 Two pre-defined function exist: `gnus-extract-address-components',
1486 which is the default, quite fast, and too simplistic solution, and
1487 `mail-extract-address-components', which works much better, but is
1488 slower."
1489   :group 'gnus-summary-format
1490   :type '(radio (function-item gnus-extract-address-components)
1491                 (function-item mail-extract-address-components)
1492                 (function :tag "Other")))
1493
1494 (defcustom gnus-carpal nil
1495   "*If non-nil, display clickable icons."
1496   :group 'gnus-meta
1497   :type 'boolean)
1498
1499 (defcustom gnus-shell-command-separator ";"
1500   "String used to separate shell commands."
1501   :group 'gnus-files
1502   :type 'string)
1503
1504 (defcustom gnus-valid-select-methods
1505   '(("nntp" post address prompt-address physical-address)
1506     ("nnspool" post address)
1507     ("nnvirtual" post-mail virtual prompt-address)
1508     ("nnmbox" mail respool address)
1509     ("nnml" post-mail respool address)
1510     ("nnmh" mail respool address)
1511     ("nndir" post-mail prompt-address physical-address)
1512     ("nneething" none address prompt-address physical-address)
1513     ("nndoc" none address prompt-address)
1514     ("nnbabyl" mail address respool)
1515     ("nnkiboze" post virtual)
1516     ("nnsoup" post-mail address)
1517     ("nndraft" post-mail)
1518     ("nnfolder" mail respool address)
1519     ("nngateway" post-mail address prompt-address physical-address)
1520     ("nnweb" none)
1521     ("nngoogle" post)
1522     ("nnslashdot" post)
1523     ("nnultimate" none)
1524     ("nnrss" none)
1525     ("nnwfm" none)
1526     ("nnwarchive" none)
1527     ("nnlistserv" none)
1528     ("nnagent" post-mail)
1529     ("nnimap" post-mail address prompt-address physical-address)
1530     ("nnmaildir" mail respool address)
1531     ("nnnil" none))
1532   "*An alist of valid select methods.
1533 The first element of each list lists should be a string with the name
1534 of the select method.  The other elements may be the category of
1535 this method (i. e., `post', `mail', `none' or whatever) or other
1536 properties that this method has (like being respoolable).
1537 If you implement a new select method, all you should have to change is
1538 this variable.  I think."
1539   :group 'gnus-server
1540   :type '(repeat (group (string :tag "Name")
1541                         (radio-button-choice (const :format "%v " post)
1542                                              (const :format "%v " mail)
1543                                              (const :format "%v " none)
1544                                              (const post-mail))
1545                         (checklist :inline t
1546                                    (const :format "%v " address)
1547                                    (const :format "%v " prompt-address)
1548                                    (const :format "%v " physical-address)
1549                                    (const :format "%v " virtual)
1550                                    (const respool)))))
1551
1552 (defun gnus-redefine-select-method-widget ()
1553   "Recomputes the select-method widget based on the value of
1554 `gnus-valid-select-methods'."
1555   (define-widget 'gnus-select-method 'list
1556     "Widget for entering a select method."
1557     :value '(nntp "")
1558     :tag "Select Method"
1559     :args `((choice :tag "Method"
1560                     ,@(mapcar (lambda (entry)
1561                                 (list 'const :format "%v\n"
1562                                       (intern (car entry))))
1563                               gnus-valid-select-methods)
1564                     (symbol :tag "other"))
1565             (string :tag "Address")
1566             (repeat :tag "Options"
1567                     :inline t
1568                     (list :format "%v"
1569                           variable
1570                           (sexp :tag "Value"))))))
1571
1572 (gnus-redefine-select-method-widget)
1573
1574 (defcustom gnus-updated-mode-lines '(group article summary tree)
1575   "List of buffers that should update their mode lines.
1576 The list may contain the symbols `group', `article', `tree' and
1577 `summary'.  If the corresponding symbol is present, Gnus will keep
1578 that mode line updated with information that may be pertinent.
1579 If this variable is nil, screen refresh may be quicker."
1580   :group 'gnus-various
1581   :type '(set (const group)
1582               (const article)
1583               (const summary)
1584               (const tree)))
1585
1586 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1587 (defcustom gnus-mode-non-string-length nil
1588   "*Max length of mode-line non-string contents.
1589 If this is nil, Gnus will take space as is needed, leaving the rest
1590 of the mode line intact.  Note that the default of nil is unlikely
1591 to be desirable; see the manual for further details."
1592   :group 'gnus-various
1593   :type '(choice (const nil)
1594                  integer))
1595
1596 ;; There should be special validation for this.
1597 (define-widget 'gnus-email-address 'string
1598   "An email address.")
1599
1600 (gnus-define-group-parameter
1601  to-address
1602  :function-document
1603  "Return GROUP's to-address."
1604  :variable-document
1605  "*Alist of group regexps and correspondent to-addresses."
1606  :variable-group gnus-group-parameter
1607  :parameter-type '(gnus-email-address :tag "To Address")
1608  :parameter-document "\
1609 This will be used when doing followups and posts.
1610
1611 This is primarily useful in mail groups that represent closed
1612 mailing lists--mailing lists where it's expected that everybody that
1613 writes to the mailing list is subscribed to it.  Since using this
1614 parameter ensures that the mail only goes to the mailing list itself,
1615 it means that members won't receive two copies of your followups.
1616
1617 Using `to-address' will actually work whether the group is foreign or
1618 not.  Let's say there's a group on the server that is called
1619 `fa.4ad-l'.  This is a real newsgroup, but the server has gotten the
1620 articles from a mail-to-news gateway.  Posting directly to this group
1621 is therefore impossible--you have to send mail to the mailing list
1622 address instead.
1623
1624 The gnus-group-split mail splitting mechanism will behave as if this
1625 address was listed in gnus-group-split Addresses (see below).")
1626
1627 (gnus-define-group-parameter
1628  to-list
1629  :function-document
1630  "Return GROUP's to-list."
1631  :variable-document
1632  "*Alist of group regexps and correspondent to-lists."
1633  :variable-group gnus-group-parameter
1634  :parameter-type '(gnus-email-address :tag "To List")
1635  :parameter-document "\
1636 This address will be used when doing a `a' in the group.
1637
1638 It is totally ignored when doing a followup--except that if it is
1639 present in a news group, you'll get mail group semantics when doing
1640 `f'.
1641
1642 The gnus-group-split mail splitting mechanism will behave as if this
1643 address was listed in gnus-group-split Addresses (see below).")
1644
1645 (gnus-define-group-parameter
1646  subscribed
1647  :type bool
1648  :function-document
1649  "Return GROUP's subscription status."
1650  :variable-document
1651  "*Groups which are automatically considered subscribed."
1652  :variable-group gnus-group-parameter
1653  :parameter-type '(const :tag "Subscribed" t)
1654  :parameter-document "\
1655 Gnus assumed that you are subscribed to the To/List address.
1656
1657 When constructing a list of subscribed groups using
1658 `gnus-find-subscribed-addresses', Gnus includes the To address given
1659 above, or the list address (if the To address has not been set).")
1660
1661 (gnus-define-group-parameter
1662  auto-expire
1663  :type bool
1664  :function gnus-group-auto-expirable-p
1665  :function-document
1666  "Check whether GROUP is auto-expirable or not."
1667  :variable gnus-auto-expirable-newsgroups
1668  :variable-default nil
1669  :variable-document
1670  "*Groups in which to automatically mark read articles as expirable.
1671 If non-nil, this should be a regexp that should match all groups in
1672 which to perform auto-expiry.  This only makes sense for mail groups."
1673  :variable-group nnmail-expire
1674  :variable-type '(choice (const nil)
1675                          regexp)
1676  :parameter-type '(const :tag "Automatic Expire" t)
1677  :parameter-document
1678  "All articles that are read will be marked as expirable.")
1679
1680 (gnus-define-group-parameter
1681  total-expire
1682  :type bool
1683  :function gnus-group-total-expirable-p
1684  :function-document
1685  "Check whether GROUP is total-expirable or not."
1686  :variable gnus-total-expirable-newsgroups
1687  :variable-default nil
1688  :variable-document
1689  "*Groups in which to perform expiry of all read articles.
1690 Use with extreme caution.  All groups that match this regexp will be
1691 expiring - which means that all read articles will be deleted after
1692 \(say) one week.         (This only goes for mail groups and the like, of
1693 course.)"
1694  :variable-group nnmail-expire
1695  :variable-type '(choice (const nil)
1696                          regexp)
1697  :parameter-type '(const :tag "Total Expire" t)
1698  :parameter-document
1699  "All read articles will be put through the expiry process
1700
1701 This happens even if they are not marked as expirable.
1702 Use with caution.")
1703
1704 (gnus-define-group-parameter
1705  charset
1706  :function-document
1707  "Return the default charset of GROUP."
1708  :variable gnus-group-charset-alist
1709  :variable-default
1710  '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1711    ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1712    ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1713    ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1714    ("\\(^\\|:\\)relcom\\>" koi8-r)
1715    ("\\(^\\|:\\)fido7\\>" koi8-r)
1716    ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1717    ("\\(^\\|:\\)israel\\>" iso-8859-1)
1718    ("\\(^\\|:\\)han\\>" euc-kr)
1719    ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1720    ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1721    ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1722  :variable-document
1723  "Alist of regexps (to match group names) and default charsets to be used when reading."
1724  :variable-group gnus-charset
1725  :variable-type '(repeat (list (regexp :tag "Group")
1726                                (symbol :tag "Charset")))
1727  :parameter-type '(symbol :tag "Charset")
1728  :parameter-document "\
1729 The default charset to use in the group.")
1730
1731 (gnus-define-group-parameter
1732  post-method
1733  :type list
1734  :function-document
1735  "Return a posting method for GROUP."
1736  :variable gnus-post-method-alist
1737  :variable-document
1738  "Alist of regexps (to match group names) and method to be used when
1739 posting an article."
1740  :variable-group gnus-group-foreign
1741  :parameter-type
1742  '(choice :tag "Posting Method"
1743           (const :tag "Use native server" native)
1744           (const :tag "Use current server" current)
1745           (list :convert-widget
1746                 (lambda (widget)
1747                   (list 'sexp :tag "Methods"
1748                         :value gnus-select-method))))
1749  :parameter-document
1750  "Posting method for this group.")
1751
1752 (gnus-define-group-parameter
1753  large-newsgroup-initial
1754  :type integer
1755  :function-document
1756  "Return GROUP's initial input of the number of articles."
1757  :variable-document
1758  "*Alist of group regexps and its initial input of the number of articles."
1759  :variable-group gnus-group-parameter
1760  :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1761                           (const :tag "All" nil)
1762                           (integer))
1763  :parameter-document "\
1764
1765 This number will be prompted as the initial value of the number of
1766 articles to list when the group is a large newsgroup (see
1767 `gnus-large-newsgroup').  If it is nil, the default value is the
1768 total number of articles in the group.")
1769
1770 ;; The Gnus registry's ignored groups
1771 (gnus-define-group-parameter
1772  registry-ignore
1773  :type list
1774  :function-document
1775  "Whether this group should be ignored by the registry."
1776  :variable gnus-registry-ignored-groups
1777  :variable-default nil
1778  :variable-document
1779  "*Groups in which the registry should be turned off."
1780  :variable-group gnus-registry
1781  :variable-type '(repeat
1782                   (list
1783                    (regexp :tag "Group Name Regular Expression")
1784                    (boolean :tag "Ignored")))
1785
1786  :parameter-type '(boolean :tag "Group Ignored by the Registry")
1787  :parameter-document
1788  "Whether the Gnus Registry should ignore this group.")
1789
1790 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1791 (defcustom gnus-install-group-spam-parameters t
1792   "*Disable the group parameters for spam detection.
1793 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1794   :version "22.1"
1795   :type 'boolean
1796   :group 'gnus-start)
1797
1798 (when gnus-install-group-spam-parameters
1799   (defvar gnus-group-spam-classification-spam t
1800     "Spam group classification (requires spam.el).
1801 This group contains spam messages.  On summary entry, unread messages
1802 will be marked as spam.  On summary exit, the specified spam
1803 processors will be invoked on spam-marked messages, then those
1804 messages will be expired, so the spam processor will only see a
1805 spam-marked message once.")
1806
1807   (defvar gnus-group-spam-classification-ham 'ask
1808     "The ham value for the spam group parameter (requires spam.el).
1809 On summary exit, the specified ham processors will be invoked on
1810 ham-marked messages.  Exercise caution, since the ham processor will
1811 see the same message more than once because there is no ham message
1812 registry.")
1813
1814   (gnus-define-group-parameter
1815    spam-contents
1816    :type list
1817    :function-document
1818    "The spam type (spam, ham, or neither) of the group."
1819    :variable gnus-spam-newsgroup-contents
1820    :variable-default nil
1821    :variable-document
1822    "*Group classification (spam, ham, or neither).  Only
1823 meaningful when spam.el is loaded.  If non-nil, this should be a
1824 list of group name regexps associated with a classification for
1825 each one.  In spam groups, new articles are marked as spam on
1826 summary entry.  There is other behavior associated with ham and
1827 no classification when spam.el is loaded - see the manual."
1828    :variable-group spam
1829    :variable-type '(repeat
1830                     (list :tag "Group contents spam/ham classification"
1831                           (regexp :tag "Group")
1832                           (choice
1833                            (variable-item gnus-group-spam-classification-spam)
1834                            (variable-item gnus-group-spam-classification-ham)
1835                            (const :tag "Unclassified" nil))))
1836
1837    :parameter-type '(list :tag "Group contents spam/ham classification"
1838                           (choice :tag "Group contents classification for spam sorting"
1839                                   (variable-item gnus-group-spam-classification-spam)
1840                                   (variable-item gnus-group-spam-classification-ham)
1841                                   (const :tag "Unclassified" nil)))
1842    :parameter-document
1843    "The spam classification (spam, ham, or neither) of this group.
1844 When a spam group is entered, all unread articles are marked as
1845 spam.  There is other behavior associated with ham and no
1846 classification when spam.el is loaded - see the manual.")
1847
1848   (defvar gnus-group-spam-exit-processor-ifile "ifile"
1849     "OBSOLETE: The ifile summary exit spam processor.")
1850
1851   (defvar gnus-group-spam-exit-processor-stat "stat"
1852     "OBSOLETE: The spam-stat summary exit spam processor.")
1853
1854   (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1855     "OBSOLETE: The Bogofilter summary exit spam processor.")
1856
1857   (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1858     "OBSOLETE: The Blacklist summary exit spam processor.")
1859
1860   (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1861     "OBSOLETE: The Gmane reporting summary exit spam processor.
1862 Only applicable to NNTP groups with articles from Gmane.  See spam-report.el")
1863
1864   (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1865     "OBSOLETE: The spamoracle summary exit spam processor.")
1866
1867   (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1868     "OBSOLETE: The ifile summary exit ham processor.
1869 Only applicable to non-spam (unclassified and ham) groups.")
1870
1871   (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1872     "OBSOLETE: The Bogofilter summary exit ham processor.
1873 Only applicable to non-spam (unclassified and ham) groups.")
1874
1875   (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1876     "OBSOLETE: The spam-stat summary exit ham processor.
1877 Only applicable to non-spam (unclassified and ham) groups.")
1878
1879   (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1880     "OBSOLETE: The whitelist summary exit ham processor.
1881 Only applicable to non-spam (unclassified and ham) groups.")
1882
1883   (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1884     "OBSOLETE: The BBDB summary exit ham processor.
1885 Only applicable to non-spam (unclassified and ham) groups.")
1886
1887   (defvar gnus-group-ham-exit-processor-copy "copy"
1888     "OBSOLETE: The ham copy exit ham processor.
1889 Only applicable to non-spam (unclassified and ham) groups.")
1890
1891   (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1892     "OBSOLETE: The spamoracle summary exit ham processor.
1893 Only applicable to non-spam (unclassified and ham) groups.")
1894
1895   (gnus-define-group-parameter
1896    spam-process
1897    :type list
1898    :parameter-type
1899    '(choice
1900      :tag "Spam Summary Exit Processor"
1901      :value nil
1902      (list :tag "Spam Summary Exit Processor Choices"
1903            (set
1904             (variable-item gnus-group-spam-exit-processor-ifile)
1905             (variable-item gnus-group-spam-exit-processor-stat)
1906             (variable-item gnus-group-spam-exit-processor-bogofilter)
1907             (variable-item gnus-group-spam-exit-processor-blacklist)
1908             (variable-item gnus-group-spam-exit-processor-spamoracle)
1909             (variable-item gnus-group-spam-exit-processor-report-gmane)
1910             (variable-item gnus-group-ham-exit-processor-bogofilter)
1911             (variable-item gnus-group-ham-exit-processor-ifile)
1912             (variable-item gnus-group-ham-exit-processor-stat)
1913             (variable-item gnus-group-ham-exit-processor-whitelist)
1914             (variable-item gnus-group-ham-exit-processor-BBDB)
1915             (variable-item gnus-group-ham-exit-processor-spamoracle)
1916             (variable-item gnus-group-ham-exit-processor-copy)
1917             (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
1918             (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
1919             (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
1920             (const :tag "Spam: ifile"         (spam spam-use-ifile))
1921             (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
1922             (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
1923             (const :tag "Ham: ifile"          (ham spam-use-ifile))
1924             (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
1925             (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
1926             (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
1927             (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
1928             (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
1929             (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle)))))
1930    :function-document
1931    "Which spam or ham processors will be applied when the summary is exited."
1932    :variable gnus-spam-process-newsgroups
1933    :variable-default nil
1934    :variable-document
1935    "*Groups in which to automatically process spam or ham articles with
1936 a backend on summary exit.  If non-nil, this should be a list of group
1937 name regexps that should match all groups in which to do automatic
1938 spam processing, associated with the appropriate processor."
1939    :variable-group spam
1940    :variable-type
1941    '(repeat :tag "Spam/Ham Processors"
1942             (list :tag "Spam Summary Exit Processor Choices"
1943                   (regexp :tag "Group Regexp")
1944                   (set
1945                    :tag "Spam/Ham Summary Exit Processor"
1946                    (variable-item gnus-group-spam-exit-processor-ifile)
1947                    (variable-item gnus-group-spam-exit-processor-stat)
1948                    (variable-item gnus-group-spam-exit-processor-bogofilter)
1949                    (variable-item gnus-group-spam-exit-processor-blacklist)
1950                    (variable-item gnus-group-spam-exit-processor-spamoracle)
1951                    (variable-item gnus-group-spam-exit-processor-report-gmane)
1952                    (variable-item gnus-group-ham-exit-processor-bogofilter)
1953                    (variable-item gnus-group-ham-exit-processor-ifile)
1954                    (variable-item gnus-group-ham-exit-processor-stat)
1955                    (variable-item gnus-group-ham-exit-processor-whitelist)
1956                    (variable-item gnus-group-ham-exit-processor-BBDB)
1957                    (variable-item gnus-group-ham-exit-processor-spamoracle)
1958                    (variable-item gnus-group-ham-exit-processor-copy)
1959                    (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
1960                    (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
1961                    (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
1962                    (const :tag "Spam: ifile"         (spam spam-use-ifile))
1963                    (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
1964                    (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
1965                    (const :tag "Ham: ifile"          (ham spam-use-ifile))
1966                    (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
1967                    (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
1968                    (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
1969                    (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
1970                    (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
1971                    (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle)))))
1972
1973    :parameter-document
1974    "Which spam or ham processors will be applied when the summary is exited.")
1975
1976   (gnus-define-group-parameter
1977    spam-autodetect
1978    :type list
1979    :parameter-type
1980    '(boolean :tag "Spam autodetection")
1981    :function-document
1982    "Should spam be autodetected (with spam-split) in this group?"
1983    :variable gnus-spam-autodetect
1984    :variable-default nil
1985    :variable-document
1986    "*Groups in which spam should be autodetected when they are entered.
1987    Only unseen articles will be examined, unless
1988    spam-autodetect-recheck-messages is set."
1989    :variable-group spam
1990    :variable-type
1991    '(repeat
1992      :tag "Autodetection setting"
1993      (list
1994       (regexp :tag "Group Regexp")
1995       boolean))
1996    :parameter-document
1997    "Spam autodetection.
1998 Only unseen articles will be examined, unless
1999 spam-autodetect-recheck-messages is set.")
2000
2001   (gnus-define-group-parameter
2002    spam-autodetect-methods
2003    :type list
2004    :parameter-type
2005    '(choice :tag "Spam autodetection-specific methods"
2006      (const none)
2007      (const default)
2008      (set :tag "Use specific methods"
2009           (variable-item spam-use-blacklist)
2010           (variable-item spam-use-regex-headers)
2011           (variable-item spam-use-regex-body)
2012           (variable-item spam-use-whitelist)
2013           (variable-item spam-use-BBDB)
2014           (variable-item spam-use-ifile)
2015           (variable-item spam-use-spamoracle)
2016           (variable-item spam-use-stat)
2017           (variable-item spam-use-blackholes)
2018           (variable-item spam-use-hashcash)
2019           (variable-item spam-use-bogofilter-headers)
2020           (variable-item spam-use-bogofilter)))
2021    :function-document
2022    "Methods to be used for autodetection in each group"
2023    :variable gnus-spam-autodetect-methods
2024    :variable-default nil
2025    :variable-document
2026    "*Methods for autodetecting spam per group.
2027 Requires the spam-autodetect parameter.  Only unseen articles
2028 will be examined, unless spam-autodetect-recheck-messages is
2029 set."
2030    :variable-group spam
2031    :variable-type
2032    '(repeat
2033      :tag "Autodetection methods"
2034      (list
2035       (regexp :tag "Group Regexp")
2036       (choice
2037        (const none)
2038        (const default)
2039        (set :tag "Use specific methods"
2040         (variable-item spam-use-blacklist)
2041         (variable-item spam-use-regex-headers)
2042         (variable-item spam-use-regex-body)
2043         (variable-item spam-use-whitelist)
2044         (variable-item spam-use-BBDB)
2045         (variable-item spam-use-ifile)
2046         (variable-item spam-use-spamoracle)
2047         (variable-item spam-use-stat)
2048         (variable-item spam-use-blackholes)
2049         (variable-item spam-use-hashcash)
2050         (variable-item spam-use-bogofilter-headers)
2051         (variable-item spam-use-bogofilter)))))
2052      :parameter-document
2053    "Spam autodetection methods.
2054 Requires the spam-autodetect parameter.  Only unseen articles
2055 will be examined, unless spam-autodetect-recheck-messages is
2056 set.")
2057
2058   (gnus-define-group-parameter
2059    spam-process-destination
2060    :type list
2061    :parameter-type
2062    '(choice :tag "Destination for spam-processed articles at summary exit"
2063             (string :tag "Move to a group")
2064             (repeat :tag "Move to multiple groups"
2065                     (string :tag "Destination group"))
2066             (const :tag "Expire" nil))
2067    :function-document
2068    "Where spam-processed articles will go at summary exit."
2069    :variable gnus-spam-process-destinations
2070    :variable-default nil
2071    :variable-document
2072    "*Groups in which to explicitly send spam-processed articles to
2073 another group, or expire them (the default).  If non-nil, this should
2074 be a list of group name regexps that should match all groups in which
2075 to do spam-processed article moving, associated with the destination
2076 group or nil for explicit expiration.  This only makes sense for
2077 mail groups."
2078    :variable-group spam
2079    :variable-type
2080    '(repeat
2081      :tag "Spam-processed articles destination"
2082      (list
2083       (regexp :tag "Group Regexp")
2084       (choice
2085        :tag "Destination for spam-processed articles at summary exit"
2086        (string :tag "Move to a group")
2087        (repeat :tag "Move to multiple groups"
2088                (string :tag "Destination group"))
2089        (const :tag "Expire" nil))))
2090    :parameter-document
2091    "Where spam-processed articles will go at summary exit.")
2092
2093   (gnus-define-group-parameter
2094    ham-process-destination
2095    :type list
2096    :parameter-type
2097    '(choice
2098      :tag "Destination for ham articles at summary exit from a spam group"
2099      (string :tag "Move to a group")
2100      (repeat :tag "Move to multiple groups"
2101              (string :tag "Destination group"))
2102      (const :tag "Respool" respool)
2103      (const :tag "Do nothing" nil))
2104    :function-document
2105    "Where ham articles will go at summary exit from a spam group."
2106    :variable gnus-ham-process-destinations
2107    :variable-default nil
2108    :variable-document
2109    "*Groups in which to explicitly send ham articles to
2110 another group, or do nothing (the default).  If non-nil, this should
2111 be a list of group name regexps that should match all groups in which
2112 to do ham article moving, associated with the destination
2113 group or nil for explicit ignoring.  This only makes sense for
2114 mail groups, and only works in spam groups."
2115    :variable-group spam
2116    :variable-type
2117    '(repeat
2118      :tag "Ham articles destination"
2119      (list
2120       (regexp :tag "Group Regexp")
2121       (choice
2122        :tag "Destination for ham articles at summary exit from spam group"
2123        (string :tag "Move to a group")
2124        (repeat :tag "Move to multiple groups"
2125                 (string :tag "Destination group"))
2126        (const :tag "Respool" respool)
2127        (const :tag "Expire" nil))))
2128    :parameter-document
2129    "Where ham articles will go at summary exit from a spam group.")
2130
2131   (gnus-define-group-parameter
2132    ham-marks
2133    :type 'list
2134    :parameter-type '(list :tag "Ham mark choices"
2135                           (set
2136                            (variable-item gnus-del-mark)
2137                            (variable-item gnus-read-mark)
2138                            (variable-item gnus-ticked-mark)
2139                            (variable-item gnus-killed-mark)
2140                            (variable-item gnus-kill-file-mark)
2141                            (variable-item gnus-low-score-mark)))
2142
2143    :parameter-document
2144    "Marks considered ham (positively not spam).  Such articles will be
2145 processed as ham (non-spam) on group exit.  When nil, the global
2146 spam-ham-marks variable takes precedence."
2147    :variable-default '((".*" ((gnus-del-mark
2148                                gnus-read-mark
2149                                gnus-killed-mark
2150                                gnus-kill-file-mark
2151                                gnus-low-score-mark))))
2152    :variable-group spam
2153    :variable-document
2154    "*Groups in which to explicitly set the ham marks to some value.")
2155
2156   (gnus-define-group-parameter
2157    spam-marks
2158    :type 'list
2159    :parameter-type '(list :tag "Spam mark choices"
2160                           (set
2161                            (variable-item gnus-spam-mark)
2162                            (variable-item gnus-killed-mark)
2163                            (variable-item gnus-kill-file-mark)
2164                            (variable-item gnus-low-score-mark)))
2165
2166    :parameter-document
2167    "Marks considered spam.
2168 Such articles will be processed as spam on group exit.  When nil, the global
2169 spam-spam-marks variable takes precedence."
2170    :variable-default '((".*" ((gnus-spam-mark))))
2171    :variable-group spam
2172    :variable-document
2173    "*Groups in which to explicitly set the spam marks to some value."))
2174
2175 (defcustom gnus-group-uncollapsed-levels 1
2176   "Number of group name elements to leave alone when making a short group name."
2177   :group 'gnus-group-visual
2178   :type 'integer)
2179
2180 (defcustom gnus-group-use-permanent-levels nil
2181   "*If non-nil, once you set a level, Gnus will use this level."
2182   :group 'gnus-group-levels
2183   :type 'boolean)
2184
2185 ;; Hooks.
2186
2187 (defcustom gnus-load-hook nil
2188   "A hook run while Gnus is loaded."
2189   :group 'gnus-start
2190   :type 'hook)
2191
2192 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2193   "A hook called to apply kill files to a group.
2194 This hook is intended to apply a kill file to the selected newsgroup.
2195 The function `gnus-apply-kill-file' is called by default.
2196
2197 Since a general kill file is too heavy to use only for a few
2198 newsgroups, I recommend you to use a lighter hook function.  For
2199 example, if you'd like to apply a kill file to articles which contains
2200 a string `rmgroup' in subject in newsgroup `control', you can use the
2201 following hook:
2202
2203  (setq gnus-apply-kill-hook
2204       (list
2205         (lambda ()
2206           (cond ((string-match \"control\" gnus-newsgroup-name)
2207                  (gnus-kill \"Subject\" \"rmgroup\")
2208                  (gnus-expunge \"X\"))))))"
2209   :group 'gnus-score-kill
2210   :options '(gnus-apply-kill-file)
2211   :type 'hook)
2212
2213 (defcustom gnus-group-change-level-function nil
2214   "Function run when a group level is changed.
2215 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2216   :group 'gnus-group-levels
2217   :type 'function)
2218
2219 ;;; Face thingies.
2220
2221 (defcustom gnus-visual
2222   '(summary-highlight group-highlight article-highlight
2223                       mouse-face
2224                       summary-menu group-menu article-menu
2225                       tree-highlight menu highlight
2226                       browse-menu server-menu
2227                       page-marker tree-menu binary-menu pick-menu
2228                       grouplens-menu)
2229   "*Enable visual features.
2230 If `visual' is disabled, there will be no menus and few faces.  Most of
2231 the visual customization options below will be ignored.  Gnus will use
2232 less space and be faster as a result.
2233
2234 This variable can also be a list of visual elements to switch on.  For
2235 instance, to switch off all visual things except menus, you can say:
2236
2237    (setq gnus-visual '(menu))
2238
2239 Valid elements include `summary-highlight', `group-highlight',
2240 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2241 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2242 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
2243 and `grouplens-menu'."
2244   :group 'gnus-meta
2245   :group 'gnus-visual
2246   :type '(set (const summary-highlight)
2247               (const group-highlight)
2248               (const article-highlight)
2249               (const mouse-face)
2250               (const summary-menu)
2251               (const group-menu)
2252               (const article-menu)
2253               (const tree-highlight)
2254               (const menu)
2255               (const highlight)
2256               (const browse-menu)
2257               (const server-menu)
2258               (const page-marker)
2259               (const tree-menu)
2260               (const binary-menu)
2261               (const pick-menu)
2262               (const grouplens-menu)))
2263
2264 ;; Byte-compiler warning.
2265 (defvar gnus-visual)
2266 ;; Find out whether the gnus-visual TYPE is wanted.
2267 (defun gnus-visual-p (&optional type class)
2268   (and gnus-visual                      ; Has to be non-nil, at least.
2269        (if (not type)                   ; We don't care about type.
2270            gnus-visual
2271          (if (listp gnus-visual)        ; It's a list, so we check it.
2272              (or (memq type gnus-visual)
2273                  (memq class gnus-visual))
2274            t))))
2275
2276 (defcustom gnus-mouse-face
2277   (condition-case ()
2278       (if (gnus-visual-p 'mouse-face 'highlight)
2279           (if (boundp 'gnus-mouse-face)
2280               (or gnus-mouse-face 'highlight)
2281             'highlight)
2282         'default)
2283     (error 'highlight))
2284   "*Face used for group or summary buffer mouse highlighting.
2285 The line beneath the mouse pointer will be highlighted with this
2286 face."
2287   :group 'gnus-visual
2288   :type 'face)
2289
2290 (defcustom gnus-article-save-directory gnus-directory
2291   "*Name of the directory articles will be saved in (default \"~/News\")."
2292   :group 'gnus-article-saving
2293   :type 'directory)
2294
2295 (defvar gnus-plugged t
2296   "Whether Gnus is plugged or not.")
2297
2298 (defcustom gnus-agent-cache t
2299   "Controls use of the agent cache while plugged.
2300 When set, Gnus will prefer using the locally stored content rather
2301 than re-fetching it from the server.  You also need to enable
2302 `gnus-agent' for this to have any affect."
2303   :version "22.1"
2304   :group 'gnus-agent
2305   :type 'boolean)
2306
2307 (defcustom gnus-default-charset 'undecided
2308   "Default charset assumed to be used when viewing non-ASCII characters.
2309 This variable is overridden on a group-to-group basis by the
2310 `gnus-group-charset-alist' variable and is only used on groups not
2311 covered by that variable."
2312   :type 'symbol
2313   :group 'gnus-charset)
2314
2315 ;; Fixme: Doc reference to agent.
2316 (defcustom gnus-agent t
2317   "Whether we want to use the Gnus agent or not.
2318
2319 You may customize gnus-agent to disable its use.  However, some
2320 back ends have started to use the agent as a client-side cache.
2321 Disabling the agent may result in noticeable loss of performance."
2322   :version "22.1"
2323   :group 'gnus-agent
2324   :type 'boolean)
2325
2326 (defcustom gnus-other-frame-function 'gnus
2327   "Function called by the command `gnus-other-frame'."
2328   :group 'gnus-start
2329   :type '(choice (function-item gnus)
2330                  (function-item gnus-no-server)
2331                  (function-item gnus-slave)
2332                  (function-item gnus-slave-no-server)))
2333
2334 (defcustom gnus-other-frame-parameters nil
2335   "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2336 This should be an alist for Emacs, or a plist for XEmacs."
2337   :group 'gnus-start
2338   :type (if (featurep 'xemacs)
2339             '(repeat (list :inline t :format "%v"
2340                            (symbol :tag "Property")
2341                            (sexp :tag "Value")))
2342           '(repeat (cons :format "%v"
2343                          (symbol :tag "Parameter")
2344                          (sexp :tag "Value")))))
2345
2346 (defcustom gnus-user-agent 'emacs-gnus-type
2347   "Which information should be exposed in the User-Agent header.
2348
2349 It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2350 \(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2351 `emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2352 `emacs-gnus' plus system type\) or a custom string.  If you set it to a
2353 string, be sure to use a valid format, see RFC 2616."
2354   :version "22.1"
2355   :group 'gnus-message
2356   :type '(choice
2357           (item :tag "Show Gnus and Emacs versions and system type"
2358                 emacs-gnus-type)
2359           (item :tag "Show Gnus and Emacs versions and system configuration"
2360                 emacs-gnus-config)
2361           (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2362           (item :tag "Show only Gnus version" gnus)
2363           (string :tag "Other")))
2364
2365 \f
2366 ;;; Internal variables
2367
2368 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2369 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2370 (defvar gnus-agent-method-p-cache nil
2371   ; Reset each time gnus-agent-covered-methods is changed else
2372   ; gnus-agent-method-p may mis-report a methods status.
2373   )
2374 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2375 (defvar gnus-draft-meta-information-header "X-Draft-From")
2376 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2377 (defvar gnus-original-article-buffer " *Original Article*")
2378 (defvar gnus-newsgroup-name nil)
2379 (defvar gnus-ephemeral-servers nil)
2380 (defvar gnus-server-method-cache nil)
2381
2382 (defvar gnus-agent-fetching nil
2383   "Whether Gnus agent is in fetching mode.")
2384
2385 (defvar gnus-agent-covered-methods nil
2386   "A list of servers, NOT methods, showing which servers are covered by the agent.")
2387
2388 (defvar gnus-command-method nil
2389   "Dynamically bound variable that says what the current back end is.")
2390
2391 (defvar gnus-current-select-method nil
2392   "The current method for selecting a newsgroup.")
2393
2394 (defvar gnus-tree-buffer "*Tree*"
2395   "Buffer where Gnus thread trees are displayed.")
2396
2397 ;; Dummy variable.
2398 (defvar gnus-use-generic-from nil)
2399
2400 ;; Variable holding the user answers to all method prompts.
2401 (defvar gnus-method-history nil)
2402
2403 ;; Variable holding the user answers to all mail method prompts.
2404 (defvar gnus-mail-method-history nil)
2405
2406 ;; Variable holding the user answers to all group prompts.
2407 (defvar gnus-group-history nil)
2408
2409 (defvar gnus-server-alist nil
2410   "List of available servers.")
2411
2412 (defcustom gnus-cache-directory
2413   (nnheader-concat gnus-directory "cache/")
2414   "*The directory where cached articles will be stored."
2415   :group 'gnus-cache
2416   :type 'directory)
2417
2418 (defvar gnus-predefined-server-alist
2419   `(("cache"
2420      nnspool "cache"
2421      (nnspool-spool-directory ,gnus-cache-directory)
2422      (nnspool-nov-directory ,gnus-cache-directory)
2423      (nnspool-active-file
2424       ,(nnheader-concat gnus-cache-directory "active"))))
2425   "List of predefined (convenience) servers.")
2426
2427 (defvar gnus-topic-indentation "") ;; Obsolete variable.
2428
2429 (defconst gnus-article-mark-lists
2430   '((marked . tick) (replied . reply)
2431     (expirable . expire) (killed . killed)
2432     (bookmarks . bookmark) (dormant . dormant)
2433     (scored . score) (saved . save)
2434     (cached . cache) (downloadable . download)
2435     (unsendable . unsend) (forwarded . forward)
2436     (recent . recent) (seen . seen)))
2437
2438 (defconst gnus-article-special-mark-lists
2439   '((seen range)
2440     (killed range)
2441     (bookmark tuple)
2442     (score tuple)))
2443
2444 ;; Propagate flags to server, with the following exceptions:
2445 ;; `seen' is private to each gnus installation
2446 ;; `cache' is a internal gnus flag for each gnus installation
2447 ;; `download' is a agent flag private to each gnus installation
2448 ;; `unsend' are for nndraft groups only
2449 ;; `score' is not a proper mark
2450 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2451 (defconst gnus-article-unpropagated-mark-lists
2452   '(seen cache download unsend score bookmark)
2453   "Marks that shouldn't be propagated to back ends.
2454 Typical marks are those that make no sense in a standalone back end,
2455 such as a mark that says whether an article is stored in the cache
2456 \(which doesn't make sense in a standalone back end).")
2457
2458 (defvar gnus-headers-retrieved-by nil)
2459 (defvar gnus-article-reply nil)
2460 (defvar gnus-override-method nil)
2461 (defvar gnus-article-check-size nil)
2462 (defvar gnus-opened-servers nil)
2463
2464 (defvar gnus-current-kill-article nil)
2465
2466 (defvar gnus-have-read-active-file nil)
2467
2468 (defconst gnus-maintainer
2469   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2470   "The mail address of the Gnus maintainers.")
2471
2472 (defvar gnus-info-nodes
2473   '((gnus-group-mode "(gnus)Group Buffer")
2474     (gnus-summary-mode "(gnus)Summary Buffer")
2475     (gnus-article-mode "(gnus)Article Buffer")
2476     (gnus-server-mode "(gnus)Server Buffer")
2477     (gnus-browse-mode "(gnus)Browse Foreign Server")
2478     (gnus-tree-mode "(gnus)Tree Display"))
2479   "Alist of major modes and related Info nodes.")
2480
2481 (defvar gnus-group-buffer "*Group*")
2482 (defvar gnus-summary-buffer "*Summary*")
2483 (defvar gnus-article-buffer "*Article*")
2484 (defvar gnus-server-buffer "*Server*")
2485
2486 (defvar gnus-slave nil
2487   "Whether this Gnus is a slave or not.")
2488
2489 (defvar gnus-batch-mode nil
2490   "Whether this Gnus is running in batch mode or not.")
2491
2492 (defvar gnus-variable-list
2493   '(gnus-newsrc-options gnus-newsrc-options-n
2494                         gnus-newsrc-last-checked-date
2495                         gnus-newsrc-alist gnus-server-alist
2496                         gnus-killed-list gnus-zombie-list
2497                         gnus-topic-topology gnus-topic-alist
2498                         gnus-format-specs)
2499   "Gnus variables saved in the quick startup file.")
2500
2501 (defvar gnus-newsrc-alist nil
2502   "Assoc list of read articles.
2503 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2504
2505 (defvar gnus-registry-alist nil
2506   "Assoc list of registry data.
2507 gnus-registry.el will populate this if it's loaded.")
2508
2509 (defvar gnus-newsrc-hashtb nil
2510   "Hashtable of `gnus-newsrc-alist'.")
2511
2512 (defvar gnus-killed-list nil
2513   "List of killed newsgroups.")
2514
2515 (defvar gnus-killed-hashtb nil
2516   "Hash table equivalent of `gnus-killed-list'.")
2517
2518 (defvar gnus-zombie-list nil
2519   "List of almost dead newsgroups.")
2520
2521 (defvar gnus-description-hashtb nil
2522   "Descriptions of newsgroups.")
2523
2524 (defvar gnus-list-of-killed-groups nil
2525   "List of newsgroups that have recently been killed by the user.")
2526
2527 (defvar gnus-active-hashtb nil
2528   "Hashtable of active articles.")
2529
2530 (defvar gnus-moderated-hashtb nil
2531   "Hashtable of moderated newsgroups.")
2532
2533 ;; Save window configuration.
2534 (defvar gnus-prev-winconf nil)
2535
2536 (defvar gnus-reffed-article-number nil)
2537
2538 ;;; Let the byte-compiler know that we know about this variable.
2539 (defvar rmail-default-rmail-file)
2540
2541 (defvar gnus-dead-summary nil)
2542
2543 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2544   "Regexp matching invalid groups.")
2545
2546 (defvar gnus-other-frame-object nil
2547   "A frame object which will be created by `gnus-other-frame'.")
2548
2549 ;;; End of variables.
2550
2551 ;; Define some autoload functions Gnus might use.
2552 (eval-and-compile
2553
2554   ;; This little mapcar goes through the list below and marks the
2555   ;; symbols in question as autoloaded functions.
2556   (mapcar
2557    (lambda (package)
2558      (let ((interactive (nth 1 (memq ':interactive package))))
2559        (mapcar
2560         (lambda (function)
2561           (let (keymap)
2562             (when (consp function)
2563               (setq keymap (car (memq 'keymap function)))
2564               (setq function (car function)))
2565             (unless (fboundp function)
2566               (autoload function (car package) nil interactive keymap))))
2567         (if (eq (nth 1 package) ':interactive)
2568             (nthcdr 3 package)
2569           (cdr package)))))
2570    '(("info" :interactive t Info-goto-node)
2571      ("pp" pp-to-string)
2572      ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2573      ("ps-print" ps-print-preprint)
2574      ("message" :interactive t
2575       message-send-and-exit message-yank-original)
2576      ("babel" babel-as-string)
2577      ("nnmail" nnmail-split-fancy nnmail-article-group)
2578      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2579      ("rmailout" rmail-output rmail-output-to-rmail-file)
2580      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2581       rmail-show-message rmail-summary-exists
2582       rmail-select-summary rmail-update-summary)
2583      ("gnus-audio" :interactive t gnus-audio-play)
2584      ("gnus-xmas" gnus-xmas-splash)
2585      ("gnus-soup" :interactive t
2586       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2587       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2588      ("nnsoup" nnsoup-pack-replies)
2589      ("score-mode" :interactive t gnus-score-mode)
2590      ("gnus-mh" gnus-summary-save-article-folder
2591       gnus-Folder-save-name gnus-folder-save-name)
2592      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2593      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2594       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2595       gnus-demon-add-disconnection gnus-demon-add-handler
2596       gnus-demon-remove-handler)
2597      ("gnus-demon" :interactive t
2598       gnus-demon-init gnus-demon-cancel)
2599      ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2600       gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2601       gnus-face-from-file)
2602      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2603       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2604      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2605       gnus-nocem-unwanted-article-p)
2606      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2607       gnus-server-server-name)
2608      ("gnus-srvr" gnus-browse-foreign-server)
2609      ("gnus-cite" :interactive t
2610       gnus-article-highlight-citation gnus-article-hide-citation-maybe
2611       gnus-article-hide-citation gnus-article-fill-cited-article
2612       gnus-article-hide-citation-in-followups)
2613      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2614       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2615       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2616      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2617       gnus-cache-possibly-remove-articles gnus-cache-request-article
2618       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2619       gnus-cache-enter-remove-article gnus-cached-article-p
2620       gnus-cache-open gnus-cache-close gnus-cache-update-article
2621       gnus-cache-articles-in-group)
2622      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2623       gnus-cache-remove-article gnus-summary-insert-cached-articles)
2624      ("gnus-score" :interactive t
2625       gnus-summary-increase-score gnus-summary-set-score
2626       gnus-summary-raise-thread gnus-summary-raise-same-subject
2627       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2628       gnus-summary-lower-thread gnus-summary-lower-same-subject
2629       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2630       gnus-summary-current-score gnus-score-delta-default
2631       gnus-score-flush-cache gnus-score-close
2632       gnus-possibly-score-headers gnus-score-followup-article
2633       gnus-score-followup-thread)
2634      ("gnus-score"
2635       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2636       gnus-current-score-file-nondirectory gnus-score-adaptive
2637       gnus-score-find-trace gnus-score-file-name)
2638      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2639      ("gnus-topic" :interactive t gnus-topic-mode)
2640      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2641       gnus-subscribe-topics)
2642      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2643      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2644      ("gnus-uu" :interactive t
2645       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2646       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2647       gnus-uu-mark-by-regexp gnus-uu-mark-all
2648       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2649       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2650       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2651       gnus-uu-decode-binhex gnus-uu-decode-uu-view
2652       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2653       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2654       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2655       gnus-uu-mark-over gnus-uu-post-news)
2656      ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2657      ("gnus-msg" (gnus-summary-send-map keymap)
2658       gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2659      ("gnus-msg" :interactive t
2660       gnus-group-post-news gnus-group-mail gnus-group-news
2661       gnus-summary-post-news gnus-summary-news-other-window
2662       gnus-summary-followup gnus-summary-followup-with-original
2663       gnus-summary-cancel-article gnus-summary-supersede-article
2664       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2665       gnus-summary-mail-forward gnus-summary-mail-other-window
2666       gnus-summary-resend-message gnus-summary-resend-bounced-mail
2667       gnus-summary-wide-reply gnus-summary-followup-to-mail
2668       gnus-summary-followup-to-mail-with-original gnus-bug
2669       gnus-summary-wide-reply-with-original
2670       gnus-summary-post-forward gnus-summary-wide-reply-with-original
2671       gnus-summary-post-forward)
2672      ("gnus-picon" :interactive t gnus-treat-from-picon)
2673      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2674       gnus-grouplens-mode)
2675      ("smiley" :interactive t smiley-region)
2676      ("gnus-win" gnus-configure-windows gnus-add-configuration)
2677      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2678       gnus-list-of-unread-articles gnus-list-of-read-articles
2679       gnus-offer-save-summaries gnus-make-thread-indent-array
2680       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2681       gnus-summary-skip-intangible gnus-summary-article-number
2682       gnus-data-header gnus-data-find)
2683      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2684       gnus-group-list-groups gnus-group-first-unread-group
2685       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2686       gnus-group-setup-buffer gnus-group-get-new-news
2687       gnus-group-make-help-group gnus-group-update-group
2688       gnus-group-iterate gnus-group-group-name)
2689      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2690       gnus-backlog-remove-article)
2691      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2692       gnus-article-prepare gnus-article-set-window-start
2693       gnus-article-next-page gnus-article-prev-page
2694       gnus-request-article-this-buffer gnus-article-mode
2695       gnus-article-setup-buffer gnus-narrow-to-page
2696       gnus-article-delete-invisible-text gnus-treat-article)
2697      ("gnus-art" :interactive t
2698       gnus-article-hide-headers gnus-article-hide-boring-headers
2699       gnus-article-treat-overstrike
2700       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2701       gnus-article-display-x-face gnus-article-de-quoted-unreadable
2702       gnus-article-de-base64-unreadable
2703       gnus-article-decode-HZ
2704       gnus-article-wash-html
2705       gnus-article-unsplit-urls
2706       gnus-article-hide-pem gnus-article-hide-signature
2707       gnus-article-strip-leading-blank-lines gnus-article-date-local
2708       gnus-article-date-original gnus-article-date-lapsed
2709 ;;      gnus-article-show-all-headers
2710       gnus-article-edit-mode gnus-article-edit-article
2711       gnus-article-edit-done gnus-article-decode-encoded-words
2712       gnus-start-date-timer gnus-stop-date-timer
2713       gnus-mime-view-all-parts)
2714      ("gnus-int" gnus-request-type)
2715      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2716       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2717      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2718       gnus-dup-enter-articles)
2719      ("gnus-range" gnus-copy-sequence)
2720      ("gnus-eform" gnus-edit-form)
2721      ("gnus-move" :interactive t
2722       gnus-group-move-group-to-server gnus-change-server)
2723      ("gnus-logic" gnus-score-advanced)
2724      ("gnus-undo" gnus-undo-mode gnus-undo-register)
2725      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2726       gnus-async-prefetch-article gnus-async-prefetch-remove-group
2727       gnus-async-halt-prefetch)
2728      ("gnus-agent" gnus-open-agent gnus-agent-get-function
2729       gnus-agent-save-active gnus-agent-method-p
2730       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2731       gnus-summary-set-agent-mark gnus-agent-save-group-info
2732       gnus-agent-request-article gnus-agent-retrieve-headers)
2733      ("gnus-agent" :interactive t
2734       gnus-unplugged gnus-agentize gnus-agent-batch)
2735      ("gnus-vm" :interactive t gnus-summary-save-in-vm
2736       gnus-summary-save-article-vm)
2737      ("compface" uncompface)
2738      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2739      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2740      ("gnus-mlspl" :interactive t gnus-group-split-setup
2741       gnus-group-split-update)
2742      ("gnus-delay" gnus-delay-initialize))))
2743
2744 ;;; gnus-sum.el thingies
2745
2746
2747 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2748   "*The format specification of the lines in the summary buffer.
2749
2750 It works along the same lines as a normal formatting string,
2751 with some simple extensions.
2752
2753 %N   Article number, left padded with spaces (string)
2754 %S   Subject (string)
2755 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
2756 %n   Name of the poster (string)
2757 %a   Extracted name of the poster (string)
2758 %A   Extracted address of the poster (string)
2759 %F   Contents of the From: header (string)
2760 %f   Contents of the From: or To: headers (string)
2761 %x   Contents of the Xref: header (string)
2762 %D   Date of the article (string)
2763 %d   Date of the article (string) in DD-MMM format
2764 %o   Date of the article (string) in YYYYMMDD`T'HHMMSS format
2765 %M   Message-id of the article (string)
2766 %r   References of the article (string)
2767 %c   Number of characters in the article (integer)
2768 %k   Pretty-printed version of the above (string)
2769      For example, \"1.2k\" or \"0.4M\".
2770 %L   Number of lines in the article (integer)
2771 %I   Indentation based on thread level (a string of spaces)
2772 %B   A complex trn-style thread tree (string)
2773      The variables `gnus-sum-thread-*' can be used for customization.
2774 %T   A string with two possible values: 80 spaces if the article
2775      is on thread level two or larger and 0 spaces on level one
2776 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
2777 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2778 %[   Opening bracket (character, \"[\" or \"<\")
2779 %]   Closing bracket (character, \"]\" or \">\")
2780 %>   Spaces of length thread-level (string)
2781 %<   Spaces of length (- 20 thread-level) (string)
2782 %i   Article score (number)
2783 %z   Article zcore (character)
2784 %t   Number of articles under the current thread (number).
2785 %e   Whether the thread is empty or not (character).
2786 %l   GroupLens score (string).
2787 %V   Total thread score (number).
2788 %P   The line number (number).
2789 %O   Download mark (character).
2790 %*   If present, indicates desired cursor position
2791      (instead of after first colon).
2792 %u   User defined specifier.  The next character in the format string should
2793      be a letter.  Gnus will call the function gnus-user-format-function-X,
2794      where X is the letter following %u.  The function will be passed the
2795      current header as argument.  The function should return a string, which
2796      will be inserted into the summary just like information from any other
2797      summary specifier.
2798
2799 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2800 with care.  For reasons of efficiency, Gnus will compute what column
2801 these characters will end up in, and \"hard-code\" that.  This means that
2802 it is invalid to have these specs after a variable-length spec.  Well,
2803 you might not be arrested, but your summary buffer will look strange,
2804 which is bad enough.
2805
2806 The smart choice is to have these specs as far to the left as
2807 possible.
2808
2809 This restriction may disappear in later versions of Gnus.
2810
2811 General format specifiers can also be used.
2812 See Info node `(gnus)Formatting Variables'."
2813   :link '(custom-manual "(gnus)Formatting Variables")
2814   :type 'string
2815   :group 'gnus-summary-format)
2816
2817 ;;;
2818 ;;; Skeleton keymaps
2819 ;;;
2820
2821 (defun gnus-suppress-keymap (keymap)
2822   (suppress-keymap keymap)
2823   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2824     (while keys
2825       (define-key keymap (pop keys) 'undefined))))
2826
2827 (defvar gnus-article-mode-map
2828   (let ((keymap (make-sparse-keymap)))
2829     (gnus-suppress-keymap keymap)
2830     keymap))
2831 (defvar gnus-summary-mode-map
2832   (let ((keymap (make-keymap)))
2833     (gnus-suppress-keymap keymap)
2834     keymap))
2835 (defvar gnus-group-mode-map
2836   (let ((keymap (make-keymap)))
2837     (gnus-suppress-keymap keymap)
2838     keymap))
2839
2840 \f
2841
2842 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2843 ;; If you want the cursor to go somewhere else, set these two
2844 ;; functions in some startup hook to whatever you want.
2845 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2846 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2847
2848 ;;; Various macros and substs.
2849
2850 (defun gnus-header-from (header)
2851   (mail-header-from header))
2852
2853 (defmacro gnus-gethash (string hashtable)
2854   "Get hash value of STRING in HASHTABLE."
2855   `(symbol-value (intern-soft ,string ,hashtable)))
2856
2857 (defmacro gnus-gethash-safe (string hashtable)
2858   "Get hash value of STRING in HASHTABLE.
2859 Return nil if not defined."
2860   `(let ((sym (intern-soft ,string ,hashtable)))
2861      (and (boundp sym) (symbol-value sym))))
2862
2863 (defmacro gnus-sethash (string value hashtable)
2864   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
2865   `(set (intern ,string ,hashtable) ,value))
2866 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2867
2868 (defmacro gnus-group-unread (group)
2869   "Get the currently computed number of unread articles in GROUP."
2870   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2871
2872 (defmacro gnus-group-entry (group)
2873   "Get the newsrc entry for GROUP."
2874   `(gnus-gethash ,group gnus-newsrc-hashtb))
2875
2876 (defmacro gnus-active (group)
2877   "Get active info on GROUP."
2878   `(gnus-gethash ,group gnus-active-hashtb))
2879
2880 (defmacro gnus-set-active (group active)
2881   "Set GROUP's active info."
2882   `(gnus-sethash ,group ,active gnus-active-hashtb))
2883
2884 ;; Info access macros.
2885
2886 (defmacro gnus-info-group (info)
2887   `(nth 0 ,info))
2888 (defmacro gnus-info-rank (info)
2889   `(nth 1 ,info))
2890 (defmacro gnus-info-read (info)
2891   `(nth 2 ,info))
2892 (defmacro gnus-info-marks (info)
2893   `(nth 3 ,info))
2894 (defmacro gnus-info-method (info)
2895   `(nth 4 ,info))
2896 (defmacro gnus-info-params (info)
2897   `(nth 5 ,info))
2898
2899 (defmacro gnus-info-level (info)
2900   `(let ((rank (gnus-info-rank ,info)))
2901      (if (consp rank)
2902          (car rank)
2903        rank)))
2904 (defmacro gnus-info-score (info)
2905   `(let ((rank (gnus-info-rank ,info)))
2906      (or (and (consp rank) (cdr rank)) 0)))
2907
2908 (defmacro gnus-info-set-group (info group)
2909   `(setcar ,info ,group))
2910 (defmacro gnus-info-set-rank (info rank)
2911   `(setcar (nthcdr 1 ,info) ,rank))
2912 (defmacro gnus-info-set-read (info read)
2913   `(setcar (nthcdr 2 ,info) ,read))
2914 (defmacro gnus-info-set-marks (info marks &optional extend)
2915   (if extend
2916       `(gnus-info-set-entry ,info ,marks 3)
2917     `(setcar (nthcdr 3 ,info) ,marks)))
2918 (defmacro gnus-info-set-method (info method &optional extend)
2919   (if extend
2920       `(gnus-info-set-entry ,info ,method 4)
2921     `(setcar (nthcdr 4 ,info) ,method)))
2922 (defmacro gnus-info-set-params (info params &optional extend)
2923   (if extend
2924       `(gnus-info-set-entry ,info ,params 5)
2925     `(setcar (nthcdr 5 ,info) ,params)))
2926
2927 (defun gnus-info-set-entry (info entry number)
2928   ;; Extend the info until we have enough elements.
2929   (while (<= (length info) number)
2930     (nconc info (list nil)))
2931   ;; Set the entry.
2932   (setcar (nthcdr number info) entry))
2933
2934 (defmacro gnus-info-set-level (info level)
2935   `(let ((rank (cdr ,info)))
2936      (if (consp (car rank))
2937          (setcar (car rank) ,level)
2938        (setcar rank ,level))))
2939 (defmacro gnus-info-set-score (info score)
2940   `(let ((rank (cdr ,info)))
2941      (if (consp (car rank))
2942          (setcdr (car rank) ,score)
2943        (setcar rank (cons (car rank) ,score)))))
2944
2945 (defmacro gnus-get-info (group)
2946   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2947
2948 ;;; Load the compatibility functions.
2949
2950 (require 'gnus-ems)
2951
2952 \f
2953 ;;;
2954 ;;; Shutdown
2955 ;;;
2956
2957 (defvar gnus-shutdown-alist nil)
2958
2959 (defun gnus-add-shutdown (function &rest symbols)
2960   "Run FUNCTION whenever one of SYMBOLS is shut down."
2961   (push (cons function symbols) gnus-shutdown-alist))
2962
2963 (defun gnus-shutdown (symbol)
2964   "Shut down everything that waits for SYMBOL."
2965   (let ((alist gnus-shutdown-alist)
2966         entry)
2967     (while (setq entry (pop alist))
2968       (when (memq symbol (cdr entry))
2969         (funcall (car entry))))))
2970
2971 \f
2972 ;;;
2973 ;;; Gnus Utility Functions
2974 ;;;
2975
2976 (defun gnus-find-subscribed-addresses ()
2977   "Return a regexp matching the addresses of all subscribed mail groups.
2978 It consists of the `to-address' or `to-list' parameter of all groups
2979 with a `subscribed' parameter."
2980   (let (group address addresses)
2981     (dolist (entry (cdr gnus-newsrc-alist))
2982       (setq group (car entry))
2983       (when (gnus-parameter-subscribed group)
2984         (setq address (mail-strip-quoted-names
2985                        (or (gnus-group-fast-parameter group 'to-address)
2986                            (gnus-group-fast-parameter group 'to-list))))
2987         (when address
2988           (add-to-list 'addresses address))))
2989     (when addresses
2990       (list (mapconcat 'regexp-quote addresses "\\|")))))
2991
2992 (defmacro gnus-string-or (&rest strings)
2993   "Return the first element of STRINGS that is a non-blank string.
2994 STRINGS will be evaluated in normal `or' order."
2995   `(gnus-string-or-1 ',strings))
2996
2997 (defun gnus-string-or-1 (strings)
2998   (let (string)
2999     (while strings
3000       (setq string (eval (pop strings)))
3001       (if (string-match "^[ \t]*$" string)
3002           (setq string nil)
3003         (setq strings nil)))
3004     string))
3005
3006 (defun gnus-version (&optional arg)
3007   "Version number of this version of Gnus.
3008 If ARG, insert string at point."
3009   (interactive "P")
3010   (if arg
3011       (insert (message gnus-version))
3012     (message gnus-version)))
3013
3014 (defun gnus-continuum-version (&optional version)
3015   "Return VERSION as a floating point number."
3016   (interactive)
3017   (unless version
3018     (setq version gnus-version))
3019   (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3020             (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
3021     (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3022           (number (match-string 2 version))
3023           major minor least)
3024       (unless (string-match
3025                "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3026         (error "Invalid version string: %s" version))
3027       (setq major (string-to-number (match-string 1 number))
3028             minor (string-to-number (match-string 2 number))
3029             least (if (match-beginning 3)
3030                       (string-to-number (match-string 3 number))
3031                     0))
3032       (string-to-number
3033        (if (zerop major)
3034              (format "%s00%02d%02d"
3035                      (if (member alpha '("(ding)" "d"))
3036                          "4.99"
3037                        (+ 5 (* 0.02
3038                                (abs
3039                                 (- (mm-char-int (aref (downcase alpha) 0))
3040                                    (mm-char-int ?t))))
3041                           -0.01))
3042                      minor least)
3043          (format "%d.%02d%02d" major minor least))))))
3044
3045 (defun gnus-info-find-node (&optional nodename)
3046   "Find Info documentation of Gnus."
3047   (interactive)
3048   ;; Enlarge info window if needed.
3049   (let (gnus-info-buffer)
3050     (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3051     (setq gnus-info-buffer (current-buffer))
3052     (gnus-configure-windows 'info)))
3053
3054 ;;;
3055 ;;; gnus-interactive
3056 ;;;
3057
3058 (defvar gnus-current-prefix-symbol nil
3059   "Current prefix symbol.")
3060
3061 (defvar gnus-current-prefix-symbols nil
3062   "List of current prefix symbols.")
3063
3064 (defun gnus-interactive (string &optional params)
3065   "Return a list that can be fed to `interactive'.
3066 See `interactive' for full documentation.
3067
3068 Adds the following specs:
3069
3070 y -- The current symbolic prefix.
3071 Y -- A list of the current symbolic prefix(es).
3072 A -- Article number.
3073 H -- Article header.
3074 g -- Group name."
3075   (let ((i 0)
3076         out c prompt)
3077     (while (< i (length string))
3078       (string-match ".\\([^\n]*\\)\n?" string i)
3079       (setq c (aref string i))
3080       (when (match-end 1)
3081         (setq prompt (match-string 1 string)))
3082       (setq i (match-end 0))
3083       ;; We basically emulate just about everything that
3084       ;; `interactive' does, but add the specs listed above.
3085       (push
3086        (cond
3087         ((= c ?a)
3088          (completing-read prompt obarray 'fboundp t))
3089         ((= c ?b)
3090          (read-buffer prompt (current-buffer) t))
3091         ((= c ?B)
3092          (read-buffer prompt (other-buffer (current-buffer))))
3093         ((= c ?c)
3094          (read-char))
3095         ((= c ?C)
3096          (completing-read prompt obarray 'commandp t))
3097         ((= c ?d)
3098          (point))
3099         ((= c ?D)
3100          (read-file-name prompt nil default-directory 'lambda))
3101         ((= c ?f)
3102          (read-file-name prompt nil nil 'lambda))
3103         ((= c ?F)
3104          (read-file-name prompt))
3105         ((= c ?k)
3106          (read-key-sequence prompt))
3107         ((= c ?K)
3108          (error "Not implemented spec"))
3109         ((= c ?e)
3110          (error "Not implemented spec"))
3111         ((= c ?m)
3112          (mark))
3113         ((= c ?N)
3114          (error "Not implemented spec"))
3115         ((= c ?n)
3116          (string-to-number (read-from-minibuffer prompt)))
3117         ((= c ?p)
3118          (prefix-numeric-value current-prefix-arg))
3119         ((= c ?P)
3120          current-prefix-arg)
3121         ((= c ?r)
3122          'gnus-prefix-nil)
3123         ((= c ?s)
3124          (read-string prompt))
3125         ((= c ?S)
3126          (intern (read-string prompt)))
3127         ((= c ?v)
3128          (read-variable prompt))
3129         ((= c ?x)
3130          (read-minibuffer prompt))
3131         ((= c ?x)
3132          (eval-minibuffer prompt))
3133         ;; And here the new specs come.
3134         ((= c ?y)
3135          gnus-current-prefix-symbol)
3136         ((= c ?Y)
3137          gnus-current-prefix-symbols)
3138         ((= c ?g)
3139          (gnus-group-group-name))
3140         ((= c ?A)
3141          (gnus-summary-skip-intangible)
3142          (or (get-text-property (point) 'gnus-number)
3143              (gnus-summary-last-subject)))
3144         ((= c ?H)
3145          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3146         (t
3147          (error "Non-implemented spec")))
3148        out)
3149       (cond
3150        ((= c ?r)
3151         (push (if (< (point) (mark)) (point) (mark)) out)
3152         (push (if (> (point) (mark)) (point) (mark)) out))))
3153     (setq out (delq 'gnus-prefix-nil out))
3154     (nreverse out)))
3155
3156 (defun gnus-symbolic-argument (&optional arg)
3157   "Read a symbolic argument and a command, and then execute command."
3158   (interactive "P")
3159   (let* ((in-command (this-command-keys))
3160          (command in-command)
3161          gnus-current-prefix-symbols
3162          gnus-current-prefix-symbol
3163          syms)
3164     (while (equal in-command command)
3165       (message "%s-" (key-description (this-command-keys)))
3166       (push (intern (char-to-string (read-char))) syms)
3167       (setq command (read-key-sequence nil t)))
3168     (setq gnus-current-prefix-symbols (nreverse syms)
3169           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3170     (call-interactively (key-binding command t))))
3171
3172 ;;; More various functions.
3173
3174 (defsubst gnus-check-backend-function (func group)
3175   "Check whether GROUP supports function FUNC.
3176 GROUP can either be a string (a group name) or a select method."
3177   (ignore-errors
3178     (let ((method (if (stringp group)
3179                       (car (gnus-find-method-for-group group))
3180                     group)))
3181       (unless (featurep method)
3182         (require method))
3183       (fboundp (intern (format "%s-%s" method func))))))
3184
3185 (defun gnus-group-read-only-p (&optional group)
3186   "Check whether GROUP supports editing or not.
3187 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
3188 that that variable is buffer-local to the summary buffers."
3189   (let ((group (or group gnus-newsgroup-name)))
3190     (not (gnus-check-backend-function 'request-replace-article group))))
3191
3192 (defun gnus-virtual-group-p (group)
3193   "Say whether GROUP is virtual or not."
3194   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3195                         gnus-valid-select-methods)))
3196
3197 (defun gnus-news-group-p (group &optional article)
3198   "Return non-nil if GROUP (and ARTICLE) come from a news server."
3199   (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3200          t)                             ;is news of course.
3201         ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3202          nil)                           ;must be mail then.
3203         ((vectorp article)              ;Has header info.
3204          (eq (gnus-request-type group (mail-header-id article)) 'news))
3205         ((null article)                 ;Hasn't header info
3206          (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3207         ((< article 0)                  ;Virtual message
3208          nil)                           ;we don't know, guess mail.
3209         (t                              ;Has positive number
3210          (eq (gnus-request-type group article) 'news)))) ;use it.
3211
3212 ;; Returns a list of writable groups.
3213 (defun gnus-writable-groups ()
3214   (let ((alist gnus-newsrc-alist)
3215         groups group)
3216     (while (setq group (car (pop alist)))
3217       (unless (gnus-group-read-only-p group)
3218         (push group groups)))
3219     (nreverse groups)))
3220
3221 ;; Check whether to use long file names.
3222 (defun gnus-use-long-file-name (symbol)
3223   ;; The variable has to be set...
3224   (and gnus-use-long-file-name
3225        ;; If it isn't a list, then we return t.
3226        (or (not (listp gnus-use-long-file-name))
3227            ;; If it is a list, and the list contains `symbol', we
3228            ;; return nil.
3229            (not (memq symbol gnus-use-long-file-name)))))
3230
3231 ;; Generate a unique new group name.
3232 (defun gnus-generate-new-group-name (leaf)
3233   (let ((name leaf)
3234         (num 0))
3235     (while (gnus-gethash name gnus-newsrc-hashtb)
3236       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3237     name))
3238
3239 (defun gnus-ephemeral-group-p (group)
3240   "Say whether GROUP is ephemeral or not."
3241   (gnus-group-get-parameter group 'quit-config t))
3242
3243 (defun gnus-group-quit-config (group)
3244   "Return the quit-config of GROUP."
3245   (gnus-group-get-parameter group 'quit-config t))
3246
3247 (defun gnus-kill-ephemeral-group (group)
3248   "Remove ephemeral GROUP from relevant structures."
3249   (gnus-sethash group nil gnus-newsrc-hashtb))
3250
3251 (defun gnus-simplify-mode-line ()
3252   "Make mode lines a bit simpler."
3253   (setq mode-line-modified (cdr gnus-mode-line-modified))
3254   (when (listp mode-line-format)
3255     (make-local-variable 'mode-line-format)
3256     (setq mode-line-format (copy-sequence mode-line-format))
3257     (when (equal (nth 3 mode-line-format) "   ")
3258       (setcar (nthcdr 3 mode-line-format) " "))))
3259
3260 ;;; Servers and groups.
3261
3262 (defsubst gnus-server-add-address (method)
3263   (let ((method-name (symbol-name (car method))))
3264     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3265              (not (assq (intern (concat method-name "-address")) method))
3266              (memq 'physical-address (assq (car method)
3267                                            gnus-valid-select-methods)))
3268         (append method (list (list (intern (concat method-name "-address"))
3269                                    (nth 1 method))))
3270       method)))
3271
3272 (defsubst gnus-method-to-server (method)
3273   (catch 'server-name
3274     (setq method (or method gnus-select-method))
3275
3276     ;; Perhaps it is already in the cache.
3277     (mapc (lambda (name-method)
3278             (if (equal (cdr name-method) method)
3279                 (throw 'server-name (car name-method))))
3280           gnus-server-method-cache)
3281
3282     (mapc
3283      (lambda (server-alist)
3284        (mapc (lambda (name-method)
3285                (when (gnus-methods-equal-p (cdr name-method) method)
3286                  (unless (member name-method gnus-server-method-cache)
3287                    (push name-method gnus-server-method-cache))
3288                  (throw 'server-name (car name-method))))
3289              server-alist))
3290      (let ((alists (list gnus-server-alist
3291                          gnus-predefined-server-alist)))
3292        (if gnus-select-method
3293            (push (list (cons "native" gnus-select-method)) alists))
3294        alists))
3295
3296     (let* ((name (if (member (cadr method) '(nil ""))
3297                      (format "%s" (car method))
3298                    (format "%s:%s" (car method) (cadr method))))
3299            (name-method (cons name method)))
3300       (unless (member name-method gnus-server-method-cache)
3301         (push name-method gnus-server-method-cache))
3302       name)))
3303
3304 (defsubst gnus-server-to-method (server)
3305   "Map virtual server names to select methods."
3306   (or (and server (listp server) server)
3307       (cdr (assoc server gnus-server-method-cache))
3308       (let ((result
3309              (or
3310               ;; Perhaps this is the native server?
3311               (and (equal server "native") gnus-select-method)
3312               ;; It should be in the server alist.
3313               (cdr (assoc server gnus-server-alist))
3314               ;; It could be in the predefined server alist.
3315               (cdr (assoc server gnus-predefined-server-alist))
3316               ;; If not, we look through all the opened server
3317               ;; to see whether we can find it there.
3318               (let ((opened gnus-opened-servers))
3319                 (while (and opened
3320                             (not (equal server (format "%s:%s" (caaar opened)
3321                                                        (cadaar opened)))))
3322                   (pop opened))
3323                 (caar opened))
3324               ;; It could be a named method, search all servers
3325               (let ((servers gnus-secondary-select-methods))
3326                 (while (and servers
3327                             (not (equal server (format "%s:%s" (caar servers)
3328                                                        (cadar servers)))))
3329                   (pop servers))
3330                 (car servers))
3331               ;; This could be some sort of foreign server that I
3332               ;; simply haven't opened (yet).  Do a brute-force scan
3333               ;; of the entire gnus-newsrc-alist for the server name
3334               ;; of every method.  As a side-effect, loads the
3335               ;; gnus-server-method-cache so this only happens once,
3336               ;; if at all.
3337               (let (match)
3338                 (mapcar
3339                  (lambda (info)
3340                    (let ((info-method (gnus-info-method info)))
3341                      (unless (stringp info-method)
3342                        (let ((info-server (gnus-method-to-server info-method)))
3343                          (when (equal server info-server)
3344                            (setq match info-method))))))
3345                  (cdr gnus-newsrc-alist))
3346                 match))))
3347         (when result
3348           (push (cons server result) gnus-server-method-cache))
3349         result)))
3350
3351 (defsubst gnus-server-get-method (group method)
3352   ;; Input either a server name, and extended server name, or a
3353   ;; select method, and return a select method.
3354   (cond ((stringp method)
3355          (gnus-server-to-method method))
3356         ((equal method gnus-select-method)
3357          gnus-select-method)
3358         ((and (stringp (car method))
3359               group)
3360          (gnus-server-extend-method group method))
3361         ((and method
3362               (not group)
3363               (equal (cadr method) ""))
3364          method)
3365         (t
3366          (gnus-server-add-address method))))
3367
3368 (defmacro gnus-method-equal (ss1 ss2)
3369   "Say whether two servers are equal."
3370   `(let ((s1 ,ss1)
3371          (s2 ,ss2))
3372      (or (equal s1 s2)
3373          (and (= (length s1) (length s2))
3374               (progn
3375                 (while (and s1 (member (car s1) s2))
3376                   (setq s1 (cdr s1)))
3377                 (null s1))))))
3378
3379 (defun gnus-methods-equal-p (m1 m2)
3380   (let ((m1 (or m1 gnus-select-method))
3381         (m2 (or m2 gnus-select-method)))
3382     (or (equal m1 m2)
3383         (and (eq (car m1) (car m2))
3384              (or (not (memq 'address (assoc (symbol-name (car m1))
3385                                             gnus-valid-select-methods)))
3386                  (equal (nth 1 m1) (nth 1 m2)))))))
3387
3388 (defun gnus-server-equal (m1 m2)
3389   "Say whether two methods are equal."
3390   (let ((m1 (cond ((null m1) gnus-select-method)
3391                   ((stringp m1) (gnus-server-to-method m1))
3392                   (t m1)))
3393         (m2 (cond ((null m2) gnus-select-method)
3394                   ((stringp m2) (gnus-server-to-method m2))
3395                   (t m2))))
3396     (gnus-method-equal m1 m2)))
3397
3398 (defun gnus-servers-using-backend (backend)
3399   "Return a list of known servers using BACKEND."
3400   (let ((opened gnus-opened-servers)
3401         out)
3402     (while opened
3403       (when (eq backend (caaar opened))
3404         (push (caar opened) out))
3405       (pop opened))
3406     out))
3407
3408 (defun gnus-archive-server-wanted-p ()
3409   "Say whether the user wants to use the archive server."
3410   (cond
3411    ((or (not gnus-message-archive-method)
3412         (not gnus-message-archive-group))
3413     nil)
3414    ((and gnus-message-archive-method gnus-message-archive-group)
3415     t)
3416    (t
3417     (let ((active (cadr (assq 'nnfolder-active-file
3418                               gnus-message-archive-method))))
3419       (and active
3420            (file-exists-p active))))))
3421
3422 (defsubst gnus-method-to-server-name (method)
3423   (concat
3424    (format "%s" (car method))
3425    (when (and
3426           (or (assoc (format "%s" (car method))
3427                      (gnus-methods-using 'address))
3428               (gnus-server-equal method gnus-message-archive-method))
3429           (nth 1 method)
3430           (not (string= (nth 1 method) "")))
3431      (concat "+" (nth 1 method)))))
3432
3433 (defsubst gnus-method-to-full-server-name (method)
3434   (format "%s+%s" (car method) (nth 1 method)))
3435
3436 (defun gnus-group-prefixed-name (group method &optional full)
3437   "Return the whole name from GROUP and METHOD.
3438 Call with full set to get the fully qualified group name (even if the
3439 server is native)."
3440   (when (stringp method)
3441     (setq method (gnus-server-to-method method)))
3442   (if (or (not method)
3443           (and (not full) (gnus-server-equal method "native"))
3444           ;;;!!! This might not be right.  We'll see...
3445           ;(string-match ":" group)
3446           )
3447       group
3448     (concat (gnus-method-to-server-name method) ":" group)))
3449
3450 (defun gnus-group-guess-prefixed-name (group)
3451   "Guess the whole name from GROUP and METHOD."
3452   (gnus-group-prefixed-name group (gnus-find-method-for-group
3453                                group)))
3454
3455 (defun gnus-group-full-name (group method)
3456   "Return the full name from GROUP and METHOD, even if the method is native."
3457   (gnus-group-prefixed-name group method t))
3458
3459 (defun gnus-group-guess-full-name (group)
3460   "Guess the full name from GROUP, even if the method is native."
3461   (if (gnus-group-prefixed-p group)
3462       group
3463     (gnus-group-full-name group (gnus-find-method-for-group group))))
3464
3465 (defun gnus-group-guess-full-name-from-command-method (group)
3466   "Guess the full name from GROUP, even if the method is native."
3467   (if (gnus-group-prefixed-p group)
3468       group
3469     (gnus-group-full-name group gnus-command-method)))
3470
3471 (defun gnus-group-real-prefix (group)
3472   "Return the prefix of the current group name."
3473   (if (stringp group)
3474       (if (string-match "^[^:]+:" group)
3475           (substring group 0 (match-end 0))
3476         "")
3477     nil))
3478
3479 (defun gnus-group-short-name (group)
3480   "Return the short group name."
3481   (let ((prefix (gnus-group-real-prefix group)))
3482     (if (< 0 (length prefix))
3483         (substring group (length prefix) nil)
3484       group)))
3485
3486 (defun gnus-group-prefixed-p (group)
3487   "Return the prefix of the current group name."
3488   (< 0 (length (gnus-group-real-prefix group))))
3489
3490 (defun gnus-summary-buffer-name (group)
3491   "Return the summary buffer name of GROUP."
3492   (concat "*Summary " (gnus-group-decoded-name group) "*"))
3493
3494 (defun gnus-group-method (group)
3495   "Return the server or method used for selecting GROUP.
3496 You should probably use `gnus-find-method-for-group' instead."
3497   (let ((prefix (gnus-group-real-prefix group)))
3498     (if (equal prefix "")
3499         gnus-select-method
3500       (let ((servers gnus-opened-servers)
3501             (server "")
3502             backend possible found)
3503         (if (string-match "^[^\\+]+\\+" prefix)
3504             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3505                   server (substring prefix (match-end 0) (1- (length prefix))))
3506           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3507         (while servers
3508           (when (eq (caaar servers) backend)
3509             (setq possible (caar servers))
3510             (when (equal (cadaar servers) server)
3511               (setq found (caar servers))))
3512           (pop servers))
3513         (or (car (rassoc found gnus-server-alist))
3514             found
3515             (car (rassoc possible gnus-server-alist))
3516             possible
3517             (list backend server))))))
3518
3519 (defsubst gnus-native-method-p (method)
3520   "Return whether METHOD is the native select method."
3521   (gnus-method-equal method gnus-select-method))
3522
3523 (defsubst gnus-secondary-method-p (method)
3524   "Return whether METHOD is a secondary select method."
3525   (let ((methods gnus-secondary-select-methods)
3526         (gmethod (inline (gnus-server-get-method nil method))))
3527     (while (and methods
3528                 (not (gnus-method-equal
3529                       (inline (gnus-server-get-method nil (car methods)))
3530                       gmethod)))
3531       (setq methods (cdr methods)))
3532     methods))
3533
3534 (defun gnus-method-simplify (method)
3535   "Return the shortest uniquely identifying string or method for METHOD."
3536   (cond ((stringp method)
3537          method)
3538         ((gnus-native-method-p method)
3539          nil)
3540         ((gnus-secondary-method-p method)
3541          (format "%s:%s" (nth 0 method) (nth 1 method)))
3542         (t
3543          method)))
3544
3545 (defun gnus-groups-from-server (server)
3546   "Return a list of all groups that are fetched from SERVER."
3547   (let ((alist (cdr gnus-newsrc-alist))
3548         info groups)
3549     (while (setq info (pop alist))
3550       (when (gnus-server-equal (gnus-info-method info) server)
3551         (push (gnus-info-group info) groups)))
3552     (sort groups 'string<)))
3553
3554 (defun gnus-group-foreign-p (group)
3555   "Say whether a group is foreign or not."
3556   (and (not (gnus-group-native-p group))
3557        (not (gnus-group-secondary-p group))))
3558
3559 (defun gnus-group-native-p (group)
3560   "Say whether the group is native or not."
3561   (not (string-match ":" group)))
3562
3563 (defun gnus-group-secondary-p (group)
3564   "Say whether the group is secondary or not."
3565   (gnus-secondary-method-p (gnus-find-method-for-group group)))
3566
3567 (defun gnus-parameters-get-parameter (group)
3568   "Return the group parameters for GROUP from `gnus-parameters'."
3569   (let (params-list)
3570     (dolist (elem gnus-parameters)
3571       (when (string-match (car elem) group)
3572         (setq params-list
3573               (nconc (gnus-expand-group-parameters
3574                       (car elem) (cdr elem) group)
3575                      params-list))))
3576     params-list))
3577
3578 (defun gnus-expand-group-parameter (match value group)
3579   "Use MATCH to expand VALUE in GROUP."
3580   (with-temp-buffer
3581     (insert group)
3582     (goto-char (point-min))
3583     (while (re-search-forward match nil t)
3584       (replace-match value))
3585     (buffer-string)))
3586
3587 (defun gnus-expand-group-parameters (match parameters group)
3588   "Go through PARAMETERS and expand them according to the match data."
3589   (let (new)
3590     (dolist (elem parameters)
3591       (if (and (stringp (cdr elem))
3592                (string-match "\\\\[0-9&]" (cdr elem)))
3593           (push (cons (car elem)
3594                       (gnus-expand-group-parameter match (cdr elem) group))
3595                 new)
3596         (push elem new)))
3597     new))
3598
3599 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3600   "For GROUP, return the value of SYMBOL.
3601
3602 You should call this in the `gnus-group-buffer' buffer.
3603 The function `gnus-group-find-parameter' will do that for you."
3604   ;; The speed trick:  No cons'ing and quit early.
3605   (let* ((params (funcall gnus-group-get-parameter-function group))
3606          ;; Start easy, check the "real" group parameters.
3607          (simple-results
3608           (gnus-group-parameter-value params symbol allow-list t)))
3609     (if simple-results
3610         ;; Found results; return them.
3611         (car simple-results)
3612       ;; We didn't found it there, try `gnus-parameters'.
3613       (let ((result nil)
3614             (head nil)
3615             (tail gnus-parameters))
3616         ;; A good old-fashioned non-cl loop.
3617         (while tail
3618           (setq head (car tail)
3619                 tail (cdr tail))
3620           ;; The car is regexp matching for matching the group name.
3621           (when (string-match (car head) group)
3622             ;; The cdr is the parameters.
3623             (setq result (gnus-group-parameter-value (cdr head)
3624                                                      symbol allow-list))
3625             (when result
3626               ;; Expand if necessary.
3627               (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3628                   (setq result (gnus-expand-group-parameter (car head)
3629                                                             result group)))
3630               ;; Exit the loop early.
3631               (setq tail nil))))
3632         ;; Done.
3633         result))))
3634
3635 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3636   "Return the group parameters for GROUP.
3637 If SYMBOL, return the value of that symbol in the group parameters.
3638
3639 If you call this function inside a loop, consider using the faster
3640 `gnus-group-fast-parameter' instead."
3641   (save-excursion
3642     (set-buffer gnus-group-buffer)
3643     (if symbol
3644         (gnus-group-fast-parameter group symbol allow-list)
3645       (nconc
3646        (copy-sequence
3647         (funcall gnus-group-get-parameter-function group))
3648        (gnus-parameters-get-parameter group)))))
3649
3650 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3651   "Return the group parameters for GROUP.
3652 If SYMBOL, return the value of that symbol in the group parameters.
3653 Most functions should use `gnus-group-find-parameter', which
3654 also examines the topic parameters."
3655   (let ((params (gnus-info-params (gnus-get-info group))))
3656     (if symbol
3657         (gnus-group-parameter-value params symbol allow-list)
3658       params)))
3659
3660 (defun gnus-group-parameter-value (params symbol &optional
3661                                           allow-list present-p)
3662   "Return the value of SYMBOL in group PARAMS."
3663   ;; We only wish to return group parameters (dotted lists) and
3664   ;; not local variables, which may have the same names.
3665   ;; But first we handle single elements...
3666   (or (car (memq symbol params))
3667       ;; Handle alist.
3668       (let (elem)
3669         (catch 'found
3670           (while (setq elem (pop params))
3671             (when (and (consp elem)
3672                        (eq (car elem) symbol)
3673                        (or allow-list
3674                            (atom (cdr elem))))
3675               (throw 'found (if present-p (list (cdr elem))
3676                               (cdr elem)))))))))
3677
3678 (defun gnus-group-add-parameter (group param)
3679   "Add parameter PARAM to GROUP."
3680   (let ((info (gnus-get-info group)))
3681     (when info
3682       (gnus-group-remove-parameter group (if (consp param) (car param) param))
3683       ;; Cons the new param to the old one and update.
3684       (gnus-group-set-info (cons param (gnus-info-params info))
3685                            group 'params))))
3686
3687 (defun gnus-group-set-parameter (group name value)
3688   "Set parameter NAME to VALUE in GROUP."
3689   (let ((info (gnus-get-info group)))
3690     (when info
3691       (gnus-group-remove-parameter group name)
3692       (let ((old-params (gnus-info-params info))
3693             (new-params (list (cons name value))))
3694         (while old-params
3695           (when (or (not (listp (car old-params)))
3696                     (not (eq (caar old-params) name)))
3697             (setq new-params (append new-params (list (car old-params)))))
3698           (setq old-params (cdr old-params)))
3699         (gnus-group-set-info new-params group 'params)))))
3700
3701 (defun gnus-group-remove-parameter (group name)
3702   "Remove parameter NAME from GROUP."
3703   (let ((info (gnus-get-info group)))
3704     (when info
3705       (let ((params (gnus-info-params info)))
3706         (when params
3707           (setq params (delq name params))
3708           (while (assq name params)
3709             (gnus-pull name params))
3710           (gnus-info-set-params info params))))))
3711
3712 (defun gnus-group-add-score (group &optional score)
3713   "Add SCORE to the GROUP score.
3714 If SCORE is nil, add 1 to the score of GROUP."
3715   (let ((info (gnus-get-info group)))
3716     (when info
3717       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3718
3719 (defun gnus-short-group-name (group &optional levels)
3720   "Collapse GROUP name LEVELS.
3721 Select methods are stripped and any remote host name is stripped down to
3722 just the host name."
3723   (let* ((name "")
3724          (foreign "")
3725          (depth 0)
3726          (skip 1)
3727          (levels (or levels
3728                      gnus-group-uncollapsed-levels
3729                      (progn
3730                        (while (string-match "\\." group skip)
3731                          (setq skip (match-end 0)
3732                                depth (+ depth 1)))
3733                        depth))))
3734     ;; Separate foreign select method from group name and collapse.
3735    ;; If method contains a server, collapse to non-domain server name,
3736     ;; otherwise collapse to select method.
3737     (let* ((colon (string-match ":" group))
3738            (server (and colon (substring group 0 colon)))
3739            (plus (and server (string-match "+" server))))
3740       (when server
3741         (if plus
3742             (setq foreign (substring server (+ 1 plus)
3743                                      (string-match "\\." server))
3744                   group (substring group (+ 1 colon)))
3745           (setq foreign server
3746                 group (substring group (+ 1 colon))))
3747         (setq foreign (concat foreign ":")))
3748       ;; Collapse group name leaving LEVELS uncollapsed elements
3749       (let* ((slist (split-string group "/"))
3750              (slen (length slist))
3751              (dlist (split-string group "\\."))
3752              (dlen (length dlist))
3753              glist
3754              glen
3755              gsep
3756              res)
3757         (if (> slen dlen)
3758             (setq glist slist
3759                   glen slen
3760                   gsep "/")
3761           (setq glist dlist
3762                 glen dlen
3763                 gsep "."))
3764         (setq levels (- glen levels))
3765         (dolist (g glist)
3766           (push (if (>= (decf levels) 0)
3767                     (if (zerop (length g))
3768                         ""
3769                       (substring g 0 1))
3770                   g)
3771                 res))
3772         (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3773
3774 (defun gnus-narrow-to-body ()
3775   "Narrow to the body of an article."
3776   (narrow-to-region
3777    (progn
3778      (goto-char (point-min))
3779      (or (search-forward "\n\n" nil t)
3780          (point-max)))
3781    (point-max)))
3782
3783 \f
3784 ;;;
3785 ;;; Kill file handling.
3786 ;;;
3787
3788 (defun gnus-apply-kill-file ()
3789   "Apply a kill file to the current newsgroup.
3790 Returns the number of articles marked as read."
3791   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3792           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3793       (gnus-apply-kill-file-internal)
3794     0))
3795
3796 (defun gnus-kill-save-kill-buffer ()
3797   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3798     (when (get-file-buffer file)
3799       (save-excursion
3800         (set-buffer (get-file-buffer file))
3801         (when (buffer-modified-p)
3802           (save-buffer))
3803         (kill-buffer (current-buffer))))))
3804
3805 (defcustom gnus-kill-file-name "KILL"
3806   "Suffix of the kill files."
3807   :group 'gnus-score-kill
3808   :group 'gnus-score-files
3809   :type 'string)
3810
3811 (defun gnus-newsgroup-kill-file (newsgroup)
3812   "Return the name of a kill file name for NEWSGROUP.
3813 If NEWSGROUP is nil, return the global kill file name instead."
3814   (cond
3815    ;; The global KILL file is placed at top of the directory.
3816    ((or (null newsgroup)
3817         (string-equal newsgroup ""))
3818     (expand-file-name gnus-kill-file-name
3819                       gnus-kill-files-directory))
3820    ;; Append ".KILL" to newsgroup name.
3821    ((gnus-use-long-file-name 'not-kill)
3822     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3823                               "." gnus-kill-file-name)
3824                       gnus-kill-files-directory))
3825    ;; Place "KILL" under the hierarchical directory.
3826    (t
3827     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3828                               "/" gnus-kill-file-name)
3829                       gnus-kill-files-directory))))
3830
3831 ;;; Server things.
3832
3833 (defun gnus-member-of-valid (symbol group)
3834   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3835   (memq symbol (assoc
3836                 (symbol-name (car (gnus-find-method-for-group group)))
3837                 gnus-valid-select-methods)))
3838
3839 (defun gnus-method-option-p (method option)
3840   "Return non-nil if select METHOD has OPTION as a parameter."
3841   (when (stringp method)
3842     (setq method (gnus-server-to-method method)))
3843   (memq option (assoc (format "%s" (car method))
3844                       gnus-valid-select-methods)))
3845
3846 (defun gnus-similar-server-opened (method)
3847   (let ((opened gnus-opened-servers))
3848     (while (and method opened)
3849       (when (and (equal (cadr method) (cadaar opened))
3850                  (equal (car method) (caaar opened))
3851                  (not (equal method (caar opened))))
3852         (setq method nil))
3853       (pop opened))
3854     (not method)))
3855
3856 (defun gnus-server-extend-method (group method)
3857   ;; This function "extends" a virtual server.  If the server is
3858   ;; "hello", and the select method is ("hello" (my-var "something"))
3859   ;; in the group "alt.alt", this will result in a new virtual server
3860   ;; called "hello+alt.alt".
3861   (if (or (not (inline (gnus-similar-server-opened method)))
3862           (not (cddr method)))
3863       method
3864     `(,(car method) ,(concat (cadr method) "+" group)
3865       (,(intern (format "%s-address" (car method))) ,(cadr method))
3866       ,@(cddr method))))
3867
3868 (defun gnus-server-status (method)
3869   "Return the status of METHOD."
3870   (nth 1 (assoc method gnus-opened-servers)))
3871
3872 (defun gnus-group-name-to-method (group)
3873   "Guess a select method based on GROUP."
3874   (if (string-match ":" group)
3875       (let ((server (substring group 0 (match-beginning 0))))
3876         (if (string-match "\\+" server)
3877             (list (intern (substring server 0 (match-beginning 0)))
3878                   (substring server (match-end 0)))
3879           (list (intern server) "")))
3880     gnus-select-method))
3881
3882 (defun gnus-server-string (server)
3883   "Return a readable string that describes SERVER."
3884   (let* ((server (gnus-server-to-method server))
3885          (address (nth 1 server)))
3886     (if (and address
3887              (not (zerop (length address))))
3888         (format "%s using %s" address (car server))
3889       (format "%s" (car server)))))
3890
3891 (defun gnus-find-method-for-group (group &optional info)
3892   "Find the select method that GROUP uses."
3893   (or gnus-override-method
3894       (and (not group)
3895            gnus-select-method)
3896       (and (not (gnus-group-entry group)) ;; a new group
3897            (gnus-group-name-to-method group))
3898       (let ((info (or info (gnus-get-info group)))
3899             method)
3900         (if (or (not info)
3901                 (not (setq method (gnus-info-method info)))
3902                 (equal method "native"))
3903             gnus-select-method
3904           (setq method
3905                 (cond ((stringp method)
3906                        (inline (gnus-server-to-method method)))
3907                       ((stringp (cadr method))
3908                        (inline (gnus-server-extend-method group method)))
3909                       (t
3910                        method)))
3911           (cond ((equal (cadr method) "")
3912                  method)
3913                 ((null (cadr method))
3914                  (list (car method) ""))
3915                 (t
3916                  (gnus-server-add-address method)))))))
3917
3918 (defun gnus-methods-using (feature)
3919   "Find all methods that have FEATURE."
3920   (let ((valids gnus-valid-select-methods)
3921         outs)
3922     (while valids
3923       (when (memq feature (car valids))
3924         (push (car valids) outs))
3925       (setq valids (cdr valids)))
3926     outs))
3927
3928 (defun gnus-read-group (prompt &optional default)
3929   "Prompt the user for a group name.
3930 Disallow invalid group names."
3931   (let ((prefix "")
3932         group)
3933     (while (not group)
3934       (when (string-match
3935              gnus-invalid-group-regexp
3936              (setq group (read-string (concat prefix prompt)
3937                                       (cons (or default "") 0)
3938                                       'gnus-group-history)))
3939         (let ((match (match-string 0 group)))
3940           ;; Might be okay (e.g. for nnimap), so ask the user:
3941           (unless (and (not (string-match "^$\\|:" match))
3942                        (message-y-or-n-p
3943                         "Proceed and create group anyway? " t
3944 "The group name \"" group "\" contains a forbidden character: \"" match "\".
3945
3946 Usually, it's dangerous to create a group with this name, because it's not
3947 supported by all back ends and servers.  On IMAP servers it should work,
3948 though.  If you are really sure, you can proceed anyway and create the group.
3949
3950 You may customize the variable `gnus-invalid-group-regexp', which currently is
3951 set to \"" gnus-invalid-group-regexp
3952 "\", if you want to get rid of this query permanently."))
3953             (setq prefix (format "Invalid group name: \"%s\".  " group)
3954                   group nil)))))
3955     group))
3956
3957 (defun gnus-read-method (prompt)
3958   "Prompt the user for a method.
3959 Allow completion over sensible values."
3960   (let* ((open-servers
3961           (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3962                   gnus-opened-servers))
3963          (valid-methods
3964           (let (methods)
3965             (dolist (method gnus-valid-select-methods)
3966               (if (or (memq 'prompt-address method)
3967                       (not (assoc (format "%s:" (car method)) open-servers)))
3968                   (push method methods)))
3969             methods))
3970          (servers
3971           (append valid-methods
3972                   open-servers
3973                   gnus-predefined-server-alist
3974                   gnus-server-alist))
3975          (method
3976           (completing-read
3977            prompt servers
3978            nil t nil 'gnus-method-history)))
3979     (cond
3980      ((equal method "")
3981       (setq method gnus-select-method))
3982      ((assoc method gnus-valid-select-methods)
3983       (let ((address (if (memq 'prompt-address
3984                                (assoc method gnus-valid-select-methods))
3985                          (read-string "Address: ")
3986                        "")))
3987         (or (cadr (assoc (format "%s:%s" method address) open-servers))
3988             (list (intern method) address))))
3989      ((assoc method servers)
3990       method)
3991      (t
3992       (list (intern method) "")))))
3993
3994 ;;; Agent functions
3995
3996 (defun gnus-agent-method-p (method)
3997   "Say whether METHOD is covered by the agent."
3998   (or (eq (car gnus-agent-method-p-cache) method)
3999       (setq gnus-agent-method-p-cache
4000             (cons method
4001                   (member (if (stringp method)
4002                               method
4003                             (gnus-method-to-server method)) gnus-agent-covered-methods))))
4004   (cdr gnus-agent-method-p-cache))
4005
4006 (defun gnus-online (method)
4007   (not
4008    (if gnus-plugged
4009        (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4010      (gnus-agent-method-p method))))
4011
4012 ;;; User-level commands.
4013
4014 ;;;###autoload
4015 (defun gnus-slave-no-server (&optional arg)
4016   "Read network news as a slave, without connecting to the local server."
4017   (interactive "P")
4018   (gnus-no-server arg t))
4019
4020 ;;;###autoload
4021 (defun gnus-no-server (&optional arg slave)
4022   "Read network news.
4023 If ARG is a positive number, Gnus will use that as the startup
4024 level. If ARG is nil, Gnus will be started at level 2.  If ARG is
4025 non-nil and not a positive number, Gnus will prompt the user for the
4026 name of an NNTP server to use.
4027 As opposed to `gnus', this command will not connect to the local
4028 server."
4029   (interactive "P")
4030   (gnus-no-server-1 arg slave))
4031
4032 ;;;###autoload
4033 (defun gnus-slave (&optional arg)
4034   "Read news as a slave."
4035   (interactive "P")
4036   (gnus arg nil 'slave))
4037
4038 ;;;###autoload
4039 (defun gnus-other-frame (&optional arg display)
4040   "Pop up a frame to read news.
4041 This will call one of the Gnus commands which is specified by the user
4042 option `gnus-other-frame-function' (default `gnus') with the argument
4043 ARG if Gnus is not running, otherwise just pop up a Gnus frame.  The
4044 optional second argument DISPLAY should be a standard display string
4045 such as \"unix:0\" to specify where to pop up a frame.  If DISPLAY is
4046 omitted or the function `make-frame-on-display' is not available, the
4047 current display is used."
4048   (interactive "P")
4049   (if (fboundp 'make-frame-on-display)
4050       (unless display
4051         (setq display (gnus-frame-or-window-display-name (selected-frame))))
4052     (setq display nil))
4053   (let ((alive (gnus-alive-p)))
4054     (unless (and alive
4055                  (catch 'found
4056                    (walk-windows
4057                     (lambda (window)
4058                       (when (and (or (not display)
4059                                      (equal display
4060                                             (gnus-frame-or-window-display-name
4061                                              window)))
4062                                  (with-current-buffer (window-buffer window)
4063                                    (string-match "\\`gnus-"
4064                                                  (symbol-name major-mode))))
4065                         (gnus-select-frame-set-input-focus
4066                          (setq gnus-other-frame-object (window-frame window)))
4067                         (select-window window)
4068                         (throw 'found t)))
4069                     'ignore t)))
4070       (gnus-select-frame-set-input-focus
4071        (setq gnus-other-frame-object
4072              (if display
4073                  (make-frame-on-display display gnus-other-frame-parameters)
4074                (make-frame gnus-other-frame-parameters))))
4075       (if alive
4076           (switch-to-buffer gnus-group-buffer)
4077         (funcall gnus-other-frame-function arg)
4078         (add-hook 'gnus-exit-gnus-hook
4079                   '(lambda nil
4080                      (when (and (frame-live-p gnus-other-frame-object)
4081                                 (cdr (frame-list)))
4082                        (delete-frame gnus-other-frame-object))
4083                      (setq gnus-other-frame-object nil)))))))
4084
4085 ;;(setq thing ?                         ; this is a comment
4086 ;;      more 'yes)
4087
4088 ;;;###autoload
4089 (defun gnus (&optional arg dont-connect slave)
4090   "Read network news.
4091 If ARG is non-nil and a positive number, Gnus will use that as the
4092 startup level.  If ARG is non-nil and not a positive number, Gnus will
4093 prompt the user for the name of an NNTP server to use."
4094   (interactive "P")
4095   (unless (byte-code-function-p (symbol-function 'gnus))
4096     (message "You should byte-compile Gnus")
4097     (sit-for 2))
4098   (gnus-1 arg dont-connect slave))
4099
4100 ;; Allow redefinition of Gnus functions.
4101
4102 (gnus-ems-redefine)
4103
4104 (provide 'gnus)
4105
4106 ;;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4107 ;;; gnus.el ends here