Module: Cask::Utils

Defined in:
brew/Library/Homebrew/cask/utils.rb

Class Method Summary collapse

Class Method Details

.error_message_with_suggestionsObject



72
73
74
75
76
77
# File 'brew/Library/Homebrew/cask/utils.rb', line 72

def self.error_message_with_suggestions
  <<~EOS
    Follow the instructions here:
      #{Formatter.url(BUG_REPORTS_URL)}
  EOS
end

.gain_permissions(path, command_args, command) ⇒ Object



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'brew/Library/Homebrew/cask/utils.rb', line 28

def self.gain_permissions(path, command_args, command)
  tried_permissions = false
  tried_ownership = false
  begin
    yield path
  rescue
    # in case of permissions problems
    unless tried_permissions
      # TODO: Better handling for the case where path is a symlink.
      #       The -h and -R flags cannot be combined, and behavior is
      #       dependent on whether the file argument has a trailing
      #       slash.  This should do the right thing, but is fragile.
      command.run("/usr/bin/chflags",
                  must_succeed: false,
                  args:         command_args + ["--", "000", path])
      command.run("/bin/chmod",
                  must_succeed: false,
                  args:         command_args + ["--", "u+rwx", path])
      command.run("/bin/chmod",
                  must_succeed: false,
                  args:         command_args + ["-N", path])
      tried_permissions = true
      retry # rmtree
    end
    unless tried_ownership
      # in case of ownership problems
      # TODO: Further examine files to see if ownership is the problem
      #       before using sudo+chown
      ohai "Using sudo to gain ownership of path '#{path}'"
      command.run("/usr/sbin/chown",
                  args: command_args + ["--", User.current, path],
                  sudo: true)
      tried_ownership = true
      # retry chflags/chmod after chown
      tried_permissions = false
      retry # rmtree
    end
  end
end

.gain_permissions_remove(path, command: SystemCommand) ⇒ Object



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# File 'brew/Library/Homebrew/cask/utils.rb', line 12

def self.gain_permissions_remove(path, command: SystemCommand)
  if path.respond_to?(:rmtree) && path.exist?
    gain_permissions(path, ["-R"], command) do |p|
      if p.parent.writable?
        p.rmtree
      else
        command.run("/bin/rm",
                    args: ["-r", "-f", "--", p],
                    sudo: true)
      end
    end
  elsif File.symlink?(path)
    gain_permissions(path, ["-h"], command, &FileUtils.method(:rm_f))
  end
end

.method_missing_message(method, token, section = nil) ⇒ Object



79
80
81
82
83
84
85
86
# File 'brew/Library/Homebrew/cask/utils.rb', line 79

def self.method_missing_message(method, token, section = nil)
  poo = []
  poo << "Unexpected method '#{method}' called"
  poo << "during #{section}" if section
  poo << "on Cask #{token}."

  opoo(poo.join(" ") + "\n" + error_message_with_suggestions)
end

.path_occupied?(path) ⇒ Boolean

Returns:

  • (Boolean)


68
69
70
# File 'brew/Library/Homebrew/cask/utils.rb', line 68

def self.path_occupied?(path)
  File.exist?(path) || File.symlink?(path)
end