RSS To Chat

From VuzeWiki
Jump to: navigation, search

The 'RSS To Chat' plugin supports automatic publishing of RSS feeds, or Vuze Subscriptions, to a Decentralized Chat Channel.

Configuration File Format

The plugin uses an XML configuration file to define the feed/subscription to chat channel mappings. It contains one of more <mapping> entries:

<config>
    <mapping>   // contains either an <rss> entry OR a <subscription> entry
        <rss>
            <url>RSS feed URL</url>
            [<dl_link_pattern>Regular Expression to extract links from descriptions</dl_link_pattern>]
            [<ignore_dates>boolean</ignore_dates>]
            [<minimum_seeds>integer</minimum_seeds>]
            [<minimum_leechers>integer</minimum_leechers>]
        </rss>
        <subscription>
            <name>subscription name</name>
            [<link_type>[hash|details_url|downloadurl]</link_type>]
            [<ignore_dates>boolean</ignore_dates>]
            [<minimum_seeds>integer</minimum_seeds>]
            [<minimum_leechers>integer</minimum_leechers>]
        </subscription>
        <presentation>      // optional, default is 'link' (since 0.3 / 5621_B37)
            <type>[website|link]</type>
            [<name>optional site name</name>]
            [<retain_sites>number of sites to retain</retain_sites>]
            [<retain_items>number of items to retain for the site</retain_items>]
        </presentation>
        <chat>
            <network>[public|anonymous]</network>
            <key>chat key</key>
            [<type>[normal|readonly|admin]</type>]
        </chat>
        <associations>     // optional
            <association>  // one or more
                <name>subscription name</name>
            </association>
        </associations>
        <refresh>Refresh frequency in minutes</refresh>
    <mapping>
</config>
<url>: An HTTP(S) link or, for a local file, a file URI - e.g.file:/c:/temp/test.xml. You can prefix HTTP(S) links with "tor:" to cause the feed to be fetched via Tor.
<type>: Defines the type of channel, default is 'normal'. If you want to prevent other people from sending messages to the chat channel then set its type to 'readonly'. See the chat documentation for more information - note that you will need to backup your channel keys in this case, otherwise if you lose the configuration for some reason you will not be able to recreate the same channel and will need to update all consumers to use a new one...
<associations>: Automatically associate torrents with subscriptions.

For example, to publish an RSS feed with URL "http://vhdn.vuze.com/vhdn/feed.php?id=126" to a public chat channel with key "My test chat channel" every hour you would use

<config>
    <mapping>
        <rss>
            <url>http://vhdn.vuze.com/vhdn/feed.php?id=126</url>
        </rss>
        <chat>
            <network>public</network>
            <key>My test chat channel</key>
            <type>readonly</type>
        </chat>
        <refresh>60</refresh>
    </mapping>
</config>

Examples

VHDN Favorite Feeds

Here is a read-only channel that acts as an index to a number of RSS Feeds from the 'Vuze HD Network'. Paste the URI into the Vuze search box and hit 'enter'.

chat:?Vuze%3A%20VHDN%5Bpk%3DATEW3FP37HXMKET74EOUIG66WUC3RSCRLAU57L2IAFY7OEGQ7CHGGG6AWQS66VT4ALOMCKTG4R3XO5I%26ro%3D1%5D

You can then double-click the individual feed links to access the content.

RSS Feed to Website

There is a test decentralized website feed generated using the following mapping:

	<mapping>
		<rss>
			<url>http://vhdn.vuze.com/vhdn/feed.php?id=55</url>
		</rss>
		<presentation>
			<type>website</type>
		</presentation>
		<chat>
			<network>public</network>
			<key>TED: Website</key>
			<type>readonly</type>
		</chat>
		<refresh>30</refresh>
	</mapping>

This generates a periodically refreshed website torrent that is published to this chat:

chat:?TED%3A%20Website%5Bpk%3DASW3JBOTGFTNNKINGU2FBFKLJOP7RDPSP6URZO6NAWLHDSK3LEGZLS7QJSWJWXK7RFOOJZGRVTWMDKQ%26ro%3D1%5D

You can download the latest website and simply double-click it in Vuze to view it in your default browser.

As a further example, the links below give separate public and anonymous access to a website generated entirely within Vuze by using a Tag to aggregate content and then publishing this as a local RSS feed and referencing that feed from the RSS to Chat plugin. Once done further content can be published by simply dragging it to the tag.

Anonymous website:

chat:anon:?Test%20Anonymous%20Website%3A%20Authored%20by%20Parg%5Bpk%3DAS6AARSDCO5BTJENRSJQUXDX3ICXCN5LRFSJAJLVCVNX3EPELPLCWCLKAJKPJ5FBXUW4HEV6ELUOTTA%26ro%3D1%5D

Public website:

chat:?Test%20Public%20Website%3A%20Authored%20by%20Parg%5Bpk%3DARB6Q4NPDIMAFCKCUW3FPPLCJZQNILZTV55WPZMCAIW3AGWBJNBWO457TOBDFVAKPP6GCS6PDR7OGPI%26ro%3D1%5D

Chat to RSS

You could then go ahead and create a local Subscription for this content by accessing the 'channel menu' (top left of the chat view) and selecting 'copy to clipboard->RSS URL' - paste this into the search box and hit 'enter' again. See Decentralized Chat RSS Feeds

Since 5621 there is an RSS button on the bottom right of the chat view that automates the above steps needed to create an RSS feed