sanguinews 0.60 → 0.61

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fa336b8808a65611854b554245a288b4b05f303
-  data.tar.gz: 0c4309243350764bae4669b537f65d4ed9b79e12
+  metadata.gz: 40aa32aca9a225e90465338f0e81ab91e3a6d252
+  data.tar.gz: d54b92ab842f357493d401bbe2f125896e019c8d
 SHA512:
-  metadata.gz: b231b17b59ab469a3d64294c6f3befc97abf0083ebfac5fce887e74511844591708f879de799b09dc75348f202d6bfd5aa1bb05bde52b8970960214922f6abba
-  data.tar.gz: e551da80f3d6f1641c4e47b46636b34ffcfd196fbd9f111c6fab804823df3112418669f38ecd5e3c2c34e4f8a25407f7616d0383d4146cfa4f281f4ab07a8c7f
+  metadata.gz: a6502eba0c482db080ab3a0a3eedd47ae3523a5772e908d68fe6d21041844cae67fcd02cb631cb6501b6b6ee18448c1837ec5a45c01cfca4eb4e04f02828829f
+  data.tar.gz: d501c3176bf7f6e2ca3197e1234c74652e770574e6d668f4881daea9b5e0009b44dc832eca6ca9a91ece5f0af069bf01edb807d8a6f78578908b8f9f069df722

data/lib/sanguinews/config.rb

@@ -0,0 +1,152 @@
+#######################################################################
+# Config - class designed specifically for sanguinews
+# Copyright (c) 2013-2014, Tadeus Dobrovolskij
+# This library is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this library; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#########################################################################
+module Sanguinews
+  class Config
+    attr_reader :config, :data
+
+    %w(username password server port from connections
+       article_size reconnect_delay groups prefix ssl
+       xna nzb header_check verbose debug filemode files directory).each do |meth|
+      define_method(meth) { @data[meth.to_sym] }
+    end
+
+    def parse_config(config)
+      config = ParseConfig.new(config)
+      config.get_params().each do |key|
+	value = config[key]
+	value = true if value == 'yes'
+	value = false if value == 'no'
+	value = value.to_i if %w(connections article_size reconnect_delay).include? key
+	@data[key.to_sym] ||= value
+      end
+    end
+
+    def mode
+      self.ssl ? :tls : :original
+    end
+
+    def parse_options!(args)
+      # version and legal info presented to user
+      banner = []
+      banner << ""
+      banner << "sanguinews v#{Sanguinews::VERSION}. Copyright (c) 2013-2014 Tadeus Dobrovolskij."
+      banner << "Comes with ABSOLUTELY NO WARRANTY. Distributed under GPL v2 license(http://www.gnu.org/licenses/gpl-2.0.txt)."
+      banner << "sanguinews is a simple nntp(usenet) binary poster. It supports multithreading and SSL. More info in README."
+      banner << ""
+      # option parser
+  
+      opt_parser = OptionParser.new do |opt|
+        opt.banner = "Usage: sanguinews [OPTIONS] [DIRECTORY] | -f FILE1..[FILEX]"
+        opt.separator  ""
+        opt.separator  "Options"
+  
+        opt.on("-c", "--config CONFIG", "use different config file") do |cfg|
+          @config = cfg
+        end
+        opt.on("-C", "--check", "check headers while uploading; slow but reliable") do
+          @data[:header_check] = true
+        end
+        opt.on("-f", "--file FILE", "upload FILE, treat all additional parameters as files") do |file|
+          @data[:filemode] = true
+          @data[:files] << file
+        end
+        opt.on("-g", "--groups GROUP_LIST", "use these groups(comma separated) for upload") do |group_list|
+          @data[:groups] = group_list
+        end
+        opt.on("-h", "--help", "help") do
+          banner.each do |msg|
+            puts msg
+          end
+          puts opt_parser
+          puts
+          exit
+        end
+        opt.on("-p", "--password PASSWORD", "use PASSWORD as your password(overwrites config file)") do |password|
+          @data[:password] = password
+        end
+        opt.on("-u", "--user USERNAME", "use USERNAME as your username(overwrites config file)") do |username|
+          @data[:username] = username
+        end
+        opt.on("-v", "--verbose", "be verbose?") do
+          @data[:verbose] = true
+        end
+        opt.on("-V", "--version", "print version information and then exit") do
+          puts Sanguinews::VERSION
+          exit
+        end
+      end
+  
+      begin
+        opt_parser.parse!(args)
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+        puts opt_parser
+        exit 1
+      end
+  
+      # in file mode treat every additional parameter as a file
+      if !args.empty? && @data[:filemode]
+        args.each do |file|
+          @data[:files] << file.to_s
+        end
+      end
+  
+      # exit when no file list is provided
+      if @data[:files].empty?
+	if @data[:filemode] || args.empty?
+          puts "You need to specify something to upload!"
+          puts opt_parser
+          exit 1
+	else
+	  args[0].end_with?('/') ? @data[:directory] = args[0] : @data[:directory] = args[0] + '/'
+        end
+      end
+  
+    end
+
+    def config_gen
+      puts "It looks like you are launching sanguinews for the first time."
+      `cp #{File.expand_path(File.dirname(__FILE__)) + '/../../sample.conf'} ~/.sanguinews.conf`
+      puts "Sample config was copied to your home directory."
+      puts "Please edit #{File.expand_path('~/.sanguinews.conf')} in your favourite text editor."
+      puts "Relaunch the application when ready."
+      exit
+    end
+
+    def initialize(args)
+      @data = {}
+      @data[:filemode] = false
+      @data[:files] = []
+
+      parse_options!(args)
+
+      # Parse options in config file
+      if @data[:config] && File.exist?(File.expand_path(@data[:config]))
+	config = @data[:config]
+      else
+	config = File.expand_path("~/.sanguinews.conf")
+      end
+
+      if File.exist?(config)
+	parse_config(config)
+      else
+	config_gen
+      end
+    end
+  
+  end
+end

