Limnoria/plugins/RSS/config.py

114 lines
5.7 KiB
Python
Raw Normal View History

2005-02-02 07:03:09 +01:00
###
# Copyright (c) 2005, Jeremiah Fincher
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions, and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions, and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the author of this software nor the name of
# contributors to this software may be used to endorse or promote products
# derived from this software without specific prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
###
import supybot.conf as conf
import supybot.registry as registry
import supybot.callbacks as callbacks
from supybot.i18n import PluginInternationalization, internationalizeDocstring
_ = PluginInternationalization('RSS')
2005-02-02 07:03:09 +01:00
def configure(advanced):
# This will be called by supybot to configure this module. advanced is
# a bool that specifies whether the user identified himself as an advanced
# user or not. You should effect your configuration by manipulating the
# registry as appropriate.
from supybot.questions import expect, anything, something, yn
conf.registerPlugin('RSS', True)
class FeedNames(registry.SpaceSeparatedListOfStrings):
2005-02-02 07:03:09 +01:00
List = callbacks.CanonicalNameSet
class FeedItemSortOrder(registry.OnlySomeStrings):
"""Valid values include 'asInFeed', 'oldestFirst', 'newestFirst'."""
validStrings = ('asInFeed', 'oldestFirst', 'newestFirst')
2005-02-02 07:03:09 +01:00
RSS = conf.registerPlugin('RSS')
conf.registerChannelValue(RSS, 'bold', registry.Boolean(
True, _("""Determines whether the bot will bold the title of the feed when
it announces new news.""")))
2005-02-02 07:03:09 +01:00
conf.registerChannelValue(RSS, 'headlineSeparator',
registry.StringSurroundedBySpaces(' || ', _("""Determines what string is
used to separate headlines in new feeds.""")))
2005-02-02 07:03:09 +01:00
conf.registerChannelValue(RSS, 'announcementPrefix',
registry.StringWithSpaceOnRight(_('New news from '), _("""Determines what
prefix is prepended (if any) to the new news item announcements made in the
channel.""")))
conf.registerChannelValue(RSS, 'announcementSeparator',
registry.StringWithSpaceOnRight(_(': '), _("""Determines what
suffix is appended to the feed name in a news item.""")))
2005-02-02 07:03:09 +01:00
conf.registerChannelValue(RSS, 'announce',
registry.SpaceSeparatedSetOfStrings([], _("""Determines which RSS feeds
should be announced in the channel; valid input is a list of strings
(either registered RSS feeds or RSS feed URLs) separated by spaces.""")))
2005-02-02 07:03:09 +01:00
conf.registerGlobalValue(RSS, 'waitPeriod',
registry.PositiveInteger(1800, _("""Indicates how many seconds the bot will
2005-02-02 07:03:09 +01:00
wait between retrieving RSS feeds; requests made within this period will
return cached results.""")))
conf.registerGlobalValue(RSS, 'sortFeedItems',
FeedItemSortOrder('asInFeed', _("""Determines whether feed items should be
sorted by their update timestamp or kept in the same order as they appear
in a feed.""")))
2005-02-02 07:03:09 +01:00
conf.registerGlobalValue(RSS, 'feeds',
FeedNames([], _("""Determines what feeds should be accessible as
commands.""")))
2005-02-02 07:03:09 +01:00
conf.registerChannelValue(RSS, 'showLinks',
registry.Boolean(False, _("""Determines whether the bot will list the link
2005-02-02 07:03:09 +01:00
along with the title of the feed when the rss command is called.
supybot.plugins.RSS.announce.showLinks affects whether links will be
listed when a feed is automatically announced.""")))
conf.registerGlobalValue(RSS, 'defaultNumberOfHeadlines',
2012-07-31 21:09:18 +02:00
registry.PositiveInteger(1, _("""Indicates how many headlines an rss feed
will output by default, if no number is provided.""")))
conf.registerChannelValue(RSS, 'initialAnnounceHeadlines',
2012-07-31 21:09:18 +02:00
registry.PositiveInteger(5, _("""Indicates how many headlines an rss feed
will output when it is first added to announce for a channel.""")))
conf.registerChannelValue(RSS, 'keywordWhitelist',
2012-07-31 21:09:18 +02:00
registry.SpaceSeparatedSetOfStrings([], _("""Space separated list of
strings, lets you filter headlines to those containing one or more items
2012-07-31 21:09:18 +02:00
in this whitelist.""")))
conf.registerChannelValue(RSS, 'keywordBlacklist',
2012-07-31 21:09:18 +02:00
registry.SpaceSeparatedSetOfStrings([], _("""Space separated list of
strings, lets you filter headlines to those not containing any items
2012-07-31 21:09:18 +02:00
in this blacklist.""")))
2005-02-02 07:03:09 +01:00
conf.registerGroup(RSS, 'announce')
conf.registerChannelValue(RSS.announce, 'showLinks',
registry.Boolean(False, _("""Determines whether the bot will list the link
2005-02-02 07:03:09 +01:00
along with the title of the feed when a feed is automatically
announced.""")))
2005-02-02 07:03:09 +01:00
conf.registerGlobalValue(RSS.announce, 'cachePeriod',
registry.PositiveInteger(86400, """Maximum age of cached RSS headlines,
in seconds. Headline cache is used to avoid re-announcing old news."""))
2005-02-02 07:03:09 +01:00
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: