Class: Hiera::Backend::Eyaml::EditHelper

Inherits:
Object
  • Object
show all
Defined in:
lib/hiera/backend/eyaml/edithelper.rb

Class Method Summary collapse

Class Method Details

.find_editor ⇒ Object

Raises:

  • (StandardError) 


7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/hiera/backend/eyaml/edithelper.rb', line 7

def self.find_editor
  editor = ENV.fetch('EDITOR', nil)
  editor ||= %w[/usr/bin/sensible-editor /usr/bin/editor /usr/bin/vim /usr/bin/vi].collect do |e|
    e if FileTest.executable? e
  end.compact.first
  raise StandardError, 'Editor not found. Please set your EDITOR env variable' if editor.nil?

  if editor.index(' ')
    editor = editor.dup if editor.frozen? # values from ENV are frozen
    editor.gsub!(/([^\\]|^)~/, '\1' + ENV.fetch('HOME', nil)) # replace ~ with home unless escaped
    editor.gsub!(/(^|[^\\])"/, '\1') # remove unescaped quotes during processing
    editor.gsub!('\\ ', ' ') # unescape spaces since we quote paths
    pieces = editor.split(' ')
    paths = # get possible paths, starting with longest
      pieces.each_with_index.map do |_, x|
        pieces[0..x].join(' ')
      end.reverse
    extensions = (ENV['PATHEXT'] || '').split(';') # handle Windows executables
    pathdirs = ENV['PATH'].split(File::PATH_SEPARATOR)
    paths += pathdirs.collect { |dir| paths.collect { |path| File.expand_path(path, dir) } }.flatten
    editorfile = paths.select do |path|
      FileTest.file?(path) || !extensions.select { |ext| FileTest.file?(path + ext) }.empty?
    end.first
    raise StandardError, 'Editor not found. Please set your EDITOR env variable' if editorfile.nil?

    raw_command = paths[(paths.index editorfile) % pieces.size]
    editor = "\"#{editorfile}\"#{editor[raw_command.size..-1]}"
  end
  editor
end

.secure_file_delete(args) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/hiera/backend/eyaml/edithelper.rb', line 38

def self.secure_file_delete(args)
  file = File.open(args[:file], 'r+')
  num_bytes = args[:num_bytes]
  [0xff, 0x55, 0xaa, 0x00].each do |byte|
    file.seek(0, IO::SEEK_SET)
    num_bytes.times { file.print(byte.chr) }
    file.fsync
  end
  file.close
  File.delete args[:file]
end

.write_tempfile(data_to_write) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/hiera/backend/eyaml/edithelper.rb', line 50

def self.write_tempfile(data_to_write)
  file = Tempfile.open(['eyaml_edit', '.yaml'])
  path = file.path
  file.close!

  file = File.open(path, 'w')
  file.chmod(0o600)
  if ENV['OS'] == 'Windows_NT'
    # Windows doesn't support chmod
    icacls = 'C:\Windows\system32\icacls.exe'
    if File.executable? icacls
      current_user = `C:\\Windows\\system32\\whoami.exe`.chomp
      # Use ACLs to restrict access to the current user only
      command = %(#{icacls} "#{file.path}" /grant:r "#{current_user}":f /inheritance:r)
      system "#{command} >NUL 2>&1"
    end
  end
  file.puts data_to_write
  file.close

  LoggingHelper.debug "Wrote temporary file: #{path}"

  path
end