data/lib/sanguinews/file_to_upload.rb

@@ -65,11 +65,8 @@ module Sanguinews
         until self.eof?
           f = self.read(@@max_mem)
           crc32 = Zlib.crc32(f, 0)
-          if fcrc32.nil?
-            fcrc32 = crc32
-          else
-            fcrc32 = Zlib.crc32_combine(fcrc32, crc32, f.size)
-          end
+          fcrc32 &&= Zlib.crc32_combine(fcrc32, crc32, f.size)
+          fcrc32 ||= crc32
         end
         self.rewind
         fcrc32.to_s(16)
@@ -99,7 +96,7 @@ module Sanguinews
     end
   
     def max_mem
-      if @@max_mem.nil?
+      @@max_mem ||= begin
         memory = Vmstat.memory
         @@max_mem = (memory[:free] * memory[:pagesize] * 0.1).floor
       end

data/lib/sanguinews/nntp_msg.rb

@@ -22,17 +22,14 @@ module Sanguinews
   class NntpMsg
     attr_accessor :message, :from, :groups, :subject, :poster, :date, :xna
   
-    def initialize(from, groups, subject, message='', date=nil, poster=nil)
+    def initialize(from, groups, subject, message='', **opts)
       @from = from
       @groups = groups
       @subject = subject
       @message = message
-      if date.nil?
-        @date = DateTime.now().strftime('%a, %d %b %Y %T %z')
-      else
-        @date = date
-      end
-      @poster = poster if !poster.nil?
+      @date = opts[:date] if opts[:date]
+      @date ||= DateTime.now().strftime('%a, %d %b %Y %T %z')
+      @poster = opts[:poster] if opts[:poster]
     end
   
     def create_header
@@ -40,7 +37,7 @@ module Sanguinews
       sio.puts "From: #{@from}"
       sio.puts "Newsgroups: #{@groups}"
       sio.puts "Subject: #{@subject}"
