Module: Sanguinews

Defined in:
lib/sanguinews.rb,
lib/sanguinews/version.rb,
lib/sanguinews/nntp_msg.rb,
lib/sanguinews/file_to_upload.rb

Defined Under Namespace

Classes: FileToUpload, NntpMsg

Constant Summary collapse

VERSION = 
"0.60"

Class Method Summary collapse

Class Method Details

.connect(x) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/sanguinews.rb', line 85

def connect(x)
  begin
    nntp = Net::NNTP.start(@server, @port, @username, @password, @mode)
  rescue
    @s.log([$!, $@], stderr: true) if @debug
    if @verbose
      parse_error($!.to_s)
      @s.log("Connection nr. #{x} has failed. Reconnecting...\n", stderr: true)
    end
    sleep @delay
    retry
  end
  return nntp
end

.form_message(data) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/sanguinews.rb', line 64

def form_message(data)
  message = data[:yenc]
  length = data[:length]
  pcrc32 = data[:crc32]
  file = data[:file]
  chunk = data[:chunk]
  crc32 = file.crc32
  fsize = file.size
  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)
  msg.poster = "sanguinews v#{Sanguinews::VERSION} (ruby #{RUBY_VERSION}) - https://github.com/tdobrovolskij/sanguinews"
  msg.xna = @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

.get_msgid(response) ⇒ Object 



125
126
127
128
129
130
131
 
# File 'lib/sanguinews.rb', line 125

def get_msgid(response)
  msgid = ''
  response.each do |r|
    msgid = r.sub(/>.*/, '').tr("<", '') if r.end_with?('Article posted')
  end
  return msgid
end

.parse_config(config) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/sanguinews.rb', line 100

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

.parse_error(msg, **info) ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/sanguinews.rb', line 209

def parse_error(msg, **info)
  if info[:file].nil? || info[:chunk].nil?
    fileinfo = ''
  else
    fileinfo = '(' + info[:file] + ' / Chunk: ' + info[:chunk].to_s + ')'
  end

  case
  when /\A411/ === msg
    @s.log("Invalid newsgroup specified.", stderr: true)
  when /\A430/ === msg
    @s.log("No such article. Maybe server is lagging...#{fileinfo}", stderr: true)
  when /\A(4\d{2}\s)?437/ === msg
    @s.log("Article rejected by server. Maybe it's too big.#{fileinfo}", stderr: true)
  when /\A440/ === msg
    @s.log("Posting not allowed.", stderr: true)
  when /\A441/ === msg
    @s.log("Posting failed for some reason.#{fileinfo}", stderr: true)
  when /\A450/ === msg
    @s.log("Not authorized.", stderr: true)
  when /\A452/ === msg
    @s.log("Wrong username and/or password.", stderr: true)
  when /\A500/ === msg
    @s.log("Command not recognized.", stderr: true)
  when /\A501/ === msg
    @s.log("Command syntax error.", stderr: true)
  when /\A502/ === msg
    @s.log("Access denied.", stderr: true)
  end
end

.parse_options(args) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/sanguinews.rb', line 133

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

.process_and_upload(queue, nntp_pool, info_lock, informed) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/sanguinews.rb', line 240

def process_and_upload(queue, nntp_pool, info_lock, informed)
  stuff = queue.pop
  queue.synchronize do
    @cond.signal
  end
  nntp = nntp_pool.pop

  data = stuff[0]
  file = stuff[1]
  msg = data[:message]
  chunk = data[:chunk]
  basename = data[:filename]
  length = data[:length]
  full_size = msg.length
  info_lock.synchronize do
    if !informed[basename.to_sym]
      @s.log("Uploading #{basename}\n")
      @s.log(file.subject + "\n")
      @s.log("Chunks: #{file.chunks}\n", stderr: true) if @verbose
      informed[basename.to_sym] = true
    end
  end

  @s.start
  x = 1
  begin
    response = nntp.post msg
    msgid = get_msgid(response)
    if @header_check
      sleep x
      nntp.stat("<#{msgid}>")
    end
  rescue
    @s.log([$!, $@], stderr: true) if @debug
    if @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
    retry
  end

  if @verbose
    @s.log("Uploaded chunk Nr:#{chunk}\n", stderr: true)
  end

  @s.done(length)
  @s.uploaded += full_size
  if @nzb
    file.write_segment_info(length, chunk, msgid)
  end
  nntp_pool.push(nntp)
end

.run! ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/sanguinews.rb', line 295

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]

  # skip hidden files
  if !filemode
    directory = directory + "/" unless directory.end_with?('/')
    Dir.foreach(directory) do |item|
      next if item.start_with?('.')
      files << directory+item
    end
  end

  # "max" is needed only in dirmode
  max = files.length
  c = 1

  unprocessed = 0
  info_lock=Mutex.new
  messages = Queue.new
  messages.extend(MonitorMixin)
  @cond = messages.new_cond
  files_to_process = []
  @s = Speedometer.new(units: "KB", progressbar: true)
  @s.uploaded = 0

  pool = Queue.new
  Thread.new {
    @threads.times do |x|
      nntp = connect(x)
      pool.push(nntp)
    end
  }

  p = Pool.new(@threads)
  informed = {}

  files.each do |file|
    next if !File.file?(file)

    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
    )
    @s.to_upload += file.size

    info_lock.synchronize do
      unprocessed += file.chunks
    end

    files_to_process << file
    c += 1
  end

  # let's give a little bit higher priority for file processing thread
  @t = 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)
    end
  }
  @t.priority += 2

  until unprocessed == 0
    p.schedule do
      process_and_upload(messages, pool, info_lock, informed)
    end
    unprocessed -= 1
  end

  p.shutdown

  until pool.empty?
    nntp = pool.pop
    nntp.finish
  end

  @s.stop
  puts

  files_to_process.each do |file|
    if files_to_process.last == file
      last = true
    else
      last = false
    end
    file.close(last)
  end
end

.yencode(file, length, queue) ⇒ Object

Method returns yenc encoded string and crc32 value



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/sanguinews.rb', line 39

def yencode(file, length, queue)
   i = 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
        end
      end
      data = {}
      final_data = []
      len = bindata.length
      data[:yenc] = Yencoded::Data.yenc(bindata, len)
      data[:crc32] = Zlib.crc32(bindata, 0).to_s(16)
      data[:length] = len
      data[:chunk] = i
      data[:file] = file
      final_data[0] = form_message(data)
      final_data[1] = file
      queue.push(final_data)
      i += 1
   end
end