Module: Open

Defined in:
lib/rbbt/util/open.rb

Defined Under Namespace

Classes: OpenGzipError, OpenURLError

Constant Summary collapse

REMOTE_CACHEDIR = 
File.join(ENV["HOME"], "/tmp/open_cache")
LAST_TIME =

Remote WGET

{}

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.repository_dirs ⇒ Object

Returns the value of attribute repository_dirs.



16
17
18
 
# File 'lib/rbbt/util/open.rb', line 16

def repository_dirs
  @repository_dirs
end

Class Method Details

.add_cache(url, data, options = {}) ⇒ Object 



121
122
123
124
 
# File 'lib/rbbt/util/open.rb', line 121

def self.add_cache(url, data, options = {})
  file = File.join(REMOTE_CACHEDIR, digest_url(url, options))
  Misc.sensiblewrite(file, data, :force => true)
end

.bgunzip(stream) ⇒ Object

Decompression



296
297
298
 
# File 'lib/rbbt/util/open.rb', line 296

def self.bgunzip(stream)
  Bgzf.setup stream
end

.bgzip?(file) ⇒ Boolean

Returns:

  • (Boolean) 


321
322
323
324
 
# File 'lib/rbbt/util/open.rb', line 321

def self.bgzip?(file)
  file = file.find if Path === file
  !! (file =~ /\.bgz$/)
end

.cachedir ⇒ Object 



35
36
37
 
# File 'lib/rbbt/util/open.rb', line 35

def self.cachedir
  REMOTE_CACHEDIR
end

.cachedir=(cachedir) ⇒ Object 



30
31
32
33
 
# File 'lib/rbbt/util/open.rb', line 30

def self.cachedir=(cachedir)
  REMOTE_CACHEDIR.replace cachedir
  FileUtils.mkdir_p REMOTE_CACHEDIR unless File.exist? REMOTE_CACHEDIR
end

.can_open?(file) ⇒ Boolean

Returns:

  • (Boolean) 


427
428
429
 
# File 'lib/rbbt/util/open.rb', line 427

def self.can_open?(file)
  String === file and (File.exist?(file) or remote?(file))
end

.clean_cache(url, options = {}) ⇒ Object

Open Read Write



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/rbbt/util/open.rb', line 334

def self.clean_cache(url, options = {})
  options = Misc.add_defaults options, :noz => false, :mode => 'r'

  wget_options = options[:wget_options] || {}
  wget_options[:nice] = options.delete(:nice)
  wget_options[:nice_key] = options.delete(:nice_key)
  wget_options[:quiet] = options.delete(:quiet)
  wget_options["--post-data="] = options.delete(:post) if options.include? :post
  wget_options["--post-file"] = options.delete("--post-file") if options.include? "--post-file"
  wget_options["--post-file="] = options.delete("--post-file=") if options.include? "--post-file="
  wget_options[:cookies] = options.delete(:cookies)

  cache_file = in_cache(url, wget_options)
  Misc.lock(cache_file) do
    FileUtils.rm(cache_file)
  end if cache_file
end

.digest_url(url, options = {}) ⇒ Object 



95
96
97
98
 
# File 'lib/rbbt/util/open.rb', line 95

def self.digest_url(url, options = {})
  params = [url, options.values_at("--post-data", "--post-data="), (options.include?("--post-file")? Open.read(options["--post-file"]).split("\n").sort * "\n" : "")]
  digest = Misc.digest(params.inspect)
end

.download(url, file) ⇒ Object 



419
420
421
422
423
424
425
 
# File 'lib/rbbt/util/open.rb', line 419

def self.download(url, file)
  Open.open(url, :mode => 'rb', :noz => true) do |sin|
    Open.open(file, :mode => 'wb') do |sout|
      Misc.consume_stream(sin, false, sout)
    end
  end
end

.exists?(file) ⇒ Boolean

Returns:

  • (Boolean) 


273
274
275
276
277
278
279
280
281
 
# File 'lib/rbbt/util/open.rb', line 273

def self.exists?(file)
  if (dir_sub_path = find_repo_dir(file))
    dir_sub_path.push file
    exists_in_repo(*dir_sub_path)
  else
    file = file.find if Path === file
    File.exist? file
  end
end

.exists_in_repo(dir, sub_path, content) ⇒ Object 



174
175
176
177
178
179
 
# File 'lib/rbbt/util/open.rb', line 174

def self.exists_in_repo(dir, sub_path, content)
  repo = get_repo_from_dir(dir)
  repo.read_and_close do
    repo.include? sub_path 
  end
end

.file_open(file, grep, mode = 'r', invert_grep = false) ⇒ Object 



207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/rbbt/util/open.rb', line 207

