Module: FilePool

Defined in:
lib/file_pool.rb,
lib/file_pool/version.rb

Defined Under Namespace

Classes: InvalidFileId

Constant Summary collapse

VERSION = 
"0.5.1"

Class Method Summary collapse

Class Method Details

.add(path) ⇒ Object

Add a file to the file pool.

Same as FilePool.add!, but doesn’t throw exceptions.

Parameters:

source (String)

path of the file to add.

Return Value:

String containing a new unique ID for the file added.

false when the file could not be stored.



118
119
120
121
122
123
 
# File 'lib/file_pool.rb', line 118

def self.add path
  self.add!(path)

rescue Exception
  return false
end

.add!(orig_path) ⇒ Object

Add a file to the file pool.

Creates hard-links (ln) when file at path is on same file system as pool, otherwise copies it. When dealing with large files the latter should be avoided, because it takes more time and space.

Throws standard file exceptions when unable to store the file. See also FilePool.add to avoid it.

Parameters:

path (String)

path of the file to add.

Return Value:

String containing a new unique ID for the file added.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/file_pool.rb', line 77

def self.add! orig_path
  newid = uuid
  target = path newid

  if @@crypted_mode
    FileUtils.mkpath(id2dir_secured newid)
    path = crypt(orig_path)      
  else
    path = orig_path
    FileUtils.mkpath(id2dir newid)
  end

  if !@@copy_source and (File.stat(path).dev == File.stat(File.dirname(target)).dev)
    FileUtils.link(path, target)
  else
    FileUtils.copy(path, target)     
  end

  # don't chmod if orginal file is same as target (hard-linked) 
  if File.stat(orig_path).ino != File.stat(File.dirname(target)).ino
    FileUtils.chmod(@@mode, target) if @@mode
    FileUtils.chown(@@owner, @@group, target)
  end

  newid
end

.configure(config_file) ⇒ Object

Retrieves configuration from config file or creates a new one in case there’s none available.



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/file_pool.rb', line 373

def self.configure config_file
  unless config_file.nil?
    @@crypted_mode = true
    begin
      config = YAML.load_file(config_file)
      @@iv  = config[:iv]
      @@key = config[:key]
    rescue Errno::ENOENT
      cipher = OpenSSL::Cipher::AES.new(256, :CBC)
      @@iv  = cipher.random_iv
      @@key = cipher.random_key
      cipher.key = @@key
      cfg = File.open(config_file, 'w')
      cfg.write({:iv => @@iv, :key => @@key}.to_yaml)
      cfg.close
      File.chmod(0400, config_file)
    rescue => other_error
      raise "FilePool: Could not load secrets from #{config_file}: #{other_error}"
    end
  end
end

.create_cipher ⇒ Object

Creates a cipher to encrypt data.

Returns the cipher.

Return Value:

*Openssl*Cipher object.



345
346
347
348
349
350
351
 
# File 'lib/file_pool.rb', line 345

def self.create_cipher
  cipher = OpenSSL::Cipher::AES.new(256, :CBC)
  cipher.encrypt
  cipher.key = @@key
  cipher.iv  = @@iv
  cipher
end

.create_decipher ⇒ Object

Creates a decipher to decrypt data.

Returns the decipher.

Return Value:

*Openssl*Cipher object



361
362
363
364
365
366
367
 
# File 'lib/file_pool.rb', line 361

def self.create_decipher
  decipher = OpenSSL::Cipher::AES.new(256, :CBC)
  decipher.decrypt
  decipher.key = @@key
  decipher.iv  = @@iv
  decipher
end

.crypt(path) ⇒ Object

Crypt a file and store the result in the temp.

Returns the path to the crypted file.

Parameters:

path (String)

path of the file to crypt.

Return Value:

*String*Path and name of the crypted file.



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/file_pool.rb', line 286

def self.crypt path
  # Crypt the file in the temp folder and copy after
  cipher = create_cipher
  result = Tempfile.new 'FilePool-encrypt'

  result.set_encoding Encoding::BINARY,Encoding::BINARY
  buf = ''.encode(Encoding::BINARY)

  File.open(path) do |inf|
    while inf.read(@@block_size, buf)
      result << cipher.update(buf)
    end
    result << cipher.final
  end

  result.close
  result.path