-      sio.puts "X-Newsposter: #{@poster}" unless poster.nil?
+      sio.puts "X-Newsposter: #{@poster}" if @poster
       sio.puts "X-No-Archive: yes" if @xna
       sio.puts "Date: #{@date}"
       sio.puts
@@ -72,7 +69,6 @@ module Sanguinews
     def return_self
       header = self.create_header
       header << @message
-      return header
     end
   
     def size

data/lib/sanguinews/version.rb

@@ -1,3 +1,3 @@
 module Sanguinews
-    VERSION = "0.60"
+    VERSION = "0.61"
 end

data/lib/sanguinews.rb

@@ -31,19 +31,20 @@ require_relative 'sanguinews/nntp'
 require_relative 'sanguinews/nntp_msg'
 require_relative 'sanguinews/file_to_upload'
 require_relative 'sanguinews/yencoded'
+require_relative 'sanguinews/config'
 require_relative 'sanguinews/version'
 
 module Sanguinews
   module_function
   # Method returns yenc encoded string and crc32 value
   def yencode(file, length, queue)
-     i = 1
+     chunk = 1
      until file.eof?
         bindata = file.read(length)
         # We can't take all memory, so we wait
         queue.synchronize do
           @cond.wait_while do
-            queue.length > @threads * 3
+            queue.length > @config.connections * 3
           end
         end
         data = {}
@@ -52,12 +53,12 @@ module Sanguinews
         data[:yenc] = Yencoded::Data.yenc(bindata, len)
         data[:crc32] = Zlib.crc32(bindata, 0).to_s(16)
         data[:length] = len
-        data[:chunk] = i
+        data[:chunk] = chunk
         data[:file] = file
         final_data[0] = form_message(data)
         final_data[1] = file
         queue.push(final_data)
-        i += 1
+        chunk += 1
      end
   end
 
@@ -72,168 +73,68 @@ module Sanguinews
     chunks = file.chunks
     basename = file.name
     # usenet works with ASCII
-    subject="#{@prefix}#{file.dir_prefix}\"#{basename}\" yEnc (#{chunk}/#{chunks})"
-    msg = NntpMsg.new(@from, @groups, subject)
+    subject="#{@config.prefix}#{file.dir_prefix}\"#{basename}\" yEnc (#{chunk}/#{chunks})"
+    msg = NntpMsg.new(@config.from, @config.groups, subject)
     msg.poster = "sanguinews v#{Sanguinews::VERSION} (ruby #{RUBY_VERSION}) - https://github.com/tdobrovolskij/sanguinews"
-    msg.xna = @xna
+    msg.xna = @config.xna
     msg.message = message.force_encoding('ASCII-8BIT')
     msg.yenc_body(chunk, chunks, crc32, pcrc32, length, fsize, basename)
     msg = msg.return_self
     { message: msg, filename: basename, chunk: chunk, length: length }
   end
 
-  def connect(x)
+  def connect(conn_nr)
     begin
-      nntp = Net::NNTP.start(@server, @port, @username, @password, @mode)
+      nntp = Net::NNTP.start(
+	@config.server, @config.port, @config.username, @config.password, @config.mode)
     rescue
-      @s.log([$!, $@], stderr: true) if @debug
-      if @verbose
+      @s.log([$!, $@], stderr: true) if @config.debug
+      if @config.verbose
         parse_error($!.to_s)
-        @s.log("Connection nr. #{x} has failed. Reconnecting...\n", stderr: true)
+        @s.log("Connection nr. #{conn_nr} has failed. Reconnecting...\n", stderr: true)
       end
-      sleep @delay
+      sleep @config.reconnect_delay
       retry
     end
     return nntp
   end
 
