mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-12-18 16:12:42 +01:00
2caade8f7c
* Change default separator to `|` as used by Topic plugin.
* Show links with manual calling and automatic announcement.
* In most of cases we want to know where does new RSS feed title point to...
127 lines
6.5 KiB
Python
127 lines
6.5 KiB
Python
###
|
|
# 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')
|
|
|
|
def configure(advanced):
|
|
# This will be called by supybot to configure this module. advanced is
|
|
# a bool that specifies whether the user identified themself 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):
|
|
List = callbacks.CanonicalNameSet
|
|
|
|
class FeedItemSortOrder(registry.OnlySomeStrings):
|
|
"""Valid values include 'asInFeed', 'oldestFirst', 'newestFirst'."""
|
|
validStrings = ('asInFeed', 'oldestFirst', 'newestFirst')
|
|
|
|
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 news.""")))
|
|
conf.registerChannelValue(RSS, 'headlineSeparator',
|
|
registry.StringSurroundedBySpaces('|', _("""Determines what string is
|
|
used to separate headlines in new feeds.""")))
|
|
conf.registerChannelValue(RSS, 'announcementPrefix',
|
|
registry.StringWithSpaceOnRight(_('News from '), _("""Determines what
|
|
prefix is prepended (if any) to the 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.""")))
|
|
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.""")))
|
|
conf.registerGlobalValue(RSS, 'waitPeriod',
|
|
registry.PositiveInteger(1800, _("""Indicates how many seconds the bot will
|
|
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.""")))
|
|
conf.registerGlobalValue(RSS, 'stripRedirect', registry.Boolean(
|
|
True, """Determines whether the bot will attempt to strip url redirection
|
|
from headline links, by taking things after the last http://."""))
|
|
|
|
conf.registerGlobalValue(RSS, 'feeds',
|
|
FeedNames([], _("""Determines what feeds should be accessible as
|
|
commands.""")))
|
|
conf.registerChannelValue(RSS, 'showLinks',
|
|
registry.Boolean(True, _("""Determines whether the bot will list the link
|
|
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.registerChannelValue(RSS, 'showPubDate',
|
|
registry.Boolean(False, """Determines whether the bot will list the
|
|
publication datetime stamp along with the title of the feed when the rss
|
|
command is called.
|
|
supybot.plugins.RSS.announce.showPubDate affects whether this will be
|
|
listed when a feed is automatically announced."""))
|
|
conf.registerGlobalValue(RSS, 'defaultNumberOfHeadlines',
|
|
registry.PositiveInteger(1, _("""Indicates how many headlines an rss feed
|
|
will output by default, if no number is provided.""")))
|
|
conf.registerChannelValue(RSS, 'initialAnnounceHeadlines',
|
|
registry.Integer(5, _("""Indicates how many headlines an rss feed
|
|
will output when it is first added to announce for a channel.""")))
|
|
conf.registerChannelValue(RSS, 'keywordWhitelist',
|
|
registry.SpaceSeparatedSetOfStrings([], _("""Space separated list of
|
|
strings, lets you filter headlines to those containing one or more items
|
|
in this whitelist.""")))
|
|
conf.registerChannelValue(RSS, 'keywordBlacklist',
|
|
registry.SpaceSeparatedSetOfStrings([], _("""Space separated list of
|
|
strings, lets you filter headlines to those not containing any items
|
|
in this blacklist.""")))
|
|
|
|
conf.registerGroup(RSS, 'announce')
|
|
conf.registerChannelValue(RSS.announce, 'showLinks',
|
|
registry.Boolean(True, _("""Determines whether the bot will list the link
|
|
along with the title of the feed when a feed is automatically
|
|
announced.""")))
|
|
|
|
conf.registerChannelValue(RSS.announce, 'showPubDate',
|
|
registry.Boolean(False, """Determines whether the bot will list the
|
|
publication datetime stamp along with the title of the feed when a feed
|
|
is automatically announced."""))
|
|
conf.registerGlobalValue(RSS.announce, 'cachePeriod',
|
|
registry.PositiveInteger(604800, """Maximum age of cached RSS headlines,
|
|
in seconds. Headline cache is used to avoid re-announcing old news."""))
|
|
|
|
|
|
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:
|