end

.decrypt(path) ⇒ Object

Decrypt a file and give a path to it.

Returns the path to the decrypted file.

Parameters:

path (String)

path of the file to decrypt.

Return Value:

*String*Path and name of the crypted file.



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/file_pool.rb', line 318

def self.decrypt path
  decipher = create_decipher
  # Now decrypt the data:
  output = Tempfile.new 'FilePool-decrypt'

  output.set_encoding Encoding::BINARY,Encoding::BINARY
  buf = ''.encode(Encoding::BINARY)

  File.open(path) do |inf|
    while inf.read(@@block_size, buf)
      output << decipher.update(buf)
    end
    output << decipher.final
  end

  output.open # re-open for reading, prevents early deletion of tempfile
  output.path
end

.encrypted?(fid) ⇒ Boolean

Tell wehther a file was stored with encryption. (checks for presence in the secured part of the file pool. If the file was actually encrypted cannot be answered)

Returns:

  • (Boolean) 


400
401
402
 
# File 'lib/file_pool.rb', line 400

def self.encrypted? fid
  File.file?(id2dir_secured(fid) + "/#{fid}")
end

.id2dir(fid) ⇒ Object

path from fid without file name



241
242
243
 
# File 'lib/file_pool.rb', line 241

def self.id2dir fid
  "#{root}/#{fid[0,1]}/#{fid[1,1]}/#{fid[2,1]}"
end

.id2dir_secured(fid) ⇒ Object

secured path from fid without file name



246
247
248
 
# File 'lib/file_pool.rb', line 246

def self.id2dir_secured fid
  "#{root}_secured/#{fid[0,1]}/#{fid[1,1]}/#{fid[2,1]}"
end

.median(sizes) ⇒ Object

median file size



265
266
267
268
269
270
271
 
# File 'lib/file_pool.rb', line 265

def self.median(sizes)
  arr = sizes
  sortedarr = arr.sort
  medpt1 = arr.length / 2
  medpt2 = (arr.length+1)/2
  (sortedarr[medpt1] + sortedarr[medpt2]).to_f / 2
end

.path(fid, options = {}) ⇒ Object

Return the file’s path corresponding to the passed file ID, no matter if it exists or not. In encrypting mode the file is first decrypted and the returned path will point to a temporary location of the decrypted file.

To get the path of the encrypted file pass :decrypt => false, as an option.

Parameters:

fid (String)

File ID which was generated by a previous #add operation.

options (Hash)

:decrypt (true,false) In encryption mode don’t decrypt, but return the encrypted file’s path. Defaults to true.

Return Value:

String, absolute path of the file in the pool or to temporary location if it was decrypted.

Raises:



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
 
# File 'lib/file_pool.rb', line 143

def self.path fid, options={}
  options[:decrypt] = true unless options[:decrypt] == false

  raise InvalidFileId unless valid?(fid)

  # file present in pool?
  if File.file?(id2dir_secured(fid) + "/#{fid}")
    # present in secured tree
    if @@crypted_mode
      if options[:decrypt]
        # return path of decrypted file (tmp path)
        decrypt id2dir_secured(fid) + "/#{fid}"
      else
        id2dir_secured(fid) + "/#{fid}"
      end
    else
      id2dir_secured(fid) + "/#{fid}"
    end
  elsif File.file?(id2dir(fid) + "/#{fid}")
    # present in plain tree
    id2dir(fid) + "/#{fid}"
  else
    # not present
    if @@crypted_mode
      id2dir_secured(fid) + "/#{fid}"
    else
      id2dir(fid) + "/#{fid}"
    end
  end
end

.remove(fid) ⇒ Object

Remove a previously added file by its ID. Same as FilePool.remove!, but doesn’t throw exceptions.

Parameters:

fid (String)

File ID which was generated by a previous #add operation.

Return Value:

Boolean, true if file was removed successfully, false else



198
199
200
201
202
 
