Module: Cask::Utils Private

Defined in:
cask/utils.rb

Overview

This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.

Helper functions for various cask operations.

Constant Summary collapse

BUG_REPORTS_URL =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"https://github.com/Homebrew/homebrew-cask#reporting-bugs"

Class Method Summary collapse

Class Method Details

.error_message_with_suggestions ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



123
124
125
126
127
128
 
# File 'cask/utils.rb', line 123

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

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



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
94
95
96
97
98
99
100
101
102
103
 
# File 'cask/utils.rb', line 61

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
      print_stderr = Context.current.debug? || Context.current.verbose?
      # 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",
                  print_stderr:,
                  args:         command_args + ["--", "000", path])
      command.run("/bin/chmod",
                  print_stderr:,
                  args:         command_args + ["--", "u+rwx", path])
      command.run("/bin/chmod",
                  print_stderr:,
                  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` and `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

    raise
  end
end

.gain_permissions_mkpath(path, command: SystemCommand) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



12
13
14
15
16
17
18
19
20
21
 
# File 'cask/utils.rb', line 12

def self.gain_permissions_mkpath(path, command: SystemCommand)
  dir = path.ascend.find(&:directory?)
  return if path == dir

  if dir.writable?
    path.mkpath
  else
    command.run!("/bin/mkdir", args: ["-p", "--", path], sudo: true, print_stderr: false)
  end
end

.gain_permissions_remove(path, command: SystemCommand) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



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
 
# File 'cask/utils.rb', line 33

def self.gain_permissions_remove(path, command: SystemCommand)
  directory = false
  permission_flags = if path.symlink?
    ["-h"]
  elsif path.directory?
    directory = true
    ["-R"]
  elsif path.exist?
    []
  else
    # Nothing to remove.
    return
  end

  gain_permissions(path, permission_flags, command) do |p|
    if p.parent.writable?
      if directory
        FileUtils.rm_r p
      else
        FileUtils.rm_f p
      end
    else
      recursive_flag = directory ? ["-R"] : []
      command.run!("/bin/rm", args: recursive_flag + ["-f", "--", p], sudo: true, print_stderr: false)
    end
  end
end

.gain_permissions_rmdir(path, command: SystemCommand) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



23
24
25
26
27
28
29
30
31
 
# File 'cask/utils.rb', line 23

def self.gain_permissions_rmdir(path, command: SystemCommand)
  gain_permissions(path, [], command) do |p|
    if p.parent.writable?
      FileUtils.rmdir p
    else
      command.run!("/bin/rmdir", args: ["--", p], sudo: true, print_stderr: false)
    end
  end
end

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

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



130
131
132
133
134
135
136
 
# File 'cask/utils.rb', line 130

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

  ofail "#{message}\n#{error_message_with_suggestions}"
end

.path_occupied?(path) ⇒ Boolean

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

  • (Boolean) 


106
107
108
 
# File 'cask/utils.rb', line 106

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

.token_from(name) ⇒ String

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:



111
112
113
114
115
116
117
118
119
120
 
# File 'cask/utils.rb', line 111

def self.token_from(name)
  name.downcase
      .gsub("+", "-plus-")
      .gsub("@", "-at-")
      .gsub(/[ _·•]/, "-")
      .gsub(/[^\w-]/, "")
      .gsub(/--+/, "-")
      .delete_prefix("-")
      .delete_suffix("-")
end