transmission-rss 0.1.3 → 0.1.5

data/README.rdoc

@@ -62,5 +62,4 @@ defined by default, so the script runs as current user/group.
 
 * Timeout and error handling in +Aggregator+ and +Client+
 * Option to stop seeding after full download
-* Privileges configurable by GUI
-* Log level
+* Configurable log level

data/bin/transmission-rss

@@ -1,63 +1,56 @@
 #!/usr/bin/env ruby
 
-require( 'getoptlong' )
-require( 'etc' )
+require 'getoptlong'
+require 'etc'
 
-$:.unshift( File.join( File.dirname( __FILE__ ), '../lib' ) )
-require( 'transmission-rss' )
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'transmission-rss'
 
 include TransmissionRSS
 
 # Default config file path.
-configFile = '/etc/transmission-rss.conf'
+config_file = '/etc/transmission-rss.conf'
 
 # Do not edit config file in Gtk GUI by default.
-editConfig = false
+edit_config = false
 
 # Do not fork by default.
 dofork = false
 
-# Default not verbose.
-verbose = false
-
 # Shows a summary of the command line options.
-def usageMessage( configFile )
-	$stderr << "#{File.basename( $0 )} [options]
+def usage_message( config_file )
+  $stderr << "#{File.basename($0)} [options]
 Adds torrents from rss feeds to transmission web frontend.
 
-  -c <file>   Custom config file path. Default: #{configFile}
+  -c <file>   Custom config file path. Default: #{config_file}
   -e          Edit config file with Gtk GUI.
   -f          Fork into background after startup.
   -h          This help.
-  -v          Verbose mode.
 
 "
-	exit( 1 )
+  exit(1)
 end
 
 # Define command-line options.
 options = GetoptLong.new(
-	[ '-c', GetoptLong::REQUIRED_ARGUMENT ],
-	[ '-e', GetoptLong::NO_ARGUMENT ],
-	[ '-f', GetoptLong::NO_ARGUMENT ],
-	[ '-h', GetoptLong::NO_ARGUMENT ],
-	[ '-v', GetoptLong::NO_ARGUMENT ]
+  [ '-c', GetoptLong::REQUIRED_ARGUMENT ],
+  [ '-e', GetoptLong::NO_ARGUMENT ],
+  [ '-f', GetoptLong::NO_ARGUMENT ],
+  [ '-h', GetoptLong::NO_ARGUMENT ]
 )
 
 # Parse given options.
 options.each do |option, argument|
-	case( option )
-		when '-c'
-			configFile = argument
-		when '-e'
-			editConfig = true
-		when '-f'
-			dofork = true
-		when '-h'
-			usageMessage( configFile )
-		when '-v'
-			verbose = true
-	end
+  case(option)
+    when '-c'
+      config_file = argument
+    when '-e'
+      edit_config = true
+    when '-f'
+      dofork = true
+    when '-h'
+      usage_message(config_file)
+  end
 end
 
 # Seems to be necessary when called from gem installation.
@@ -65,96 +58,107 @@ end
 config = TransmissionRSS::Config.instance
 
 # Default configuration.
-config.load( {
-	'feeds' => [],
-	'update_interval' => 600,
-	'add_paused' => false,
-	'server' => {
-		'host' => 'localhost',
-		'port' => 9091
-	},
-	'log_target' => $stderr,
-	'privileges' => {}
-} )
-
-# Initialize a log instance, configure it and run the consumer in a subthread.
+config.load({
+  'feeds' => [],
+  'update_interval' => 600,
+  'add_paused' => false,
+  'server' => {
+    'host' => 'localhost',
+    'port' => 9091
+  },
+  'log_target' => $stderr,
+  'privileges' => {}
+})
+
+# Initialize a log instance and configure it.
 log = Log.instance
-log.verbose = verbose
 log.target = config.log_target
-tLog = Thread.start do log.run end
+log.level = Logger::DEBUG
+log.formatter = proc do |sev, time, prog, msg|
+  "#{time.to_i}(#{sev.downcase}) #{msg}\n"
+end
 
 # Load config file (default or given by argument).
 begin
-	config.load( configFile )
+  config.load(config_file)
+  log.target = config.log_target
 rescue Errno::ENOENT
-	log.add( configFile + ' not found' )
+  log.error(config_file + ' not found')
 end
-log.add( config )
+log.debug(config)
 
 # Drop privileges, if section is given in config file.
-if( not config.privileges.empty? )
-	Process::Sys.setgid(
-		Etc.getgrnam( config.privileges.group ).gid
-	)
-
-	Process::Sys.setuid(
-		Etc.getpwnam( config.privileges.user ).uid
-	)
-
-	log.add(
-		'dropped privileges ' +
-		config.privileges.user +
-		':' +
-		config.privileges.group
-	)
+if(not config.privileges.empty?)
+  Process::Sys.setgid(
+    Etc.getgrnam(config.privileges.group).gid
+  )
+
+  Process::Sys.setuid(
+    Etc.getpwnam(config.privileges.user).uid
+  )
+
+  log.debug(
+    'dropped privileges ' +
+    config.privileges.user +
+    ':' +
+    config.privileges.group
+  )
 else
-	log.add( 'no privilege dropping' )
+  log.debug('no privilege dropping')
+end
+
+# Warn if no feeds are given.
+if(config.feeds.empty?)
+  log.warn('no feeds given')
 end
 
 # Start GUI if config edit option is given.
-if( editConfig )
-	require( 'transmission-rss/config-editor' )
+if(edit_config)
+  require 'transmission-rss/config-editor'
 
-	Gtk.init
+  Gtk.init
 
-	ConfigEditor.new( configFile, config )
-	Gtk.main
+  ConfigEditor.new(config_file, config)
+  Gtk.main
 
-	exit( 0 )
+  exit(0)
 end
 
 # Connect reload of config file to SIGHUP.
-trap( 'HUP' ) do
-	config.load( configFile )
-	log.add( 'got hup', config )
+trap('HUP') do
+  config.load(config_file)
+  log.info('got hup', config)
 end
 
 # Initialize feed aggregator.
 aggregator = Aggregator.new
 
 # Initialize communication to transmission.
-client = Client.new( config.server.host, config.server.port )
+client = Client.new(config.server.host, config.server.port)
 
 # Add feeds from config file to +Aggregator+ class.
-aggregator.feeds.concat( config.feeds )
+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.add_paused )
-	end
+  Thread.start do
+    client.addTorrent(torrentFile, config.add_paused)
+  end
 end
 
 # Start the aggregation process.
 begin
-	if( dofork )
-		pid = fork do
-			aggregator.run( config.update_interval )
-		end
-
-		puts( 'forked ' + pid.to_s )
-	else
-		aggregator.run( config.update_interval )
-	end
+  if(dofork)
+    pid = fork do
+      aggregator.run(config.update_interval)
+    end
+
+    puts('forked ' + pid.to_s)
+  else
+    aggregator.run(config.update_interval)
+  end
 rescue Interrupt
+  log.info('interrupt caught')
 end
+
+log.close

data/lib/transmission-rss.rb

@@ -1,7 +1,7 @@
-$:.unshift( File.dirname( __FILE__ ) )
+$:.unshift(File.dirname(__FILE__))
 
 module TransmissionRSS
-	VERSION = '0.1.3'
+	VERSION = '0.1.5'
 end
 
 dir = 'transmission-rss'
@@ -14,6 +14,6 @@ blacklist.map! do |name|
 	$:.first + '/' + dir + '/' + name + '.rb'
 end
 
-( Dir.glob( $:.first + '/' + dir + '/*.rb' ) - blacklist ).each do |lib|
-	require( lib )
+(Dir.glob($:.first + '/' + dir + '/*.rb') - blacklist).each do |lib|
+	require lib
 end

data/lib/transmission-rss/aggregator.rb

@@ -1,114 +1,116 @@
-require( 'etc' )
-require( 'fileutils' )
-require( 'open-uri' )
-require( 'rss' )
+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|
-					link = item.link
+  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)
+    end
+
+    # Log number of +@seen+ URIs.
+    @log.debug(@seen.size.to_s + ' uris from seenfile')
+  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.debug('aggregator start')
+
+    while(true)
+      feeds.each do |url|
+        @log.debug('aggregate ' + url)
+
+        begin
+          content = open(url).readlines.join("\n")
+          items = RSS::Parser.parse(content, false).items
+        rescue
+          @log.debug('retrieval error')
+          next
+        end
+
+        items.each do |item|
+          link = item.link
  
- 					# Item contains no link.
-					if( link.nil? )
-						next
-					end
-
-					# Link is not a String directly.
-					if( link.class != String )
-						link = link.href
-					end
-
-					# The link is not in +@seen+ Array.
-					if( not seen?( link ) )
-						on_new_item( link )
-						@log.add( 'on_new_item event ' + link )
-
-						add_seen( link )
-					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
+          # Item contains no link.
+          if(link.nil?)
+            next
+          end
+
+          # Link is not a String directly.
+          if(link.class != String)
+            link = link.href
+          end
+
+          # The link is not in +@seen+ Array.
+          if(not seen?(link))
+            on_new_item(link)
+            @log.debug('on_new_item event ' + link)
+
+            add_seen(link)
+          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