def self.file_open(file, grep, mode = 'r', invert_grep = false)
  if (dir_sub_path = find_repo_dir(file))
    stream = get_stream_from_repo(*dir_sub_path)
  else
    file = file.find if Path === file
    stream =  File.open(file, mode)
  end

  if grep
    grep(stream, grep, invert_grep)
  else
    stream
  end
end

.file_write(file, content, mode = 'w') ⇒ Object 



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/rbbt/util/open.rb', line 222

def self.file_write(file, content, mode = 'w')
  if (dir_sub_path = find_repo_dir(file))
    dir_sub_path.push content
    save_content_in_repo(*dir_sub_path)
  else
    File.open(file, mode) do |f|
      begin
        f.flock(File::LOCK_EX)
        f.write content 
        f.flock(File::LOCK_UN)
      ensure
        f.close unless f.closed?
      end
    end
  end
end

.find_repo_dir(file) ⇒ Object 



181
182
183
184
185
186
187
188
189
 
# File 'lib/rbbt/util/open.rb', line 181

def self.find_repo_dir(file)
  self.repository_dirs.each do |dir|
    if file.start_with? dir
      sub_path = file.to_s[dir.length..-1]
      return [dir, sub_path]
    end
  end
  nil
end

.get_repo_from_dir(dir) ⇒ Object 



140
141
142
143
144
145
146
 
# File 'lib/rbbt/util/open.rb', line 140

def self.get_repo_from_dir(dir)
  @repos ||= {}
  @repos[dir] ||= begin
                    repo_path = File.join(dir, '.file_repo')
                    Persist.open_tokyocabinet(repo_path, false, :clean,TokyoCabinet::BDB )
                  end
end

.get_stream_from_repo(dir, sub_path) ⇒ Object 



148
149
150
151
152
153
154
 
# File 'lib/rbbt/util/open.rb', line 148

def self.get_stream_from_repo(dir, sub_path)
  repo = get_repo_from_dir(dir)
  repo.read_and_close do
    content = repo[sub_path]
    content.nil? ? nil : StringIO.new(content)
  end
end

.grep(stream, grep, invert = false) ⇒ Object

Grep



128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/rbbt/util/open.rb', line 128

def self.grep(stream, grep, invert = false)
  grep_cmd = ENV["GREP_CMD"] || "/bin/grep"
  case 
  when Array === grep
    TmpFile.with_file(grep * "\n", false) do |f|
      CMD.cmd("#{grep_cmd} #{invert ? '-v' : ''} -", "-w" => true, "-F" => true, "-f" => f, :in => stream, :pipe => true, :post => proc{FileUtils.rm f})
    end
  else
    CMD.cmd("#{grep_cmd} #{invert ? '-v ' : ''} '#{grep}' -", :in => stream, :pipe => true, :post => proc{begin stream.force_close; rescue Exception; end if stream.respond_to?(:force_close)})
  end
end

.gunzip(stream) ⇒ Object 



300
301
302
 
# File 'lib/rbbt/util/open.rb', line 300

def self.gunzip(stream)
  CMD.cmd('zcat', :in => stream, :pipe => true, :no_fail => true, :no_wait => true)
end

.gzip?(file) ⇒ Boolean

Returns:

  • (Boolean) 


316
317
318
319
 
# File 'lib/rbbt/util/open.rb', line 316

def self.gzip?(file)
  file = file.find if Path === file
  !! (file =~ /\.gz$/)
end

.in_cache(url, options = {}) ⇒ Object

Cache



101
102
103
104
105
106
107
108
 
# File 'lib/rbbt/util/open.rb', line 101

def self.in_cache(url, options = {})
  filename = File.join(REMOTE_CACHEDIR, digest_url(url, options))
  if File.exist? filename
    return filename 
  else
    nil
  end
end

.lock(file, options = {}, &block) ⇒ Object 



283
284
285
286
287
288
289
290
291
 
# File 'lib/rbbt/util/open.rb', line 283

def self.lock(file, options = {}, &block)
  if file and (dir_sub_path = find_repo_dir(file))
    dir, sub_path = dir_sub_path
    repo = get_repo_from_dir(dir)
    Misc.lock_in_repo(repo, sub_path, &block)
  else
    Misc.lock(file, options, &block)
  end
end

.mv(source, target, options) ⇒ Object 



239
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
 
# File 'lib/rbbt/util/open.rb', line 239

