spam.el proposed group parameters

[Ted Zlatanov <tzz@lifelogs.com>]

I'd like to add the following group parameters to gnus.el, but I have
very little knowledge of the accepted practices for group parameters.

Also, I'll have to define a 'spam' variable group and move all the
existing variables to it in spam.el, so ignore the "variable-group
nnmail-expire" piece for now.

The idea is that these group parameters will work in parallel with the
regular spam.el variables.  But I'm not sure if I should let the
system-wide variables override the group parameters or vice versa.

For instance, say a user enabled spam-process-with-ifile for a group,
but also has spam-use-ifile set to nil.  What's the accepted Gnus
behavior in this case?  Am I approaching the problem the wrong way?
Should I eliminate the system-wide variables and only use group
parameters?

The existing examples of gnus-define-group-parameter didn't show the
code I needed, and I'm not sure how to use that function.  I would
like to use choices instead of simple booleans, so for instance
spam-process-with-ifile and spam-process-with-bogofilter would just be
two choices in the list spam-process-backends, and the group type
would be 'ham or 'spam.  That would be better than booleans, I think.
So how do I use gnus-define-group-parameter to define a list of
symbolic tags, and then later in other code check whether a tag is in
the current list?  Any help is greatly appreciated.

Thanks
Ted

------------------------------------------------------------------------

;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
(gnus-define-group-parameter
 spam
 :type bool
 :function gnus-group-spam-p
 :function-document
 "Check whether GROUP is designated as a spam group or not."
 :variable gnus-spam-newsgroups
 :variable-default nil
 :variable-document
 "*Groups in which to automatically mark new articles as spam on
summary entry.  If non-nil, this should be a regexp that should match
all groups in which to do automatic spam tagging.  This only makes
sense for mail groups."
 :variable-group nnmail-expire
 :variable-type '(choice (const nil)
		 regexp)
 :parameter-type '(const :tag "Group Contents Are Spam" t)
 :parameter-document
 "All articles that are unread will be marked as spam on summary entry.")

(gnus-define-group-parameter
 ham
 :type bool
 :function gnus-group-ham-p
 :function-document
 "Check whether GROUP is designated as a ham (non-spam) group or not."
 :variable gnus-ham-newsgroups
 :variable-default nil
 :variable-document
 "*Groups in which to automatically process new articles as ham
(non-spam) on summary exit.  If non-nil, this should be a regexp that
should match all groups in which to do automatic ham tagging.  This
only makes sense for mail groups."
 :variable-group nnmail-expire
 :variable-type '(choice (const nil)
		 regexp)
 :parameter-type '(const :tag "Group Contents Are Not Spam" t)
 :parameter-document
 "All articles that are not marked as spam will be processed as such at summary exit.")

(gnus-define-group-parameter
 spam-process
 :type bool
 :function gnus-group-spam-process-p
 :function-document
 "Check whether GROUP articles will be processed as spam at summary exit."
 :variable gnus-spam-process-newsgroups
 :variable-default t
 :variable-document
 "*Groups in which to automatically process spam articles on
summary exit.  If non-nil, this should be a regexp that should match
all groups in which to do automatic spam processing.  This only makes
sense for mail groups."
 :variable-group nnmail-expire
 :variable-type '(choice (const nil)
		 regexp)
 :parameter-type '(const :tag "Group Contents Are Processed As Spam" t)
 :parameter-document
 "Articles that are marked as spam will be processed on summary exit.")

(gnus-define-group-parameter
 spam-process-with-ifile
 :type bool
 :function gnus-group-spam-process-with-ifile-p
 :function-document
 "Check whether GROUP articles will be processed as spam with ifile at summary exit."
 :variable gnus-spam-process-with-ifile-newsgroups
 :variable-default nil
 :variable-document
 "*Groups in which to automatically process spam articles with ifile
on summary exit.  If non-nil, this should be a regexp that should
match all groups in which to do automatic spam processing with ifile.
This only makes sense for mail groups."
 :variable-group nnmail-expire
 :variable-type '(choice (const nil)
		 regexp)
 :parameter-type '(const :tag "Group Contents Are Processed As Spam With Ifile" t)
 :parameter-document
 "Articles that are marked as spam will be processed with ifile on summary exit.")

