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

   1 ;;; gnus-mlspl.el --- a group params-based mail splitting mechanism
   2 ;; Copyright (C) 1998,1999 Free Software Foundation, Inc.
   3
   4 ;; Author: Alexandre Oliva <oliva@dcc.unicamp.br>
   5 ;; Keywords: news, mail
   6
   7 ;; This program is free software; you can redistribute it and/or modify
   8 ;; it under the terms of the GNU General Public License as published by
   9 ;; the Free Software Foundation; either version 2, or (at your option)
  10 ;; any later version.
  11
  12 ;; This program is distributed in the hope that it will be useful,
  13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 ;; GNU General Public License for more details.
  16
  17 ;; You should have received a copy of the GNU General Public License
  18 ;; along with this program; see the file COPYING.  If not, write to
  19 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20 ;; Boston, MA 02111-1307, USA.
  21
  22 (require 'gnus)
  23 (require 'gnus-sum)
  24 (require 'gnus-group)
  25 (require 'nnmail)
  26
  27 (defvar gnus-group-split-updated-hook nil
  28   "Hook called just after nnmail-split-fancy is updated by
  29 gnus-group-split-update")
  30
  31 (defvar gnus-group-split-default-catch-all-group "mail.misc"
  32   "Group used by gnus-group-split and gnus-group-split-update as
  33 default catch-all group")
  34
  35 ;;;###autoload
  36 (defun gnus-group-split-setup (&optional auto-update catch-all)
  37   "Sets things up so that nnmail-split-fancy is used for mail
  38 splitting, and defines the variable nnmail-split-fancy according with
  39 group parameters.
  40
  41 if AUTO-UPDATE is non-nil (prefix argument accepted, if called
  42 interactive), makes sure nnmail-split-fancy is re-computed before
  43 getting new mail, by adding gnus-group-split-update to
  44 nnmail-pre-get-new-mail-hook."
  45   (interactive "P")
  46   (setq nnmail-split-methods 'nnmail-split-fancy)
  47   (when catch-all
  48     (setq gnus-group-split-default-catch-all-group catch-all))
  49   (gnus-group-split-update)
  50   (when auto-update
  51     (add-hook 'nnmail-pre-get-new-mail-hook 'gnus-group-split-update)))
  52
  53 ;;;###autoload
  54 (defun gnus-group-split-update (&optional catch-all)
  55   "Computes nnmail-split-fancy from group params, by calling
  56 \(gnus-group-split-fancy nil nil DEFAULTGROUP)"
  57   (interactive)
  58   (setq nnmail-split-fancy
  59         (gnus-group-split-fancy
  60          nil nil (or catch-all gnus-group-split-default-catch-all-group)))
  61   (run-hooks 'gnus-group-split-updated-hook)
  62   )
  63
  64 ;;;###autoload
  65 (defun gnus-group-split ()
  66   "Uses information from group parameters in order to split mail.  See
  67 gnus-group-split-fancy for more information.
  68
  69 If no group is defined as catch-all, the value of
  70 gnus-group-split-default-catch-all-group is used.
  71
  72 gnus-group-split is a valid value for nnmail-split-methods."
  73   (let (nnmail-split-fancy)
  74     (gnus-group-split-update
  75      gnus-group-split-default-catch-all-group)
  76     (nnmail-split-fancy)))
  77
  78 ;;;###autoload
  79 (defun gnus-group-split-fancy
  80   (&optional groups no-crosspost catch-all)
  81   "Uses information from group parameters in order to split mail.  It
  82 can be embedded into nnmail-split-fancy lists with the SPLIT
  83
  84 \(: gnus-group-split-fancy GROUPS NO-CROSSPOST CATCH-ALL\)
  85
  86 GROUPS may be a regular expression or a list of group names, that will
  87 be used to select candidate groups.  If it is ommited or nil, all
  88 existing groups are considered.
  89
  90 if NO-CROSSPOST is ommitted or nil, a & split will be returned,
  91 otherwise, a | split, that does not allow crossposting, will be
  92 returned.
  93
  94 if CATCH-ALL is not nil, and there is no selected group whose
  95 split-regexp matches the empty string, nor is there a selected group
  96 whose SPLIT-SPEC is 'catch-all, this group name will be appended to
  97 the returned SPLIT list, as the last element in a '| SPLIT.
  98
  99 For each selected group, a SPLIT is composed like this: if SPLIT-SPEC
 100 is specified, this split is returned as-is (unless it is nil: in this
 101 case, the group is ignored).  Otherwise, if TO-ADDRESS, TO-LIST and/or
 102 EXTRA-ALIASES are specified, a regexp that matches any of them is
 103 constructed (extra-aliases may be a list).  Additionally, if
 104 SPLIT-REGEXP is specified, the regexp will be extended so that it
 105 matches this regexp too, and if SPLIT-EXCLUDE is specified, RESTRICT
 106 clauses will be generated.
 107
 108 For example, given the following group parameters:
 109
 110 nnml:mail.bar:
 111 \((to-address . \"bar@femail.com\")
 112  (split-regexp . \".*@femail\\\\.com\"))
 113 nnml:mail.foo:
 114 \((to-list . \"foo@nowhere.gov\")
 115  (extra-aliases \"foo@localhost\" \"foo-redist@home\")
 116  (split-exclude \"bugs-foo\" \"rambling-foo\")
 117  (admin-address . \"foo-request@nowhere.gov\"))
 118 nnml:mail.others:
 119 \((split-spec . catch-all))
 120
 121 Calling (gnus-group-split-fancy nil nil \"mail.misc\") returns:
 122
 123 \(| (& (any \"\\\\(bar@femail\\\\.com\\\\|.*@femail\\\\.com\\\\)\"
 124            \"nnml:mail.bar\")
 125       (any \"\\\\(foo@nowhere\\\\.gov\\\\|foo@localhost\\\\|foo-redist@home\\\\)\"
 126            - \"bugs-foo\" - \"rambling-foo\" \"nnml:mail.foo\"))
 127    \"nnml:mail.others\")"
 128   (let* ((newsrc (cdr gnus-newsrc-alist))
 129          split)
 130     (dolist (info newsrc)
 131       (let ((group (gnus-info-group info))
 132             (params (gnus-info-params info)))
 133         ;; For all GROUPs that match the specified GROUPS
 134         (when (or (not groups)
 135                   (and (listp groups)
 136                        (memq group groups))
 137                   (and (stringp groups)
 138                        (string-match groups group)))
 139           (let ((split-spec (cdr (assoc 'split-spec params))) group-clean)
 140             ;; Remove backend from group name
 141             (setq group-clean (string-match ":" group))
 142             (setq group-clean
 143                   (if group-clean
 144                       (substring group (1+ group-clean))
 145                     group))
 146             (if split-spec
 147                 (if (eq split-spec 'catch-all)
 148                     ;; Emit catch-all only when requested
 149                     (when catch-all
 150                       (setq catch-all group-clean))
 151                   ;; Append split-spec to the main split
 152                   (push split-spec split))
 153               ;; Let's deduce split-spec from other params
 154               (let ((to-address (cdr (assoc 'to-address params)))
 155                     (to-list (cdr (assoc 'to-list params)))
 156                     (extra-aliases (cdr (assoc 'extra-aliases params)))
 157                     (split-regexp (cdr (assoc 'split-regexp params)))
 158                     (split-exclude (cdr (assoc 'split-exclude params))))
 159                 (when (or to-address to-list extra-aliases split-regexp)
 160                   ;; regexp-quote to-address, to-list and extra-aliases
 161                   ;; and add them all to split-regexp
 162                   (setq split-regexp
 163                         (concat
 164                          "\\("
 165                          (mapconcat
 166                           'identity
 167                           (append
 168                            (and to-address (list (regexp-quote to-address)))
 169                            (and to-list (list (regexp-quote to-list)))
 170                            (and extra-aliases
 171                                 (if (listp extra-aliases)
 172                                     (mapcar 'regexp-quote extra-aliases)
 173                                   (list extra-aliases)))
 174                            (and split-regexp (list split-regexp)))
 175                           "\\|")
 176                          "\\)"))
 177                   ;; Now create the new SPLIT
 178                   (push (append
 179                          (list 'any split-regexp)
 180                          ;; Generate RESTRICTs for SPLIT-EXCLUDEs.
 181                          (if (listp split-exclude)
 182                              (mapcon (lambda (arg) (cons '- arg))
 183                                      split-exclude)
 184                            (list '- split-exclude))
 185                          (list group-clean))
 186                         split)
 187                   ;; If it matches the empty string, it is a catch-all
 188                   (when (string-match split-regexp "")
 189                     (setq catch-all nil)))))))))
 190     ;; Add catch-all if not crossposting
 191     (if (and catch-all no-crosspost)
 192         (push split catch-all))
 193     ;; Move it to the tail, while arranging that SPLITs appear in the
 194     ;; same order as groups.
 195     (setq split (reverse split))
 196     ;; Decide whether to accept cross-postings or not.
 197     (push (if no-crosspost '| '&) split)
 198     ;; Even if we can cross-post, catch-all should not get
 199     ;; cross-posts.
 200     (if (and catch-all (not no-crosspost))
 201         (setq split (list '| split catch-all)))
 202     split))
 203
 204 (provide 'gnus-mlspl)