def self.mv(source, target, options)
  dir_sub_path_source = find_repo_dir(source)
  dir_sub_path_target = find_repo_dir(target)

  if dir_sub_path_source.nil? and dir_sub_path_target.nil?
    FileUtils.mkdir_p File.dirname(target) unless File.exist? File.dirname(target)
    tmp_target = File.join(File.dirname(target), '.tmp_mv.' + File.basename(target))
    FileUtils.mv source, tmp_target
    FileUtils.mv tmp_target, target
    return
  end

  if dir_sub_path_source.nil?
    save_content_in_repo(dir_sub_path_target[0], dir_sub_path_target[1], Open.read(source))
    return nil
  end

  if dir_sub_path_target.nil?
    Open.write(target, get_stream_from_repo(dir_sub_path_source))
    return nil
  end

  repo_source = get_repo_from_dir(dir_sub_path_source[0])
  repo_target = get_repo_from_dir(dir_sub_path_target[0])

  repo_source.write_and_close do
    repo_target.write_and_close do
      repo_source[dir_sub_path_source[1]] = repo_target[dir_sub_path_target[1]]
    end
  end

  return nil
end

.notify_write(file) ⇒ Object 



451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/rbbt/util/open.rb', line 451

def self.notify_write(file)
  begin
    notification_file = file + '.notify'
    if File.exist? notification_file
      key = Open.read(notification_file).strip
      key = nil if key.empty?
      Misc.notify("Wrote " << file, nil, key)
      FileUtils.rm notification_file
    end
  rescue
    Log.warn "Error notifying write of #{ file }"
  end
end

.open(url, options = {}) ⇒ Object 



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
415
416
417
 
# File 'lib/rbbt/util/open.rb', line 352

def self.open(url, options = {})
  if IO === url
    if block_given?
      res = yield url 
      url.close
      return res
    else
      return url 
    end
  end
  options = Misc.add_defaults options, :noz => false, :mode => 'r'

  mode = Misc.process_options options, :mode

  options[:noz] = true if mode.include? "w"

  wget_options = options[:wget_options] || {}
  wget_options[:nice] = options.delete(:nice)
  wget_options[:nice_key] = options.delete(:nice_key)
  wget_options[:quiet] = options.delete(:quiet)
  wget_options["--post-data="] = options.delete(:post) if options.include? :post
  wget_options["--post-file"] = options.delete("--post-file") if options.include? "--post-file"
  wget_options["--post-file="] = options.delete("--post-file=") if options.include? "--post-file="
  wget_options[:cookies] = options.delete(:cookies)

  io = case
       when (IO === url or StringIO === url)
         url
       when (not remote?(url))
         file_open(url, options[:grep], mode, options[:invert_grep])
       when (options[:nocache] and options[:nocache] != :update)
         # What about grep?
         wget(url, wget_options)
       when (options[:nocache] != :update and in_cache(url, wget_options))
         file_open(in_cache(url, wget_options), options[:grep], mode, options[:invert_grep])
       else
         io = wget(url, wget_options)
         add_cache(url, io, wget_options)
         file_open(in_cache(url, wget_options), options[:grep], mode, options[:invert_grep])
       end
  io = unzip(io)  if ((String === url and zip?(url))  and not options[:noz]) or options[:zip]
  io = gunzip(io) if ((String === url and gzip?(url)) and not options[:noz]) or options[:gzip]
  io = bgunzip(io) if ((String === url and bgzip?(url)) and not options[:noz]) or options[:bgzip]

  class << io;
    attr_accessor :filename
  end

  io.filename = url.to_s

  if block_given?
    begin
      return yield(io)
    rescue DontClose
    rescue Exception
      io.abort if io.respond_to? :abort
      io.join if io.respond_to? :join
      raise $!
    ensure
      io.close if io.respond_to? :close and not io.closed?
      io.join if io.respond_to? :join
    end
  end

  io
end

.read(file, options = {}, &block) ⇒ Object 



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/rbbt/util/open.rb', line 431

def self.read(file, options = {}, &block)
  open(file, options) do |f|
    if block_given?
      res = []
      while not f.eof?
        l = f.gets
        l = Misc.fixutf8(l) unless options[:nofix]
        res << yield(l)
      end
      res
    else
      if options[:nofix]
        f.read
      else
        Misc.fixutf8(f.read)
      end
    end
  end
end

.remote?(file) ⇒ Boolean

Questions

Returns:

  • (Boolean) 


312
313
314
 
# File 'lib/rbbt/util/open.rb', line 312