(gnus-define-group-parameter
 spam-process-with-bogofilter
 :type bool
 :function gnus-group-spam-process-with-bogofilter-p
 :function-document
 "Check whether GROUP articles will be processed as spam with bogofilter at summary exit."
 :variable gnus-spam-process-with-bogofilter-newsgroups
 :variable-default nil
 :variable-document
 "*Groups in which to automatically process spam articles with
bogofilter on summary exit.  If non-nil, this should be a regexp that
should match all groups in which to do automatic spam processing with
bogofilter.  This only makes sense for mail groups."
 :variable-group nnmail-expire
 :variable-type '(choice (const nil)
		 regexp)
 :parameter-type '(const :tag "Group Contents Are Processed As Spam With Bogofilter" t)
 :parameter-document
 "Articles that are marked as spam will be processed with bogofilter on summary exit.")

(gnus-define-group-parameter
 spam-process-with-blacklist
 :type bool
 :function gnus-group-spam-process-with-blacklist-p
 :function-document
 "Check whether GROUP articles will be processed as spam, adding senders to the blacklist at summary exit."
 :variable gnus-spam-process-with-blacklist-newsgroups
 :variable-default nil
 :variable-document
 "*Groups in which to automatically process spam articles, adding
senders to the blacklist on summary exit.  If non-nil, this should be
a regexp that should match all groups in which to do automatic spam
processing with the blacklist.  This only makes sense for mail
groups."
 :variable-group nnmail-expire
 :variable-type '(choice (const nil)
		 regexp)
 :parameter-type '(const :tag "Group Contents Are Processed As Spam With Blacklist" t)
 :parameter-document
 "Articles that are marked as spam will be processed with blacklist on summary exit.")

(gnus-define-group-parameter
 spam-process-ham-with-whitelist
 :type bool
 :function gnus-group-spam-process-ham-with-whitelist-p
 :function-document
 "Check whether GROUP articles will be processed as ham, adding senders to the whitelist at summary exit."
 :variable gnus-spam-process-ham-with-whitelist-newsgroups
 :variable-default nil
 :variable-document
 "*Groups in which to automatically process ham (non-spam) articles,
adding senders to the whitelist on summary exit.  If non-nil, this
should be a regexp that should match all groups in which to do
automatic ham processing with the whitelist.  This only makes sense
for mail groups."
 :variable-group nnmail-expire
 :variable-type '(choice (const nil)
		 regexp)
 :parameter-type '(const :tag "Group Contents Are Processed As Ham With Whitelist" t)
 :parameter-document
 "Ham (non-spam) articles will be processed with whitelist on summary exit.")

(gnus-define-group-parameter
 spam-process-ham-with-BBDB
 :type bool
 :function gnus-group-spam-process-ham-with-BBDB-p
 :function-document
 "Check whether GROUP articles will be processed as ham, adding senders to the BBDB at summary exit."
 :variable gnus-spam-process-ham-with-BBDB-newsgroups
 :variable-default nil
 :variable-document
 "*Groups in which to automatically process ham (non-spam) articles,
adding senders to the BBDB on summary exit.  If non-nil, this
should be a regexp that should match all groups in which to do
automatic ham processing with the BBDB.  This only makes sense
for mail groups."
 :variable-group nnmail-expire
 :variable-type '(choice (const nil)
		 regexp)
 :parameter-type '(const :tag "Group Contents Are Processed As Ham With BBDB" t)
 :parameter-document
 "Ham (non-spam) articles will be processed with BBDB on summary exit.")