-  def parse_config(config)
-    config = ParseConfig.new(config)
-    config.get_params()
-    @username = config['username']
-    @password = config['password']
-    @from = config['from']
-    @server = config['server']
-    @port = config['port']
-    @threads = config['connections'].to_i
-    @length = config['article_size'].to_i
-    @delay = config['reconnect_delay'].to_i
-    @groups = config['groups']
-    @prefix = config['prefix']
-    ssl = config['ssl']
-    if ssl == 'yes'
-      @mode = :tls
-    else
-      @mode = :original
-    end
-    config['xna'] == 'yes' ? @xna = true : @xna = false
-    config['nzb'] == 'yes' ? @nzb = true : @nzb = false
-    config['header_check'] == 'yes' ? @header_check = true : @header_check = false
-    config['debug'] == 'yes' ? @debug = true : @debug = false
-  end
-
-  def get_msgid(response)
+  def get_msgid(responses)
     msgid = ''
-    response.each do |r|
-      msgid = r.sub(/>.*/, '').tr("<", '') if r.end_with?('Article posted')
+    responses.each do |response|
+      msgid = response.sub(/>.*/, '').tr("<", '') if response.end_with?('Article posted')
     end
     return msgid
   end
 
-  def parse_options(args)
-    # version and legal info presented to user
-    banner = []
-    banner << ""
-    banner << "sanguinews v#{Sanguinews::VERSION}. Copyright (c) 2013-2014 Tadeus Dobrovolskij."
-    banner << "Comes with ABSOLUTELY NO WARRANTY. Distributed under GPL v2 license(http://www.gnu.org/licenses/gpl-2.0.txt)."
-    banner << "sanguinews is a simple nntp(usenet) binary poster. It supports multithreading and SSL. More info in README."
-    banner << ""
-    # option parser
-    options = {}
-    options[:filemode] = false
-    options[:files] = []
-
-    opt_parser = OptionParser.new do |opt|
-      opt.banner = "Usage: #{$0} [OPTIONS] [DIRECTORY] | -f FILE1..[FILEX]"
-      opt.separator  ""
-      opt.separator  "Options"
-
-      opt.on("-c", "--config CONFIG", "use different config file") do |cfg|
-        options[:config] = cfg
-      end
-      opt.on("-C", "--check", "check headers while uploading; slow but reliable") do
-        options[:header_check] = true
-      end
-      opt.on("-f", "--file FILE", "upload FILE, treat all additional parameters as files") do |file|
-        options[:filemode] = true
-        options[:files] << file
-      end
-      opt.on("-g", "--groups GROUP_LIST", "use these groups(comma separated) for upload") do |group_list|
-        options[:groups] = group_list
-      end
-      opt.on("-h", "--help", "help") do
-        banner.each do |msg|
-          puts msg
-        end
-        puts opt_parser
-        puts
-        exit
-      end
-      opt.on("-p", "--password PASSWORD", "use PASSWORD as your password(overwrites config file)") do |password|
-        options[:password] = password
-      end
-      opt.on("-u", "--user USERNAME", "use USERNAME as your username(overwrites config file)") do |username|
-        options[:username] = username
-      end
-      opt.on("-v", "--verbose", "be verbose?") do
-        options[:verbose] = true
-      end
-    end
-
-    begin
-      opt_parser.parse!(args)
-    rescue OptionParser::InvalidOption, OptionParser::MissingArgument
-      puts opt_parser
-      exit 1
-    end
-
-    options[:directory] = args[0] unless options[:filemode]
-
-    # in file mode treat every additional parameter as a file
-    if !args.empty? && options[:filemode]
-      args.each do |file|
-        options[:files] << file.to_s
-      end
-    end
-
-    # exit when no file list is provided
-    if options[:directory].nil? && options[:files].empty?
-      puts "You need to specify something to upload!"
-      puts opt_parser
-      exit 1
-    end
-
-    return options
-  end
-
   def parse_error(msg, **info)
-    if info[:file].nil? || info[:chunk].nil?
-      fileinfo = ''
-    else
+    if info[:file] && info[:chunk]
       fileinfo = '(' + info[:file] + ' / Chunk: ' + info[:chunk].to_s + ')'
+    else
+      fileinfo = ''
     end
 
     case
     when /\A411/ === msg
-      @s.log("Invalid newsgroup specified.", stderr: true)
+      @s.log("Invalid newsgroup specified.\n", stderr: true)
     when /\A430/ === msg
