transmission-rss 0.0.7

data/README.rdoc

@@ -0,0 +1,56 @@
+= transmission-rss
+
+transmission-rss is basically a workaround for transmission's lack of the
+ability to monitor RSS feeds and automatically add enclosed torrent links.
+
+As it's done with poems, I devote this very artful and romantic piece of code to
+the single most delightful human being: Ann.
+
+== Installation
+
+=== Latest stable version from rubygems.org
+
+ gem install transmission-rss
+
+=== From source
+
+ gem build transmission-rss.gemspec
+ sudo gem install transmission-rss-*.gem
+
+== Configuration
+
+A yaml formatted config file is expected at +/etc/transmission-rss.conf+.
+
+=== Minimal example
+
+It should at least contain a list of feeds:
+
+ feeds:
+   - http://example.com/feed1
+   - http://example.com/feed2
+
+=== All available options
+
+The following configuration file example contains every existing option
+(although +rss_check_interval+, +paused+ and +server+ are default values
+and coult be omitted). The default +log_target+ is STDERR.
+
+ feeds:
+   - http://example.com/feed1
+   - http://example.com/feed2
+
+ rss_check_interval: 600
+
+ paused: false
+
+ server:
+   host: localhost
+   port: 9091
+
+ log_target: /var/log/transmissiond-rss.log
+
+== TODO
+
+* Timeout and error handling for aggregation and transmission communication
+* Drop privileges
+* Option to stop seeding after full download

data/bin/transmission-rss

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+
+require( 'getoptlong' )
+
+$:.unshift( File.join( File.dirname( __FILE__ ), '../lib' ) )
+require( 'transmission-rss' )
+
+include TransmissionRSS
+
+# Default config file path.
+configFile = '/etc/transmission-rss.conf'
+
+# Do not fork by default.
+dofork = false
+
+# Default not verbose.
+verbose = false
+
+# Shows a summary of the command line options.
+def usageMessage
+	$stderr << "#{File.basename( $0 )} [options]
+Adds torrents from rss feeds to transmission web frontend.
+
+  -c <file>   Custom config file path. Default: #{configFile}
+  -f          Fork into background after startup.
+  -h          This help.
+  -v          Verbose mode.
+
+"
+	exit( 1 )
+end
+
+# Define command-line options.
+options = GetoptLong.new(
+	[ '-c', GetoptLong::REQUIRED_ARGUMENT ],
+	[ '-f', GetoptLong::NO_ARGUMENT ],
+	[ '-h', GetoptLong::NO_ARGUMENT ],
+	[ '-v', GetoptLong::NO_ARGUMENT ]
+)
+
+# Parse given options.
+options.each do |option, argument|
+	case( option )
+		when '-c'
+			configFile = argument
+		when '-f'
+			dofork = true
+		when '-h'
+			usageMessage
+		when '-v'
+			verbose = true
+	end
+end
+
+# Seems to be necessary when called from gem installation.
+# Otherwise Config is somehow mixed up with RbConfig.
+config = TransmissionRSS::Config.instance
+
+# Default configuration.
+config.load( {
+	'feeds' => [],
+	'rss_check_interval' => 600,
+	'paused' => false,
+	'server' => {
+		'host' => 'localhost',
+		'port' => 9091
+	},
+	'log_target' => $stderr
+} )
+
+# Initialize a log instance, configure it and run the consumer in a subthread.
+log = Log.instance
+log.verbose = verbose
+log.target = config.log_target
+tLog = Thread.start do log.run end
+
+# Load config file (default or given by argument).
+config.load( configFile )
+log.add( config )
+
+# Connect reload of config file to SIGHUP.
+trap( 'HUP' ) do
+	config.load( configFile )
+	log.add( 'got hup', config )
+end
+
+# Initialize feed aggregator.
+aggregator = Aggregator.new
+
+# Initialize communication to transmission.
+client = Client.new( config.server.host, config.server.port )
+
+# Add feeds from config file to +Aggregator+ class.
+aggregator.feeds.concat( config.feeds )
+
+# Callback for a new item on one of the feeds.
+aggregator.on_new_item do |torrentFile|
+	Thread.start do
+		client.addTorrent( torrentFile, config.paused )
+	end
+end
+
+# Start the aggregation process.
+begin
+	if( dofork )
+		pid = fork do
+			aggregator.run( config.rss_check_interval )
+		end
+
+		puts( 'forked ' + pid.to_s )
+	else
+		aggregator.run( config.rss_check_interval )
+	end
+rescue Interrupt
+end

