= YaRSS2 =

A RSS plugin for Deluge 1.3 configured through GTKUI

Current features:

 * RSS Feeds with individual update times.
 * Cookie support
 * Sending emails on torrent(s) added, with the list of torrents in the message.
 * Multiple (email message) notifications can be created and applied to different subscriptions.
 * Search using regex, one field for inclusion and one for exclusion. (Maybe some simpler search method should be added?)
 * "Move completed" and "add paused" options.


Features that hopefully will be implement:

 * Log window containing info on what is going on.
 * Label torrents automatically
 * Smart episodes filtering including history to avoid the same episodes being added multiple times.
 * Command line client
 * Better search, maybe a helper to create regex filters.

Tested with Deluge 1.3.4 on:
 * Windows XP
 * Ubuntu 11.04
 * FreeBSD 9 (daemon)


[https://github.com/bendikro/deluge-yarss-plugin/downloads Download] (Windows users need the download ending with ''py2.6.egg'')

[https://github.com/bendikro/deluge-yarss-plugin/tree/development Source]

[https://github.com/bendikro/deluge-yarss-plugin Changelog]

[http://dev.deluge-torrent.org/wiki/Plugins/YaRSS2 Ask for help in the forum thread]

== Getting started ==

=== RSS feed ===

Start by registering a RSS feed in the tab "RSS Feeds". Make sure the links link to torrent files, and not a new HTML page.
The "Update time" is how often this feed is checked. It depends how often the feeds are updated, but usually, between 60-120 should be good. The minimum value is 15 minutes, to avoid overloading the server.

=== Subscription ===
Subscriptions define the content you want to download from a RSS feed.
The search is regex based, which enables extremely powerful search expressions. However, it's not always straight forward to define right.

To help you verify the expression, the list of the current torrents in the RSS feed will show if the torrent matches, and which part of the title that matches

Regex hints:
||Regex||Comment||
||.||any character||
||*||zero or more of the previous expression||
||+||one or more of the previous expression||
||.*||zero or more of any character||
||\d||any number 0-9 (Only one character)||
||\d!{2}||Exactly two numbers||
||\d!{1,2}||One or two||
||(720p|1080p)|| '''720p''' or '''1080p'''||

Example 
 * Title1: "My Favourite Series some-random-characters.720p.GROUP"
 * Title2: "My.Favourite.Series.some-random-characters.1080p.GROUP"
 * Title3: "My.Favourite.Series.S1E04.1080p.GROUP"
 * Title4: "My.Favourite.Series.S1E1.1080p.GROUP"

||Regex||Comment||
||My Favourite Series|| Matches Title1||
||My.Favourite.Series|| Matches all||
||My.Favourite.Series.*720p|| Matches Title1||
||My.Favourite.Series.*(720p|1080p)|| Matches all||
||My.Favourite.Series.S01E\d!{2}*1080p|| Matches Title3 (as well as any episode 00-99)||
||My.Favourite.Series.S01E\d{1,2}.*1080p|| Matches Title3 and Title4||

=== Dealing with feeds that are missing a pubDate tag. ===

Some trackers publish RSS feeds that do not have the standard pubDate tag for each item that contains the timestamp of when the item was added to the feed.  Without this tag, YaRSS2 cannot process the feed, as it has no way of knowing a new item from an old one.  Most of these trackers DO include a timestamp somewhere in each item's entry, but if it's not in the pubDate tag, then YaRSS2 doesn't find it.  To solve this, you can contact the feed's publisher and request that they conform to the RSS standard and include the pubDate tag in their feed.  When they tell you to go pound sand, fear not.  There is a workaround that's fairly easy.  To add the pubDate tag into an existing RSS feed yourself, you can use a service from Yahoo called Pipes:

[http://pipes.yahoo.com/pipes/]

Yahoo has pretty good documentation for this tool, so you should be able to figure out the Pipes tool after a little experimenting.  Here's a general guideline of how to add the missing pubDate tag:

 * Open the RSS feed in a web browser and view the page's source. You'll see all the tags for each item. Identify the tag that contains the published date.
 * Create a Yahoo account and build a new pipe. String the following modules together in the following order.
 * Use the fetch feed module to read the source feed.
 * Then use the rename module to copy the tag containing the date into a new tag called pubDate.
 * You may need to use the regex module to strip all but the time and date out of your new pubDate tag.
 * Use the Create RSS module to map the tags to conform to RSS standard.
 * Save and run the pipe. Click on "get as RSS" and use the link it generates as your RSS source in YaRSS2.
 * Enjoy.  The feed now has a proper timestamp tag and should work.

Hopefully this will help some people get their favourite feeds working with YaRSS2.