-      @s.log("No such article. Maybe server is lagging...#{fileinfo}", stderr: true)
+      @s.log("No such article. Maybe server is lagging...#{fileinfo}\n", stderr: true)
     when /\A(4\d{2}\s)?437/ === msg
-      @s.log("Article rejected by server. Maybe it's too big.#{fileinfo}", stderr: true)
+      @s.log("Article rejected by server. Maybe it's too big.#{fileinfo}\n", stderr: true)
     when /\A440/ === msg
-      @s.log("Posting not allowed.", stderr: true)
+      @s.log("Posting not allowed.\n", stderr: true)
     when /\A441/ === msg
-      @s.log("Posting failed for some reason.#{fileinfo}", stderr: true)
+      @s.log("Posting failed for some reason.#{fileinfo}\n", stderr: true)
     when /\A450/ === msg
-      @s.log("Not authorized.", stderr: true)
+      @s.log("Not authorized.\n", stderr: true)
     when /\A452/ === msg
-      @s.log("Wrong username and/or password.", stderr: true)
+      @s.log("Wrong username and/or password.\n", stderr: true)
     when /\A500/ === msg
-      @s.log("Command not recognized.", stderr: true)
+      @s.log("Command not recognized.\n", stderr: true)
     when /\A501/ === msg
-      @s.log("Command syntax error.", stderr: true)
+      @s.log("Command syntax error.\n", stderr: true)
     when /\A502/ === msg
-      @s.log("Access denied.", stderr: true)
+      @s.log("Access denied.\n", stderr: true)
     end
   end
 
@@ -261,80 +162,52 @@ module Sanguinews
     end
 
     @s.start
-    x = 1
+    check_delay = 1
     begin
       response = nntp.post msg
       msgid = get_msgid(response)
-      if @header_check
-        sleep x
+      if @config.header_check
+        sleep check_delay
         nntp.stat("<#{msgid}>")
       end
     rescue
-      @s.log([$!, $@], stderr: true) if @debug
-      if @verbose
+      @s.log([$!, $@], stderr: true) if @config.debug
+      if @config.verbose
         parse_error($!.to_s, file: basename, chunk: chunk)
         @s.log("Upload of chunk #{chunk} from file #{basename} unsuccessful. Retrying...\n", stderr: true)
       end
-      sleep @delay
-      x += 4
+      sleep @config.reconnect_delay
+      check_delay += 4
       retry
     end
 
-    if @verbose
+    if @config.verbose
       @s.log("Uploaded chunk Nr:#{chunk}\n", stderr: true)
     end
 
     @s.done(length)
     @s.uploaded += full_size
-    if @nzb
+    if @config.nzb
       file.write_segment_info(length, chunk, msgid)
     end
     nntp_pool.push(nntp)
   end
 
   def run!
-    # Parse options in config file
-    config = "~/.sanguinews.conf"
-    config = File.expand_path(config)
-    # variable to store if config was parsed
-    saw_config = false
-    if File.exist?(config)
-      saw_config = true
-      parse_config(config)
-    end
-
-    options = parse_options(ARGV)
-
-    optconfig = options[:config]
-    optconfig = '' if optconfig.nil?
-    if !File.exist?(optconfig) && !saw_config
-      puts "No config information specified. Aborting..."
-      exit
-    end
-    parse_config(optconfig) if File.exist?(optconfig)
-
-    options[:verbose] ? @verbose = true : @verbose = false
-    @header_check = true unless options[:header_check].nil?
-    filemode = options[:filemode]
-
-    @username = options[:username] unless options[:username].nil?
-    @password = options[:password] unless options[:password].nil?
-    @groups = options[:groups] unless options[:groups].nil?
-    directory = options[:directory] unless filemode
-    files = options[:files]
+    @config = Config.new(ARGV)
+    files = @config.files
 
     # skip hidden files