data/lib/transmission-rss.rb

@@ -0,0 +1,9 @@
+$:.unshift( File.dirname( __FILE__ ) )
+
+module TransmissionRSS
+	VERSION = '0.0.7'
+end
+
+Dir.glob( $:.first + '/**/*.rb' ).each do |file|
+	require( file )
+end

data/lib/transmission-rss/aggregator.rb

@@ -0,0 +1,107 @@
+require( 'etc' )
+require( 'fileutils' )
+require( 'open-uri' )
+require( 'rss' )
+
+# Class for aggregating torrent files through RSS feeds.
+class TransmissionRSS::Aggregator
+	attr_accessor :feeds
+
+	def initialize( feeds = [] )
+		@feeds = feeds
+		@seen = []
+
+		# Initialize log instance.
+		@log = Log.instance
+
+		# Declare callback for new items.
+		callback( :on_new_item )
+
+		# Generate path for seen torrents store file.
+		@seenfile = File.join(
+			Etc.getpwuid.dir,
+			'/.config/transmission/seen-torrents.conf'
+		)
+
+		# Make directories in path if they are not existing.
+		FileUtils.mkdir_p( File.dirname( @seenfile ) )
+
+		# Touch seen torrents store file.
+		if( not File.exists?( @seenfile ) )
+			FileUtils.touch( @seenfile )
+		end
+
+		# Open file, read torrent URLs and add to +@seen+.
+		open( @seenfile ).readlines.each do |line|
+			@seen.push( line.chomp )
+			@log.add( 'from seenfile ' + line.chomp )
+		end
+	end
+
+	# Get file enclosures from all feeds items and call on_new_item callback
+	# with torrent file URL as argument.
+	def run( interval = 600 )
+		@log.add( 'aggregator start' )
+
+		while( true )
+			feeds.each do |url|
+				@log.add( 'aggregate ' + url )
+
+				begin
+					content = open( url ).readlines.join( "\n" )
+					items = RSS::Parser.parse( content, false ).items
+				rescue
+					@log.add( 'retrieval error' )
+					next
+				end
+
+				items.each do |item|
+					item.links.each do |link|
+						link = link.href
+
+						if( not seen?( link ) )
+							on_new_item( link )
+							@log.add( 'on_new_item event ' + link )
+
+							add_seen( link )
+#						else
+#							@log.add( 'already seen ' + link )
+						end
+					end
+				end
+			end
+
+			sleep( interval )
+		end
+	end
+
+	# To add a link into the list of seen links.
+	def add_seen( link )
+		@seen.push( link )
+
+		File.open( @seenfile, 'w' ) do |file|
+			file.write( @seen.join( "\n" ) )
+		end
+	end
+
+	# To test if a link is in the list of seen links.
+	def seen?( link )
+		@seen.include?( link )
+	end
+
+	# Method to define callback methods.
+	def callback( *names )
+		names.each do |name|
+			eval <<-EOF
+				@#{name} = false
+				def #{name}( *args, &block )
+					if( block )
+						@#{name} = block
+					elsif( @#{name} )
+						@#{name}.call( *args )
+					end
+				end
+			EOF
+		end
+	end
+end

data/lib/transmission-rss/client.rb

@@ -0,0 +1,92 @@
+require( 'net/http' )
+require( 'json' )
+require( 'timeout' )
+
+# TODO
+#  * Why the hell do timeouts in getSessionID and addTorrent not work?!
+
+# Class for communication with transmission utilizing the RPC web interface.
+class TransmissionRSS::Client
+	def initialize( host, port )
+		@host = host
+		@port = port
+
+		@log = Log.instance
+	end
+
+	# Get transmission session id by simple GET.
+	def getSessionID
+		@log.add( 'getSessionID called' )
+
+		get = Net::HTTP::Get.new(
+			'/transmission/rpc'
+		)
+
+#		retries = 3
+#		begin
+#			Timeout::timeout( 5 ) do
+				response = Net::HTTP.new( @host, @port ).start do |http|
+					http.request( get )
+				end
+#			end
+#		rescue Timeout::Error
+#			puts( 'timeout error exception' ) if( $verbose )
+#			if( retries > 0 )
+#				retries -= 1
+#				puts( 'getSessionID timeout. retry..' ) if( $verbose )
+#				retry
+#			else
+#				$stderr << "timeout http://#{@host}:#{@port}/transmission/rpc"
+#			end
+#		end
+
+		id = response.header['x-transmission-session-id']
+
+		@log.add( 'got session id ' + id )
+
+		id
+	end
+
+	# POST json packed torrent add command.
+	def addTorrent( torrentFile, paused = false )
+		@log.add( 'addTorrent called' )
+
+		post = Net::HTTP::Post.new(
+			'/transmission/rpc',
+			initheader = {
+				'Content-Type' => 'application/json',
+				'X-Transmission-Session-Id' => getSessionID
+			}
+		)
+
+		post.body = {
+			"method" => "torrent-add",
+			"arguments" => {
+				"paused" => paused,
+				"filename" => torrentFile
+			}
+		}.to_json
+
+#		retries = 3
+#		begin
+#			Timeout::timeout( 5 ) do
+				response = Net::HTTP.new( @host, @port ).start do |http|
+					http.request( post )
+				end
+#			end
+#		rescue Timeout::Error
+#			puts( 'timeout error exception' ) if( $verbose )
+#			if( retries > 0 )
+#				retries -= 1
+#				puts( 'addTorrent timeout. retry..' ) if( $verbose )
+#				retry
+#			else
+#				$stderr << "timeout http://#{@host}:#{@port}/transmission/rpc"
+#			end
+#		end
+
+		result = JSON.parse( response.body ).result
+
+		@log.add( 'addTorrent result: ' + result )
+	end
+end

data/lib/transmission-rss/config.rb

@@ -0,0 +1,32 @@
+require( 'singleton' )
+require( 'yaml' )
+
+# Class handles configuration parameters.
+class TransmissionRSS::Config < Hash
+	# This is a singleton class.
+	include Singleton
+
+	# Merges a Hash or YAML file (containing a Hash) with itself.
+	def load( config )
+		if( config.class == Hash )
+			self.merge!( config )
+			return
+		end
+
+		if( not config.nil? )
+			self.merge_yaml!( config )
+		end
+	end
+
+	# Merge Config Hash with Hash in YAML file.
+	def merge_yaml!( path )
+		self.merge!( load_file( path ) )
+	end
+
+	# Load YAML file and work around tabs not working for identation.
+	def load_file( path )
+		YAML.load_stream(
+			File.new( path ).read.gsub( /\t/, ' ' )
+		).documents.first
+	end
+end

data/lib/transmission-rss/hash.rb

@@ -0,0 +1,12 @@
+class Hash
+	# If a method is missing it is interpreted as the key of the hash. If the
+	# method has an argument (for example by "method="), the key called "method"
+	# is set to the respective argument.
+	def method_missing( symbol, *args )
+		if( args.size == 0 )
+			self[ symbol.to_s ]
+		else
+			self[ symbol.to_s.slice( 0..-2 ) ] = args.first
+		end
+	end
+end

data/lib/transmission-rss/log.rb

@@ -0,0 +1,44 @@
+require( 'singleton' )
+
+class TransmissionRSS::Log
+	include Singleton
+
+	attr_accessor :target, :verbose
+	
+	def add( *args )
+		@buffer ||= []
+
+		# Add every arg to buffer.
+		args.each do |arg|
+			@buffer.push( arg.to_s )
+		end
+	end
+
+	def run
+		@target ||= $stderr
+		@buffer ||= []
+
+		# If verbose is not defined, it will be nil.
+		@verbose = (@verbose rescue nil)
+
+		# If +@target+ seems to be a file path, open the file and tranform
+		# +@target+ into an IO for the file.
+		if( @target.class != IO and @target.match( /(\/.*)+/ ) )
+			@target = File.open( @target, 'a' )
+			@target.sync = true
+
+			@verbose = true
+		end
+
+		# Loop, pop buffer and puts.
+		while( true )
+			line = @buffer.shift
+
+			if( @verbose and line )
+				@target.puts( line )
+			end
+
+			sleep( 0.5 )
+		end
+	end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: transmission-rss
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 7
+  version: 0.0.7
+platform: ruby
+authors: 
+- henning mueller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-22 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: |-
+  transmission-rss is basically a workaround for
+  		transmission's lack of the ability to monitor RSS feeds and
+  		automatically add enclosed torrent links. Devoted to Ann.
+email: henning@orgizm.net
+executables: 
+- transmission-rss
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/transmission-rss
+- lib/transmission-rss.rb
+- lib/transmission-rss/log.rb
+- lib/transmission-rss/aggregator.rb
+- lib/transmission-rss/config.rb
+- lib/transmission-rss/hash.rb
+- lib/transmission-rss/client.rb
+- README.rdoc
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Adds torrents from rss feeds to transmission web frontend.
+test_files: []
+