# File 'lib/file_pool.rb', line 198

def self.remove fid
  self.remove! fid
rescue Exception => ex
  return false
end

.remove!(fid) ⇒ Object

Remove a previously added file by its ID. Same as FilePool.remove, but throws exceptions on failure.

Parameters:

fid (String)

File ID which was generated by a previous #add operation.



182
183
184
 
# File 'lib/file_pool.rb', line 182

def self.remove! fid
  FileUtils.rm path(fid, :decrypt => false)
end

.root ⇒ Object 



236
237
238
 
# File 'lib/file_pool.rb', line 236

def self.root
  @@root rescue raise("FilePool: no root directory defined. Use FilePool#setup.")
end

.setup(root, options = {}) ⇒ Object

Setup the root directory of the file pool and configure encryption

Parameters:

root (String)

absolute path of the file pool’s root directory under which all files will be stored.

config_file_path (String)

path to the config file of the filepool.

options (Hash)

  • :secrets_file (String) path to file containing key and IV for encryption (if omitted FilePool does not encrypt/decrypt). If file is not present, the file is initialized with a new random key and IV.

  • :encryption_block_size (Integer) sets the block size for encryption/decryption in bytes. Larger blocks need more memory and less time (less IO). Defaults to 1’048’576 (1 MiB).

  • :copy_source (true,false) if false files added to the pool are hard-linked with the source if source and file pool are on the same file system (default). If set to true files are always copied into the pool.

  • :mode (Integer) File mode to set on all files added to the pool. E.g. mode: 0640 for rw-r----- or symbolic “u=wrx,go=rx” (see Ruby stdlib FileUtils#chmod). Note that the desired mode is not set if the file is hard-linked with the source. Use copy_source:true when to ensure.

  • :owner Owner of the files added to the pool. Note that the desired owner is not set if the file is hard-linked with the source. Use copy_source:true when to ensure.

  • :group Group of the files added to the pool. Note that the desired group is not set if the file is hard-linked with the source. Use copy_source:true when to ensure.



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/file_pool.rb', line 45

def self.setup root, options={}
  unless(unknown = options.keys - [:encryption_block_size, :secrets_file, :copy_source, :mode, :owner, :group]).empty?
    puts "FilePool Warning: unknown option(s) passed to #setup: #{unknown.inspect}"
  end
  @@root = root
  @@crypted_mode = false
  @@block_size = options[:encryption_block_size] || (1024*1024)
  @@copy_source = options[:copy_source] || false
  @@mode = options[:mode]
  @@group = options[:group]
  @@owner = options[:owner]
  configure options[:secrets_file]
end

.stat ⇒ Object

Returns some statistics about the current pool. (It may be slow if the pool contains very many files as it computes them from scratch.)

Return Value

Hash with keys

:total_number (Integer)

Number of files in pool

:total_size (Integer)

Total number of bytes of all files

:median_size (Float)

Median of file sizes (most frequent size)

:last_add (Time)

Time and Date of last add operation



220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/file_pool.rb', line 220

def self.stat
  all_files = Dir.glob("#{root}_secured/*/*/*/*")
  all_files << Dir.glob("#{root}/*/*/*/*")
  all_stats = all_files.map{|f| File.stat(f) }

  {
    :total_size => all_stats.inject(0){|sum,stat| sum+=stat.size},
    :median_size => median(all_stats.map{|stat| stat.size}),
    :file_number => all_files.length,
    :last_add => all_stats.map{|stat| stat.ctime}.max
  }
end

.uuid ⇒ Object

return a new UUID type 4 (random) as String



251
252
253
 
# File 'lib/file_pool.rb', line 251

def self.uuid
  UUIDTools::UUID.random_create.to_s
end

.valid?(uuid) ⇒ Boolean

return true if uuid is a valid UUID type 4

Returns:

  • (Boolean) 


256
257
258
259
260
261
262
 
# File 'lib/file_pool.rb', line 256

def self.valid? uuid
  begin
    UUIDTools::UUID.parse(uuid).valid?
  rescue TypeError, ArgumentError
    return false
  end
end