-    if !filemode
-      directory = directory + "/" unless directory.end_with?('/')
-      Dir.foreach(directory) do |item|
+    if !@config.filemode
+      Dir.foreach(@config.directory) do |item|
         next if item.start_with?('.')
-        files << directory+item
+        files << @config.directory+item
       end
     end
 
     # "max" is needed only in dirmode
     max = files.length
-    c = 1
+    current_chunk = 1
 
     unprocessed = 0
     info_lock=Mutex.new
@@ -347,13 +220,13 @@ module Sanguinews
 
     pool = Queue.new
     Thread.new {
-      @threads.times do |x|
-        nntp = connect(x)
+      @config.connections.times do |conn_nr|
+        nntp = connect(conn_nr)
         pool.push(nntp)
       end
     }
 
-    p = Pool.new(@threads)
+    thread_pool = Pool.new(@config.connections)
     informed = {}
 
     files.each do |file|
@@ -361,9 +234,9 @@ module Sanguinews
 
       informed[file.to_sym] = false
       file = FileToUpload.new(
-        name: file, chunk_length: @length,
-        prefix: @prefix, current: c, last: max, filemode: filemode,
-        from: @from, groups: @groups, nzb: @nzb
+        name: file, chunk_length: @config.article_size, prefix: @config.prefix,
+	current: current_chunk, last: max, filemode: @config.filemode,
+	from: @config.from, groups: @config.groups, nzb: @config.nzb
       )
       @s.to_upload += file.size
 
@@ -372,28 +245,28 @@ module Sanguinews
       end
 
       files_to_process << file
-      c += 1
+      current_chunk += 1
     end
 
     # let's give a little bit higher priority for file processing thread
-    @t = Thread.new {
+    @file_proc_thread = Thread.new {
       files_to_process.each do |file|
         @s.log("Calculating CRC32 value for #{file.name}\n", stderr: true) if @verbose
         file.file_crc32
         @s.log("Encoding #{file.name}\n")
-        yencode(file, @length, messages)
+        yencode(file, @config.article_size, messages)
       end
     }
-    @t.priority += 2
+    @file_proc_thread.priority += 2
 
     until unprocessed == 0
-      p.schedule do
+      thread_pool.schedule do
         process_and_upload(messages, pool, info_lock, informed)
       end
       unprocessed -= 1
     end
 
-    p.shutdown
+    thread_pool.shutdown
 
     until pool.empty?
       nntp = pool.pop

data/sample.conf

@@ -0,0 +1,37 @@
+# Sample config file
+# Groups to post to
+# Separate multiple groups with comma
+groups = alt.binaries.test
+# Your identity
+from = witty_nickname <whatever@example.com>
+
+# Username to use for authentication
+username = your_username
+# Password
+password = your_password
+# server to use
+server = your_server
+# Use SSL connection?
+ssl = yes
+# port
+port = 563
+# number of connections
+connections = 10
+# article size in bytes
+article_size = 768000
+# Wait this many seconds before trying to reconnect after unsuccessful upload
+reconnect_delay = 5
+# Subject prefix to use
+prefix = "[sanguinews] - "
+# Enable nzb creation
+nzb = yes
+# Use header checking? Upload will be slow but reliable.
+header_check = no
+
+# Debug information
+debug = no
+#######################
+# headers
+#######################
+# X-No-Archive
+xna = no

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sanguinews
 version: !ruby/object:Gem::Version
-  version: '0.60'
+  version: '0.61'
 platform: ruby
 authors:
 - Tadeus Dobrovolskij
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2014-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: speedometer
@@ -121,11 +121,13 @@ files:
 - ext/yencoded/yencoded.c
 - ext/yencoded/yencoded.h
 - lib/sanguinews.rb
+- lib/sanguinews/config.rb
 - lib/sanguinews/file_to_upload.rb
 - lib/sanguinews/nntp.rb
 - lib/sanguinews/nntp_msg.rb
 - lib/sanguinews/thread-pool.rb
 - lib/sanguinews/version.rb
+- sample.conf
 homepage: http://www.tad-do.net
 licenses:
 - GPLv2