lisp/gnus/gnus-cus.el

   1 ;;; gnus-cus.el --- customization commands for Gnus
   2
   3 ;; Copyright (C) 1996, 1999, 2000, 2001, 2002, 2003, 2004,
   4 ;;   2005 Free Software Foundation, Inc.
   5
   6 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
   7 ;; Keywords: news
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24 ;; Boston, MA 02110-1301, USA.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (require 'wid-edit)
  31 (require 'gnus)
  32 (require 'gnus-agent)
  33 (require 'gnus-score)
  34 (require 'gnus-topic)
  35 (require 'gnus-art)
  36
  37 ;;; Widgets:
  38
  39 (defvar gnus-custom-map
  40   (let ((map (make-keymap)))
  41     (set-keymap-parent map widget-keymap)
  42     (suppress-keymap map)
  43     (define-key map [mouse-1] 'widget-move-and-invoke)
  44     map)
  45   "Keymap for editing Gnus customization buffers.")
  46
  47 (defun gnus-custom-mode ()
  48   "Major mode for editing Gnus customization buffers.
  49
  50 The following commands are available:
  51
  52 \\[widget-forward]              Move to next button or editable field.
  53 \\[widget-backward]             Move to previous button or editable field.
  54 \\[widget-button-click]         Activate button under the mouse pointer.
  55 \\[widget-button-press]         Activate button under point.
  56
  57 Entry to this mode calls the value of `gnus-custom-mode-hook'
  58 if that value is non-nil."
  59   (kill-all-local-variables)
  60   (setq major-mode 'gnus-custom-mode
  61         mode-name "Gnus Customize")
  62   (use-local-map gnus-custom-map)
  63   ;; Emacs 21 stuff:
  64   (when (and (facep 'custom-button-face)
  65              (facep 'custom-button-pressed-face))
  66     (set (make-local-variable 'widget-button-face)
  67          'custom-button-face)
  68     (set (make-local-variable 'widget-button-pressed-face)
  69          'custom-button-pressed-face)
  70     (set (make-local-variable 'widget-mouse-face)
  71          'custom-button-pressed-face))
  72   (when (and (boundp 'custom-raised-buttons)
  73              (symbol-value 'custom-raised-buttons))
  74     (set (make-local-variable 'widget-push-button-prefix) "")
  75     (set (make-local-variable 'widget-push-button-suffix) "")
  76     (set (make-local-variable 'widget-link-prefix) "")
  77     (set (make-local-variable 'widget-link-suffix) ""))
  78   (gnus-run-mode-hooks 'gnus-custom-mode-hook))
  79
  80 ;;; Group Customization:
  81
  82 (defconst gnus-group-parameters
  83   '((extra-aliases (choice
  84                     :tag "Extra Aliases"
  85                     (list
  86                      :tag "List"
  87                      (editable-list
  88                       :inline t
  89                       (gnus-email-address :tag "Address")))
  90                     (gnus-email-address :tag "Address")) "\
  91 Store messages posted from or to this address in this group.
  92
  93 You must be using gnus-group-split for this to work.  The VALUE of the
  94 nnmail-split-fancy SPLIT generated for this group will match these
  95 addresses.")
  96
  97     (split-regexp (regexp :tag "gnus-group-split Regular Expression") "\
  98 Like gnus-group-split Address, but expects a regular expression.")
  99
 100     (split-exclude (list :tag "gnus-group-split Restricts"
 101                          (editable-list
 102                           :inline t (regexp :tag "Restrict"))) "\
 103 Regular expression that cancels gnus-group-split matches.
 104
 105 Each entry is added to the nnmail-split-fancy SPLIT as a separate
 106 RESTRICT clause.")
 107
 108     (split-spec (choice :tag "gnus-group-split Overrider"
 109                         (sexp :tag "Fancy Split")
 110                         (const :tag "Catch All" catch-all)
 111                         (const :tag "Ignore" nil)) "\
 112 Override all other gnus-group-split fields.
 113
 114 In `Fancy Split', you can enter any nnmail-split-fancy SPLIT.  Note
 115 that the name of this group won't be automatically assumed, you have
 116 to add it to the SPLITs yourself.  This means you can use such splits
 117 to split messages to other groups too.
 118
 119 If you select `Catch All', this group will get postings for any
 120 messages not matched in any other group.  It overrides the variable
 121 gnus-group-split-default-catch-all-group.
 122
 123 Selecting `Ignore' forces no SPLIT to be generated for this group,
 124 disabling all other gnus-group-split fields.")
 125
 126     (broken-reply-to (const :tag "Broken Reply To" t) "\
 127 Ignore `Reply-To' headers in this group.
 128
 129 That can be useful if you're reading a mailing list group where the
 130 listserv has inserted `Reply-To' headers that point back to the
 131 listserv itself.  This is broken behavior.  So there!")
 132
 133     (to-group (string :tag "To Group") "\
 134 All posts will be sent to the specified group.")
 135
 136     (gcc-self (choice :tag  "GCC"
 137                       :value t
 138                       (const :tag "To current group" t)
 139                       (const none)
 140                       (string :format "%v" :hide-front-space t)) "\
 141 Specify default value for GCC header.
 142
 143 If this symbol is present in the group parameter list and set to t,
 144 new composed messages will be `Gcc''d to the current group.  If it is
 145 present and set to `none', no `Gcc:' header will be generated, if it
 146 is present and a string, this string will be inserted literally as a
 147 `gcc' header (this symbol takes precedence over any default `Gcc'
 148 rules as described later).")
 149
 150     (expiry-wait (choice :tag  "Expire Wait"
 151                          :value never
 152                          (const never)
 153                          (const immediate)
 154                          (number :hide-front-space t
 155                                  :format "%v")) "\
 156 When to expire.
 157
 158 Overrides any `nnmail-expiry-wait' and `nnmail-expiry-wait-function'
 159 when expiring expirable messages.  The value can either be a number of
 160 days (not necessarily an integer) or the symbols `never' or
 161 `immediate'.")
 162
 163     (expiry-target (choice :tag "Expiry Target"
 164                            :value delete
 165                            (const delete)
 166                            (function :format "%v" nnmail-)
 167                            string) "\
 168 Where expired messages end up.
 169
 170 Overrides `nnmail-expiry-target'.")
 171
 172     (score-file (file :tag "Score File") "\
 173 Make the specified file into the current score file.
 174 This means that all score commands you issue will end up in this file.")
 175
 176     (adapt-file (file :tag "Adapt File") "\
 177 Make the specified file into the current adaptive file.
 178 All adaptive score entries will be put into this file.")
 179
 180     (admin-address (gnus-email-address :tag "Admin Address") "\
 181 Administration address for a mailing list.
 182
 183 When unsubscribing to a mailing list you should never send the
 184 unsubscription notice to the mailing list itself.  Instead, you'd
 185 send messages to the administrative address.  This parameter allows
 186 you to put the admin address somewhere convenient.")
 187
 188     (display (choice :tag "Display"
 189                      :value default
 190                      (const all)
 191                      (integer)
 192                      (const default)
 193                      (sexp  :tag "Other")) "\
 194 Which articles to display on entering the group.
 195
 196 `all'
 197      Display all articles, both read and unread.
 198
 199 `integer'
 200      Display the last NUMBER articles in the group.  This is the same as
 201      entering the group with C-u NUMBER.
 202
 203 `default'
 204      Display the default visible articles, which normally includes
 205      unread and ticked articles.
 206
 207 `Other'
 208      Display the articles that satisfy the S-expression. The S-expression
 209      should be in an array form.")
 210
 211     (comment (string :tag  "Comment") "\
 212 An arbitrary comment on the group.")
 213
 214     (visible (const :tag "Permanently visible" t) "\
 215 Always display this group, even when there are no unread articles in it.")
 216
 217     (highlight-words
 218      (choice :tag "Highlight words"
 219              :value nil
 220              (repeat (list (regexp :tag "Highlight regexp")
 221                            (number :tag "Group for entire word" 0)
 222                            (number :tag "Group for displayed part" 0)
 223                            (symbol :tag "Face"
 224                                    gnus-emphasis-highlight-words))))
 225      "highlight regexps.
 226 See `gnus-emphasis-alist'.")
 227
 228     (posting-style
 229      (choice :tag "Posting style"
 230              :value nil
 231              (repeat (list
 232                       (choice :tag "Type"
 233                               :value nil
 234                               (const signature)
 235                               (const signature-file)
 236                               (const organization)
 237                               (const address)
 238                               (const name)
 239                               (const body))
 240                       (string :format "%v"))))
 241      "post style.
 242 See `gnus-posting-styles'."))
 243   "Alist of valid group or topic parameters.
 244
 245 Each entry has the form (NAME TYPE DOC), where NAME is the parameter
 246 itself (a symbol), TYPE is the parameters type (a sexp widget), and
 247 DOC is a documentation string for the parameter.")
 248
 249 (defconst gnus-extra-topic-parameters
 250   '((subscribe (regexp :tag "Subscribe") "\
 251 If `gnus-subscribe-newsgroup-method' or
 252 `gnus-subscribe-options-newsgroup-method' is set to
 253 `gnus-subscribe-topics', new groups that matches this regexp will
 254 automatically be subscribed to this topic")
 255     (subscribe-level (integer :tag "Subscribe Level" :value 1) "\
 256 If this topic parameter is set, when new groups are subscribed
 257 automatically under this topic (via the `subscribe' topic parameter)
 258 assign this level to the group, rather than the default level
 259 set in `gnus-level-default-subscribed'"))
 260   "Alist of topic parameters that are not also group parameters.
 261
 262 Each entry has the form (NAME TYPE DOC), where NAME is the parameter
 263 itself (a symbol), TYPE is the parameters type (a sexp widget), and
 264 DOC is a documentation string for the parameter.")
 265
 266 (defconst gnus-extra-group-parameters
 267   '((uidvalidity (string :tag "IMAP uidvalidity") "\
 268 Server-assigned value attached to IMAP groups, used to maintain consistency."))
 269   "Alist of group parameters that are not also topic parameters.
 270
 271 Each entry has the form (NAME TYPE DOC), where NAME is the parameter
 272 itself (a symbol), TYPE is the parameters type (a sexp widget), and
 273 DOC is a documentation string for the parameter.")
 274
 275 (eval-and-compile
 276   (defconst gnus-agent-parameters
 277     '((agent-predicate
 278        (sexp :tag "Selection Predicate" :value false)
 279        "Predicate used to automatically select articles for downloading."
 280        gnus-agent-cat-predicate)
 281       (agent-score
 282        (choice :tag "Score File" :value nil
 283                (const file :tag "Use group's score files")
 284                (repeat (list (string :format "%v" :tag "File name"))))
 285        "Which score files to use when using score to select articles to fetch.
 286
 287     `nil'
 288          All articles will be scored to zero (0).
 289
 290     `file'
 291          The group's score files will be used to score the articles.
 292
 293     `List'
 294          A list of score file names."
 295        gnus-agent-cat-score-file)
 296       (agent-short-article
 297        (integer :tag "Max Length of Short Article" :value "")
 298        "The SHORT predicate will evaluate to true when the article is
 299 shorter than this length."  gnus-agent-cat-length-when-short)
 300       (agent-long-article
 301        (integer :tag "Min Length of Long Article" :value "")
 302        "The LONG predicate will evaluate to true when the article is
 303 longer than this length."  gnus-agent-cat-length-when-long)
 304       (agent-low-score
 305        (integer :tag "Low Score Limit" :value "")
 306        "The LOW predicate will evaluate to true when the article scores
 307 lower than this limit."  gnus-agent-cat-low-score)
 308       (agent-high-score
 309        (integer :tag "High Score Limit" :value "")
 310        "The HIGH predicate will evaluate to true when the article scores
 311 higher than this limit."  gnus-agent-cat-high-score)
 312       (agent-days-until-old
 313        (integer :tag "Days Until Old" :value "")
 314        "The OLD predicate will evaluate to true when the fetched article
 315 has been stored locally for at least this many days."
 316        gnus-agent-cat-days-until-old)
 317       (agent-enable-expiration
 318        (radio :tag "Expire in this Group or Topic" :value nil
 319               (const :format "Enable " ENABLE)
 320               (const :format "Disable " DISABLE))
 321        "\nEnable, or disable, agent expiration in this group or topic."
 322        gnus-agent-cat-enable-expiration)
 323       (agent-enable-undownloaded-faces
 324        (boolean :tag "Enable Agent Faces")
 325        "Have the summary buffer use the agent's undownloaded faces.
 326 These faces, when enabled, act as a warning that an article has not
 327 been fetched into either the agent nor the cache.  This is of most use
 328 to users who use the agent as a cache (i.e. they only operate on
 329 articles that have been downloaded).  Leave disabled to display normal
 330 article faces even when the article hasn't been downloaded."
 331 gnus-agent-cat-enable-undownloaded-faces))
 332     "Alist of group parameters that are not also topic parameters.
 333
 334 Each entry has the form (NAME TYPE DOC ACCESSOR), where NAME is the
 335 parameter itself (a symbol), TYPE is the parameters type (a sexp
 336 widget), DOC is a documentation string for the parameter, and ACCESSOR
 337 is a function (symbol) that extracts the current value from the
 338 category."))
 339
 340 (defvar gnus-custom-params)
 341 (defvar gnus-custom-method)
 342 (defvar gnus-custom-group)
 343 (defvar gnus-custom-topic)
 344
 345 (defun gnus-group-customize (group &optional topic)
 346   "Edit the group or topic on the current line."
 347   (interactive (list (gnus-group-group-name) (gnus-group-topic-name)))
 348   (let (info
 349         (types (mapcar (lambda (entry)
 350                          `(cons :format "%v%h\n"
 351                                 :doc ,(nth 2 entry)
 352                                 (const :format "" ,(nth 0 entry))
 353                                 ,(nth 1 entry)))
 354                        (append (reverse gnus-group-parameters-more)
 355                                gnus-group-parameters
 356                                (if group
 357                                    gnus-extra-group-parameters
 358                                  gnus-extra-topic-parameters))))
 359         (agent (mapcar (lambda (entry)
 360                          (let ((type (nth 1 entry))
 361                                vcons)
 362                            (if (listp type)
 363                                (setq type (copy-sequence type)))
 364
 365                            (setq vcons (cdr (memq :value type)))
 366
 367                            (if (symbolp (car vcons))
 368                                (condition-case nil
 369                                    (setcar vcons (symbol-value (car vcons)))
 370                                  (error)))
 371                            `(cons :format "%v%h\n"
 372                                   :doc ,(nth 2 entry)
 373                                   (const :format "" ,(nth 0 entry))
 374                                   ,type)))
 375                        (if gnus-agent
 376                            gnus-agent-parameters))))
 377     (unless (or group topic)
 378       (error "No group on current line"))
 379     (when (and group topic)
 380       (error "Both a group an topic on current line"))
 381     (unless (or topic (setq info (gnus-get-info group)))
 382       (error "Killed group; can't be edited"))
 383     ;; Ready.
 384     (gnus-kill-buffer (gnus-get-buffer-create "*Gnus Customize*"))
 385     (switch-to-buffer (gnus-get-buffer-create "*Gnus Customize*"))
 386     (gnus-custom-mode)
 387     (make-local-variable 'gnus-custom-group)
 388     (setq gnus-custom-group group)
 389     (make-local-variable 'gnus-custom-topic)
 390     (setq gnus-custom-topic topic)
 391     (buffer-disable-undo)
 392     (widget-insert "Customize the ")
 393     (if group
 394         (widget-create 'info-link
 395                        :help-echo "Push me to learn more."
 396                        :tag "group parameters"
 397                        "(gnus)Group Parameters")
 398       (widget-create 'info-link
 399                      :help-echo "Push me to learn more."
 400                      :tag  "topic parameters"
 401                      "(gnus)Topic Parameters"))
 402     (widget-insert " for <")
 403     (widget-insert (gnus-group-decoded-name (or group topic)))
 404     (widget-insert "> and press ")
 405     (widget-create 'push-button
 406                    :tag "done"
 407                    :help-echo "Push me when done customizing."
 408                    :action 'gnus-group-customize-done)
 409     (widget-insert ".\n\n")
 410     (make-local-variable 'gnus-custom-params)
 411
 412     (let ((values (if group
 413                       (gnus-info-params info)
 414                     (gnus-topic-parameters topic))))
 415
 416       ;; The parameters in values may contain duplicates.  This is
 417       ;; normally OK as assq returns the first. However, right here
 418       ;; every duplicate ends up being displayed.  So, rather than
 419       ;; display them, remove them from the list.
 420
 421       (let ((tmp (setq values (gnus-copy-sequence values)))
 422             elem)
 423         (while (cdr tmp)
 424           (while (setq elem (assq (caar tmp) (cdr tmp)))
 425             (delq elem tmp))
 426           (setq tmp (cdr tmp))))
 427
 428       (setq gnus-custom-params
 429             (apply 'widget-create 'group
 430                    :value values
 431                    (delq nil
 432                          (list `(set :inline t
 433                                      :greedy t
 434                                      :tag "Parameters"
 435                                      :format "%t:\n%h%v"
 436                                      :doc "\
 437 These special parameters are recognized by Gnus.
 438 Check the [ ] for the parameters you want to apply to this group or
 439 to the groups in this topic, then edit the value to suit your taste."
 440                                      ,@types)
 441                                (when gnus-agent
 442                                  `(set :inline t
 443                                        :greedy t
 444                                        :tag "Agent Parameters"
 445                                        :format "%t:\n%h%v"
 446                                        :doc "\ These agent parameters are
 447 recognized by Gnus.  They control article selection and expiration for
 448 use in the unplugged cache.  Check the [ ] for the parameters you want
 449 to apply to this group or to the groups in this topic, then edit the
 450 value to suit your taste.
 451
 452 For those interested, group parameters override topic parameters while
 453 topic parameters override agent category parameters.  Underlying
 454 category parameters are the customizable variables."  ,@agent))
 455                                '(repeat :inline t
 456                                         :tag "Variables"
 457                                         :format "%t:\n%h%v%i\n\n"
 458                                         :doc "\
 459 Set variables local to the group you are entering.
 460
 461 If you want to turn threading off in `news.answers', you could put
 462 `(gnus-show-threads nil)' in the group parameters of that group.
 463 `gnus-show-threads' will be made into a local variable in the summary
 464 buffer you enter, and the form nil will be `eval'ed there.
 465
 466 This can also be used as a group-specific hook function, if you'd
 467 like.  If you want to hear a beep when you enter a group, you could
 468 put something like `(dummy-variable (ding))' in the parameters of that
 469 group.  `dummy-variable' will be set to the result of the `(ding)'
 470 form, but who cares?"
 471                                         (list :format "%v" :value (nil nil)
 472                                               (symbol :tag "Variable")
 473                                               (sexp :tag
 474                                                     "Value")))
 475
 476                                '(repeat :inline t
 477                                         :tag "Unknown entries"
 478                                         sexp))))))
 479     (when group
 480       (widget-insert "\n\nYou can also edit the ")
 481       (widget-create 'info-link
 482                      :tag "select method"
 483                      :help-echo "Push me to learn more about select methods."
 484                      "(gnus)Select Methods")
 485       (widget-insert " for the group.\n")
 486       (setq gnus-custom-method
 487             (widget-create 'sexp
 488                            :tag "Method"
 489                            :value (gnus-info-method info))))
 490     (use-local-map gnus-custom-map)
 491     (widget-setup)
 492     (buffer-enable-undo)
 493     (goto-char (point-min))))
 494
 495 (defun gnus-group-customize-done (&rest ignore)
 496   "Apply changes and bury the buffer."
 497   (interactive)
 498   (if gnus-custom-topic
 499       (gnus-topic-set-parameters gnus-custom-topic
 500                                  (widget-value gnus-custom-params))
 501     (gnus-group-edit-group-done 'params gnus-custom-group
 502                                 (widget-value gnus-custom-params))
 503     (gnus-group-edit-group-done 'method gnus-custom-group
 504                                 (widget-value gnus-custom-method)))
 505   (bury-buffer))
 506
 507 ;;; Score Customization:
 508
 509 (defconst gnus-score-parameters
 510   '((mark (number :tag "Mark") "\
 511 The value of this entry should be a number.
 512 Any articles with a score lower than this number will be marked as read.")
 513
 514     (expunge (number :tag "Expunge") "\
 515 The value of this entry should be a number.
 516 Any articles with a score lower than this number will be removed from
 517 the summary buffer.")
 518
 519     (mark-and-expunge (number :tag "Mark-and-expunge") "\
 520 The value of this entry should be a number.
 521 Any articles with a score lower than this number will be marked as
 522 read and removed from the summary buffer.")
 523
 524     (thread-mark-and-expunge (number :tag "Thread-mark-and-expunge") "\
 525 The value of this entry should be a number.
 526 All articles that belong to a thread that has a total score below this
 527 number will be marked as read and removed from the summary buffer.
 528 `gnus-thread-score-function' says how to compute the total score
 529 for a thread.")
 530
 531     (files (repeat :inline t :tag "Files" file) "\
 532 The value of this entry should be any number of file names.
 533 These files are assumed to be score files as well, and will be loaded
 534 the same way this one was.")
 535
 536     (exclude-files (repeat :inline t :tag "Exclude-files" file) "\
 537 The clue of this entry should be any number of files.
 538 These files will not be loaded, even though they would normally be so,
 539 for some reason or other.")
 540
 541     (eval (sexp :tag "Eval" :value nil) "\
 542 The value of this entry will be `eval'el.
 543 This element will be ignored when handling global score files.")
 544
 545     (read-only (boolean :tag "Read-only" :value t) "\
 546 Read-only score files will not be updated or saved.
 547 Global score files should feature this atom.")
 548
 549     (orphan (number :tag "Orphan") "\
 550 The value of this entry should be a number.
 551 Articles that do not have parents will get this number added to their
 552 scores.  Imagine you follow some high-volume newsgroup, like
 553 `comp.lang.c'.  Most likely you will only follow a few of the threads,
 554 also want to see any new threads.
 555
 556 You can do this with the following two score file entries:
 557
 558      (orphan -500)
 559      (mark-and-expunge -100)
 560
 561 When you enter the group the first time, you will only see the new
 562 threads.  You then raise the score of the threads that you find
 563 interesting (with `I T' or `I S'), and ignore (`C y') the rest.
 564 Next time you enter the group, you will see new articles in the
 565 interesting threads, plus any new threads.
 566
 567 I.e.---the orphan score atom is for high-volume groups where there
 568 exist a few interesting threads which can't be found automatically
 569 by ordinary scoring rules.")
 570
 571     (adapt (choice :tag "Adapt"
 572                    (const t)
 573                    (const ignore)
 574                    (sexp :format "%v"
 575                          :hide-front-space t)) "\
 576 This entry controls the adaptive scoring.
 577 If it is t, the default adaptive scoring rules will be used.  If it
 578 is `ignore', no adaptive scoring will be performed on this group.  If
 579 it is a list, this list will be used as the adaptive scoring rules.
 580 If it isn't present, or is something other than t or `ignore', the
 581 default adaptive scoring rules will be used.  If you want to use
 582 adaptive scoring on most groups, you'd set `gnus-use-adaptive-scoring'
 583 to t, and insert an `(adapt ignore)' in the groups where you do not
 584 want adaptive scoring.  If you only want adaptive scoring in a few
 585 groups, you'd set `gnus-use-adaptive-scoring' to nil, and insert
 586 `(adapt t)' in the score files of the groups where you want it.")
 587
 588     (adapt-file (file :tag "Adapt-file") "\
 589 All adaptive score entries will go to the file named by this entry.
 590 It will also be applied when entering the group.  This atom might
 591 be handy if you want to adapt on several groups at once, using the
 592 same adaptive file for a number of groups.")
 593
 594     (local (repeat :tag "Local"
 595                    (group :value (nil nil)
 596                           (symbol :tag "Variable")
 597                           (sexp :tag "Value"))) "\
 598 The value of this entry should be a list of `(VAR VALUE)' pairs.
 599 Each VAR will be made buffer-local to the current summary buffer,
 600 and set to the value specified.  This is a convenient, if somewhat
 601 strange, way of setting variables in some groups if you don't like
 602 hooks much.")
 603     (touched (sexp :format "Touched\n") "Internal variable."))
 604   "Alist of valid symbolic score parameters.
 605
 606 Each entry has the form (NAME TYPE DOC), where NAME is the parameter
 607 itself (a symbol), TYPE is the parameters type (a sexp widget), and DOC is a
 608 documentation string for the parameter.")
 609
 610 (define-widget 'gnus-score-string 'group
 611   "Edit score entries for string-valued headers."
 612   :convert-widget 'gnus-score-string-convert)
 613
 614 (defun gnus-score-string-convert (widget)
 615   ;; Set args appropriately.
 616   (let* ((tag (widget-get widget :tag))
 617          (item `(const :format "" :value ,(downcase tag)))
 618          (match '(string :tag "Match"))
 619          (score '(choice :tag "Score"
 620                          (const :tag "default" nil)
 621                          (integer :format "%v"
 622                                   :hide-front-space t)))
 623          (expire '(choice :tag "Expire"
 624                           (const :tag "off" nil)
 625                           (integer :format "%v"
 626                                    :hide-front-space t)))
 627          (type '(choice :tag "Type"
 628                         :value s
 629                         ;; I should really create a forgiving :match
 630                         ;; function for each type below, that only
 631                         ;; looked at the first letter.
 632                         (const :tag "Regexp" r)
 633                         (const :tag "Regexp (fixed case)" R)
 634                         (const :tag "Substring" s)
 635                         (const :tag "Substring (fixed case)" S)
 636                         (const :tag "Exact" e)
 637                         (const :tag "Exact (fixed case)" E)
 638                         (const :tag "Word" w)
 639                         (const :tag "Word (fixed case)" W)
 640                         (const :tag "default" nil)))
 641          (group `(group ,match ,score ,expire ,type))
 642          (doc (concat (or (widget-get widget :doc)
 643                           (concat "Change score based on the " tag
 644                                   " header.\n"))
 645                       "
 646 You can have an arbitrary number of score entries for this header,
 647 each score entry has four elements:
 648
 649 1. The \"match element\".  This should be the string to look for in the
 650    header.
 651
 652 2. The \"score element\".  This number should be an integer in the
 653    neginf to posinf interval.  This number is added to the score
 654    of the article if the match is successful.  If this element is
 655    not present, the `gnus-score-interactive-default-score' number
 656    will be used instead.  This is 1000 by default.
 657
 658 3. The \"date element\".  This date says when the last time this score
 659    entry matched, which provides a mechanism for expiring the
 660    score entries.  It this element is not present, the score
 661    entry is permanent.  The date is represented by the number of
 662    days since December 31, 1 ce.
 663
 664 4. The \"type element\".  This element specifies what function should
 665    be used to see whether this score entry matches the article.
 666
 667    There are the regexp, as well as substring types, and exact match,
 668    and word match types.  If this element is not present, Gnus will
 669    assume that substring matching should be used.  There is case
 670    sensitive variants of all match types.")))
 671     (widget-put widget :args `(,item
 672                                (repeat :inline t
 673                                        :indent 0
 674                                        :tag ,tag
 675                                        :doc ,doc
 676                                        :format "%t:\n%h%v%i\n\n"
 677                                        (choice :format "%v"
 678                                                :value ("" nil nil s)
 679                                                ,group
 680                                                sexp)))))
 681   widget)
 682
 683 (define-widget 'gnus-score-integer 'group
 684   "Edit score entries for integer-valued headers."
 685   :convert-widget 'gnus-score-integer-convert)
 686
 687 (defun gnus-score-integer-convert (widget)
 688   ;; Set args appropriately.
 689   (let* ((tag (widget-get widget :tag))
 690          (item `(const :format "" :value ,(downcase tag)))
 691          (match '(integer :tag "Match"))
 692          (score '(choice :tag "Score"
 693                          (const :tag "default" nil)
 694                          (integer :format "%v"
 695                                   :hide-front-space t)))
 696          (expire '(choice :tag "Expire"
 697                           (const :tag "off" nil)
 698                           (integer :format "%v"
 699                                    :hide-front-space t)))
 700          (type '(choice :tag "Type"
 701                         :value <
 702                         (const <)
 703                         (const >)
 704                         (const =)
 705                         (const >=)
 706                         (const <=)))
 707          (group `(group ,match ,score ,expire ,type))
 708          (doc (concat (or (widget-get widget :doc)
 709                           (concat "Change score based on the " tag
 710                                   " header.")))))
 711     (widget-put widget :args `(,item
 712                                (repeat :inline t
 713                                        :indent 0
 714                                        :tag ,tag
 715                                        :doc ,doc
 716                                        :format "%t:\n%h%v%i\n\n"
 717                                        ,group))))
 718   widget)
 719
 720 (define-widget 'gnus-score-date 'group
 721   "Edit score entries for date-valued headers."
 722   :convert-widget 'gnus-score-date-convert)
 723
 724 (defun gnus-score-date-convert (widget)
 725   ;; Set args appropriately.
 726   (let* ((tag (widget-get widget :tag))
 727          (item `(const :format "" :value ,(downcase tag)))
 728          (match '(string :tag "Match"))
 729          (score '(choice :tag "Score"
 730                          (const :tag "default" nil)
 731                          (integer :format "%v"
 732                                   :hide-front-space t)))
 733          (expire '(choice :tag "Expire"
 734                           (const :tag "off" nil)
 735                           (integer :format "%v"
 736                                    :hide-front-space t)))
 737          (type '(choice :tag "Type"
 738                         :value regexp
 739                         (const regexp)
 740                         (const before)
 741                         (const at)
 742                         (const after)))
 743          (group `(group ,match ,score ,expire ,type))
 744          (doc (concat (or (widget-get widget :doc)
 745                           (concat "Change score based on the " tag
 746                                   " header."))
 747                       "
 748 For the Date header we have three kinda silly match types: `before',
 749 `at' and `after'.  I can't really imagine this ever being useful, but,
 750 like, it would feel kinda silly not to provide this function.  Just in
 751 case.  You never know.  Better safe than sorry.  Once burnt, twice
 752 shy.  Don't judge a book by its cover.  Never not have sex on a first
 753 date.  (I have been told that at least one person, and I quote,
 754 \"found this function indispensable\", however.)
 755
 756 A more useful match type is `regexp'.  With it, you can match the date
 757 string using a regular expression.  The date is normalized to ISO8601
 758 compact format first---`YYYYMMDDTHHMMSS'.  If you want to match all
 759 articles that have been posted on April 1st in every year, you could
 760 use `....0401.........' as a match string, for instance.  (Note that
 761 the date is kept in its original time zone, so this will match
 762 articles that were posted when it was April 1st where the article was
 763 posted from.  Time zones are such wholesome fun for the whole family,
 764 eh?")))
 765     (widget-put widget :args `(,item
 766                                (repeat :inline t
 767                                        :indent 0
 768                                        :tag ,tag
 769                                        :doc ,doc
 770                                        :format "%t:\n%h%v%i\n\n"
 771                                        ,group))))
 772   widget)
 773
 774 (defvar gnus-custom-scores)
 775 (defvar gnus-custom-score-alist)
 776
 777 (defun gnus-score-customize (file)
 778   "Customize score file FILE.
 779 When called interactively, FILE defaults to the current score file.
 780 This can be changed using the `\\[gnus-score-change-score-file]' command."
 781   (interactive (list gnus-current-score-file))
 782   (unless file
 783     (error "No score file for %s"
 784            (gnus-group-decoded-name gnus-newsgroup-name)))
 785   (let ((scores (gnus-score-load file))
 786         (types (mapcar (lambda (entry)
 787                          `(group :format "%v%h\n"
 788                                  :doc ,(nth 2 entry)
 789                                  (const :format "" ,(nth 0 entry))
 790                                  ,(nth 1 entry)))
 791                        gnus-score-parameters)))
 792     ;; Ready.
 793     (kill-buffer (gnus-get-buffer-create "*Gnus Customize*"))
 794     (switch-to-buffer (gnus-get-buffer-create "*Gnus Customize*"))
 795     (gnus-custom-mode)
 796     (make-local-variable 'gnus-custom-score-alist)
 797     (setq gnus-custom-score-alist scores)
 798     (widget-insert "Customize the ")
 799     (widget-create 'info-link
 800                    :help-echo "Push me to learn more."
 801                    :tag "score entries"
 802                    "(gnus)Score File Format")
 803     (widget-insert " for\n\t")
 804     (widget-insert file)
 805     (widget-insert "\nand press ")
 806     (widget-create 'push-button
 807                    :tag "done"
 808                    :help-echo "Push me when done customizing."
 809                    :action 'gnus-score-customize-done)
 810     (widget-insert ".\n
 811 Check the [ ] for the entries you want to apply to this score file, then
 812 edit the value to suit your taste.  Don't forget to mark the checkbox,
 813 if you do all your changes will be lost.  ")
 814     (widget-create 'push-button
 815                    :action (lambda (&rest ignore)
 816                              (require 'gnus-audio)
 817                              (gnus-audio-play "Evil_Laugh.au"))
 818                    "Bhahahah!")
 819     (widget-insert "\n\n")
 820     (make-local-variable 'gnus-custom-scores)
 821     (setq gnus-custom-scores
 822           (widget-create 'group
 823                          :value scores
 824                          `(checklist :inline t
 825                                      :greedy t
 826                                      (gnus-score-string :tag "From")
 827                                      (gnus-score-string :tag "Subject")
 828                                      (gnus-score-string :tag "References")
 829                                      (gnus-score-string :tag "Xref")
 830                                      (gnus-score-string :tag "Extra")
 831                                      (gnus-score-string :tag "Message-ID")
 832                                      (gnus-score-integer :tag "Lines")
 833                                      (gnus-score-integer :tag "Chars")
 834                                      (gnus-score-date :tag "Date")
 835                                      (gnus-score-string :tag "Head"
 836                                                         :doc "\
 837 Match all headers in the article.
 838
 839 Using one of `Head', `Body', `All' will slow down scoring considerable.
 840 ")
 841                                      (gnus-score-string :tag "Body"
 842                                                         :doc "\
 843 Match the body sans header of the article.
 844
 845 Using one of `Head', `Body', `All' will slow down scoring considerable.
 846 ")
 847                                      (gnus-score-string :tag "All"
 848                                                         :doc "\
 849 Match the entire article, including both headers and body.
 850
 851 Using one of `Head', `Body', `All' will slow down scoring
 852 considerable.
 853 ")
 854                                      (gnus-score-string :tag
 855                                                         "Followup"
 856                                                         :doc "\
 857 Score all followups to the specified authors.
 858
 859 This entry is somewhat special, in that it will match the `From:'
 860 header, and affect the score of not only the matching articles, but
 861 also all followups to the matching articles.  This allows you
 862 e.g. increase the score of followups to your own articles, or decrease
 863 the score of followups to the articles of some known trouble-maker.
 864 ")
 865                                      (gnus-score-string :tag "Thread"
 866                                                         :doc "\
 867 Add a score entry on all articles that are part of a thread.
 868
 869 This match key works along the same lines as the `Followup' match key.
 870 If you say that you want to score on a (sub-)thread that is started by
 871 an article with a `Message-ID' X, then you add a `thread' match.  This
 872 will add a new `thread' match for each article that has X in its
 873 `References' header.  (These new `thread' matches will use the
 874 `Message-ID's of these matching articles.)  This will ensure that you
 875 can raise/lower the score of an entire thread, even though some
 876 articles in the thread may not have complete `References' headers.
 877 Note that using this may lead to undeterministic scores of the
 878 articles in the thread.
 879 ")
 880                                      ,@types)
 881                          '(repeat :inline t
 882                                   :tag "Unknown entries"
 883                                   sexp)))
 884     (use-local-map gnus-custom-map)
 885     (widget-setup)))
 886
 887 (defun gnus-score-customize-done (&rest ignore)
 888   "Reset the score alist with the present value."
 889   (let ((alist gnus-custom-score-alist)
 890         (value (widget-value gnus-custom-scores)))
 891     (setcar alist (car value))
 892     (setcdr alist (cdr value))
 893     (gnus-score-set 'touched '(t) alist))
 894   (bury-buffer))
 895
 896 (eval-when-compile
 897   (defvar category-fields nil)
 898   (defvar gnus-agent-cat-name)
 899   (defvar gnus-agent-cat-score-file)
 900   (defvar gnus-agent-cat-length-when-short)
 901   (defvar gnus-agent-cat-length-when-long)
 902   (defvar gnus-agent-cat-low-score)
 903   (defvar gnus-agent-cat-high-score)
 904   (defvar gnus-agent-cat-enable-expiration)
 905   (defvar gnus-agent-cat-days-until-old)
 906   (defvar gnus-agent-cat-predicate)
 907   (defvar gnus-agent-cat-groups)
 908   (defvar gnus-agent-cat-enable-undownloaded-faces)
 909 )
 910
 911 (defun gnus-trim-whitespace (s)
 912   (when (string-match "\\`[ \n\t]+" s)
 913     (setq s (substring s (match-end 0))))
 914   (when (string-match "[ \n\t]+\\'" s)
 915     (setq s (substring s 0 (match-beginning 0))))
 916   s)
 917
 918 (defmacro gnus-agent-cat-prepare-category-field (parameter)
 919   (let* ((entry (assq parameter gnus-agent-parameters))
 920          (field (nth 3 entry)))
 921     `(let* ((type (copy-sequence
 922                    (nth 1 (assq ',parameter gnus-agent-parameters))))
 923             (val (,field info))
 924             (deflt (if (,field defaults)
 925                        (concat " [" (gnus-trim-whitespace
 926                                      (gnus-pp-to-string (,field defaults)))
 927                                "]")))
 928             symb)
 929
 930        (if (eq (car type) 'radio)
 931            (let* ((rtype (nreverse type))
 932                   (rt rtype))
 933              (while (listp (or (cadr rt) 'not-list))
 934                (setq rt (cdr rt)))
 935
 936              (setcdr rt (cons '(const :format "Inherit " nil) (cdr rt)))
 937              (setq type (nreverse rtype))))
 938
 939        (if deflt
 940            (let ((tag (cdr (memq :tag type))))
 941              (when (string-match "\n" deflt)
 942                (while (progn (setq deflt (replace-match "\n " t t
 943                                                         deflt))
 944                              (string-match "\n" deflt (match-end 0))))
 945                (setq deflt (concat "\n" deflt)))
 946
 947              (setcar tag (concat (car tag) deflt))))
 948
 949        (widget-insert "\n")
 950
 951        (setq val (if val
 952                      (widget-create type :value val)
 953                    (widget-create type))
 954              symb (set (make-local-variable ',field) val))
 955
 956        (widget-put symb :default val)
 957        (widget-put symb :accessor ',field)
 958        (push symb category-fields))))
 959
 960 (defun gnus-agent-customize-category (category)
 961   "Edit the CATEGORY."
 962   (interactive (list (gnus-category-name)))
 963   (let ((info (assq category gnus-category-alist))
 964         (defaults (list nil '(agent-predicate . false)
 965                         (cons 'agent-enable-expiration
 966                               gnus-agent-enable-expiration)
 967                         '(agent-days-until-old . 7)
 968                         (cons 'agent-length-when-short
 969                               gnus-agent-short-article)
 970                         (cons 'agent-length-when-long gnus-agent-long-article)
 971                         (cons 'agent-low-score gnus-agent-low-score)
 972                         (cons 'agent-high-score gnus-agent-high-score))))
 973
 974     (let ((old (get-buffer "*Gnus Agent Category Customize*")))
 975       (when old
 976         (gnus-kill-buffer old)))
 977     (switch-to-buffer (gnus-get-buffer-create
 978                        "*Gnus Agent Category Customize*"))
 979
 980     (let ((inhibit-read-only t))
 981       (gnus-custom-mode)
 982       (buffer-disable-undo)
 983
 984       (let* ((name (gnus-agent-cat-name info)))
 985         (widget-insert "Customize the Agent Category '")
 986         (widget-insert (symbol-name name))
 987         (widget-insert "' and press ")
 988         (widget-create
 989          'push-button
 990          :notify
 991          '(lambda (&rest ignore)
 992             (let* ((info (assq gnus-agent-cat-name gnus-category-alist))
 993                    (widgets category-fields))
 994               (while widgets
 995                 (let* ((widget (pop widgets))
 996                        (value (condition-case nil (widget-value widget) (error))))
 997                   (eval `(setf (,(widget-get widget :accessor) ',info)
 998                                ',value)))))
 999             (gnus-category-write)
1000             (gnus-kill-buffer (current-buffer))
1001             (when (get-buffer gnus-category-buffer)
1002               (switch-to-buffer (get-buffer gnus-category-buffer))
1003               (gnus-category-list)))
1004                        "Done")
1005         (widget-insert
1006          "\n    Note: Empty fields default to the customizable global\
1007  variables.\n\n")
1008
1009         (set (make-local-variable 'gnus-agent-cat-name)
1010              name))
1011
1012       (set (make-local-variable 'category-fields) nil)
1013       (gnus-agent-cat-prepare-category-field agent-predicate)
1014
1015       (gnus-agent-cat-prepare-category-field agent-score)
1016       (gnus-agent-cat-prepare-category-field agent-short-article)
1017       (gnus-agent-cat-prepare-category-field agent-long-article)
1018       (gnus-agent-cat-prepare-category-field agent-low-score)
1019       (gnus-agent-cat-prepare-category-field agent-high-score)
1020
1021       ;; The group list is NOT handled with
1022       ;; gnus-agent-cat-prepare-category-field as I don't want the
1023       ;; group list to appear when customizing a topic.
1024       (widget-insert "\n")
1025
1026       (let ((symb
1027              (set
1028               (make-local-variable 'gnus-agent-cat-groups)
1029               (widget-create
1030                `(choice
1031                  :format "%[Select Member Groups%]\n%v" :value ignore
1032                  (const :menu-tag "do not change" :tag "" :value ignore)
1033                  (checklist :entry-format "%b %v"
1034                             :menu-tag "display group selectors"
1035                             :greedy t
1036                             :value
1037                             ,(delq nil
1038                                    (mapcar
1039                                     (lambda (newsrc)
1040                                       (car (member
1041                                             (gnus-info-group newsrc)
1042                                             (gnus-agent-cat-groups info))))
1043                                     (cdr gnus-newsrc-alist)))
1044                             ,@(mapcar (lambda (newsrc)
1045                                         `(const ,(gnus-info-group newsrc)))
1046                                       (cdr gnus-newsrc-alist))))))))
1047
1048       (widget-put symb :default (gnus-agent-cat-groups info))
1049       (widget-put symb :accessor 'gnus-agent-cat-groups)
1050       (push symb category-fields))
1051
1052       (widget-insert "\nExpiration Settings ")
1053
1054       (gnus-agent-cat-prepare-category-field agent-enable-expiration)
1055       (gnus-agent-cat-prepare-category-field agent-days-until-old)
1056
1057       (widget-insert "\nVisual Settings ")
1058
1059       (gnus-agent-cat-prepare-category-field agent-enable-undownloaded-faces)
1060
1061       (use-local-map gnus-custom-map)
1062       (widget-setup)
1063       (buffer-enable-undo))))
1064
1065 ;;; The End:
1066
1067 (provide 'gnus-cus)
1068
1069 ;;; arch-tag: a37c285a-49bc-4235-8244-804536effeaf
1070 ;;; gnus-cus.el ends here