def self.remote?(file)
  !! (file =~ /^(?:https?|ftp):\/\//)
end

.remove_from_cache(url, options = {}) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/rbbt/util/open.rb', line 110

def self.remove_from_cache(url, options = {})
  digest = Misc.digest([url, options.values_at("--post-data", "--post-data="), (options.include?("--post-file")? Open.read(options["--post-file"]) : "")].inspect)

  filename = File.join(REMOTE_CACHEDIR, digest)
  if File.exist? filename
    FileUtils.rm filename 
  else
    nil
  end
end

.remove_from_repo(dir, sub_path, recursive = false) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/rbbt/util/open.rb', line 163

def self.remove_from_repo(dir, sub_path, recursive = false)
  repo = get_repo_from_dir(dir)
  repo.write_and_close do
    if recursive
      repo.outlist repo.range sub_path, true, sub_path.sub(/.$/,('\1'.ord + 1).chr), false
    else
      repo.outlist sub_path
    end
  end
end

.rm(file) ⇒ Object 



191
192
193
194
195
196
197
 
# File 'lib/rbbt/util/open.rb', line 191

def self.rm(file)
  if (dir_sub_path = find_repo_dir(file))
    remove_from_repo(*dir_sub_path)
  else
    FileUtils.rm(file)
  end
end

.rm_rf(file) ⇒ Object 



199
200
201
202
203
204
205
 
# File 'lib/rbbt/util/open.rb', line 199

def self.rm_rf(file)
  if (dir_sub_path = find_repo_dir(file))
    remove_from_repo(dir_sub_path[0], dir_sub_path[1], true)
  else
    FileUtils.rm_rf(file)
  end
end

.save_content_in_repo(dir, sub_path, content) ⇒ Object 



156
157
158
159
160
161
 
# File 'lib/rbbt/util/open.rb', line 156

def self.save_content_in_repo(dir, sub_path, content)
  repo = get_repo_from_dir(dir)
  repo.write_and_close do
    repo[sub_path] = content
  end
end

.unzip(stream) ⇒ Object 



304
305
306
307
308
 
# File 'lib/rbbt/util/open.rb', line 304

def self.unzip(stream)
  TmpFile.with_file(stream.read) do |filename|
    StringIO.new(CMD.cmd("unzip '{opt}' #{filename}", "-p" => true, :pipe => true).read)
  end
end

.wait(lag, key = nil) ⇒ Object 



41
42
43
44
45
46
47
48
49
 
# File 'lib/rbbt/util/open.rb', line 41

def self.wait(lag, key = nil)
  time = Time.now   

  if LAST_TIME[key] != nil && (time < LAST_TIME[key] + lag)
    sleep (LAST_TIME[key] + lag) - time
  end

  LAST_TIME[key] = Time.now   
end

.wget(url, options = {}) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/rbbt/util/open.rb', line 51

def self.wget(url, options = {})
  Log.low "WGET:\n -URL: #{ url }\n -OPTIONS: #{options.inspect}"
  options = Misc.add_defaults options, "--user-agent=" => 'rbbt', :pipe => true

  wait(options[:nice], options[:nice_key]) if options[:nice]
  options.delete(:nice)
  options.delete(:nice_key)

  pipe  = options.delete(:pipe)
  quiet = options.delete(:quiet)
  post  = options.delete(:post)
  cookies = options.delete(:cookies)

  options["--quiet"]     = quiet if options["--quiet"].nil?
  options["--post-data="] ||= post if post

  if cookies
    options["--save-cookies"] = cookies
    options["--load-cookies"] = cookies
    options["--keep-session-cookies"] = true
  end


  stderr = case
           when options['stderr']
             options['stderr'] 
           when options['--quiet']
             false
           else
             nil
           end

  begin
    wget_options = options.merge( '-O' => '-')
    wget_options[:pipe] = pipe unless pipe.nil?
    wget_options[:stderr] = stderr unless stderr.nil?

    CMD.cmd("wget '#{ url }'", wget_options)
  rescue
   STDERR.puts $!.backtrace.inspect
   raise OpenURLError, "Error reading remote url: #{ url }.\n#{$!.message}"
  end
end

.write(file, content = nil, options = {}) ⇒ Object 



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/rbbt/util/open.rb', line 465

def self.write(file, content = nil, options = {})
  options = Misc.add_defaults options, :mode => 'w'

  file = file.find(options[:where]) if Path === file
  mode = Misc.process_options options, :mode

  FileUtils.mkdir_p File.dirname(file)
  case
  when block_given?
    begin
      File.open(file, mode) do |f| 
        yield f
      end
    rescue Exception
      FileUtils.rm file if File.exist? file
      raise $!
    end
  when content.nil?
    File.open(file, mode){|f| f.write "" }
  when String === content
    file_write(file, content, mode)
  else
    begin
      File.open(file, mode) do |f| 
        f.flock(File::LOCK_EX)
        while block = content.read(Misc::BLOCK_SIZE)
          f.write block
        end
        f.flock(File::LOCK_UN)
      end
    rescue Exception
      FileUtils.rm_rf file if File.exist? file
      raise $!
    end
    content.close
  end
  notify_write(file) 
end

.zip?(file) ⇒ Boolean

Returns:

  • (Boolean) 


326
327
328
329
 
# File 'lib/rbbt/util/open.rb', line 326

def self.zip?(file)
  file = file.find if Path === file
  !! (file =~ /\.zip$/)
end