mirror of
https://github.com/Homebrew/brew.git
synced 2026-08-12 22:29:27 +04:00
Mike McQuaid
56f42e0e1d
- Tests reached into private APIs with `send` and poked internal state via `instance_variable_get`/`instance_variable_set`, hiding which interfaces specs really exercise and letting visibility rot. - Make every statically-poked method public and call it directly, keeping `public_send` only for dynamically-named public methods. - Read and write state through public `attr_*` accessors instead of instance variable reflection. - Add `Homebrew/NoSendInTests` and `Homebrew/NoInstanceVariableAccessInTests` cops scoped to `Library/Homebrew/test` so neither pattern creeps back in. - Keep rare justified disables, e.g. `Module#remove_const` is private core Ruby and raw memoisation state has no accessor.
272 lines
10 KiB
Ruby
272 lines
10 KiB
Ruby
# typed: strict
|
|
# frozen_string_literal: true
|
|
|
|
require "cask/artifact/relocated"
|
|
require "cask/quarantine"
|
|
|
|
module Cask
|
|
module Artifact
|
|
# Superclass for all artifacts that are installed by moving them to the target location.
|
|
class Moved < Relocated
|
|
sig { returns(String) }
|
|
def self.english_description
|
|
"#{english_name}s"
|
|
end
|
|
|
|
sig {
|
|
overridable.params(
|
|
adopt: T::Boolean,
|
|
auto_updates: T.nilable(T::Boolean),
|
|
force: T::Boolean,
|
|
verbose: T::Boolean,
|
|
predecessor: T.nilable(Cask),
|
|
successor: T.nilable(Cask),
|
|
reinstall: T::Boolean,
|
|
command: T.class_of(SystemCommand),
|
|
).void
|
|
}
|
|
def install_phase(adopt: false, auto_updates: false, force: false, verbose: false, predecessor: nil,
|
|
successor: nil, reinstall: false, command: SystemCommand)
|
|
move(adopt:, auto_updates:, force:, verbose:, predecessor:, successor:, reinstall:, command:)
|
|
end
|
|
|
|
sig {
|
|
overridable.params(
|
|
skip: T::Boolean,
|
|
force: T::Boolean,
|
|
adopt: T::Boolean,
|
|
verbose: T::Boolean,
|
|
successor: T.nilable(Cask),
|
|
upgrade: T::Boolean,
|
|
reinstall: T::Boolean,
|
|
command: T.class_of(SystemCommand),
|
|
).void
|
|
}
|
|
def uninstall_phase(skip: false, force: false, adopt: false, verbose: false, successor: nil, upgrade: false,
|
|
reinstall: false, command: SystemCommand)
|
|
move_back(skip:, force:, adopt:, successor:, command:)
|
|
end
|
|
|
|
sig { returns(String) }
|
|
def summarize_installed
|
|
if target.exist?
|
|
"#{printable_target} (#{target.abv})"
|
|
else
|
|
Formatter.error(printable_target, label: "Missing #{self.class.english_name}")
|
|
end
|
|
end
|
|
|
|
sig { overridable.params(target: Pathname, source: Pathname).returns(T::Array[T.any(String, Pathname)]) }
|
|
def backup_copy_args(target, source)
|
|
["-pR", target, source]
|
|
end
|
|
|
|
private
|
|
|
|
sig {
|
|
params(
|
|
adopt: T::Boolean,
|
|
auto_updates: T.nilable(T::Boolean),
|
|
force: T::Boolean,
|
|
verbose: T::Boolean,
|
|
predecessor: T.nilable(Cask),
|
|
successor: T.nilable(Cask),
|
|
reinstall: T::Boolean,
|
|
command: T.class_of(SystemCommand),
|
|
).returns(T.nilable(SystemCommand::Result))
|
|
}
|
|
def move(adopt: false, auto_updates: false, force: false, verbose: false, predecessor: nil, successor: nil,
|
|
reinstall: false, command: SystemCommand)
|
|
unless source.exist?
|
|
raise CaskError, "It seems the #{self.class.english_name} source '#{source}' is not there."
|
|
end
|
|
|
|
if Utils.path_occupied?(target)
|
|
if target.directory? && target.children.empty? && matching_artifact?(predecessor)
|
|
# An upgrade removed the directory contents but left the directory itself (see below).
|
|
unless source.directory?
|
|
if target.parent.writable? && !force
|
|
target.rmdir
|
|
else
|
|
Utils.gain_permissions_remove(target, command:)
|
|
end
|
|
end
|
|
else
|
|
if adopt
|
|
ohai "Adopting existing #{self.class.english_name} at '#{target}'"
|
|
|
|
unless auto_updates
|
|
source_plist = Pathname("#{source}/Contents/Info.plist")
|
|
target_plist = Pathname("#{target}/Contents/Info.plist")
|
|
same = if source_plist.size? &&
|
|
(source_bundle_version = Homebrew::BundleVersion.from_info_plist(source_plist)) &&
|
|
target_plist.size? &&
|
|
(target_bundle_version = Homebrew::BundleVersion.from_info_plist(target_plist))
|
|
if source_bundle_version.short_version == target_bundle_version.short_version
|
|
if source_bundle_version.version == target_bundle_version.version
|
|
true
|
|
else
|
|
onoe "The bundle version of #{source} is #{source_bundle_version.version} but " \
|
|
"is #{target_bundle_version.version} for #{target}!"
|
|
false
|
|
end
|
|
else
|
|
onoe "The bundle short version of #{source} is #{source_bundle_version.short_version} but " \
|
|
"is #{target_bundle_version.short_version} for #{target}!"
|
|
false
|
|
end
|
|
else
|
|
command.run(
|
|
"/usr/bin/diff",
|
|
args: ["--recursive", "--brief", source, target],
|
|
verbose:,
|
|
print_stdout: verbose,
|
|
).success?
|
|
end
|
|
|
|
unless same
|
|
raise CaskError,
|
|
"It seems the existing #{self.class.english_name} is different from " \
|
|
"the one being installed."
|
|
end
|
|
end
|
|
|
|
# Remove the source as we don't need to move it to the target location
|
|
FileUtils.rm_r(source)
|
|
|
|
return post_move(command)
|
|
end
|
|
|
|
message = "It seems there is already #{self.class.english_article} " \
|
|
"#{self.class.english_name} at '#{target}'"
|
|
raise CaskError, "#{message}." if !force && !adopt
|
|
|
|
opoo "#{message}; overwriting."
|
|
delete(target, force:, successor:, command:)
|
|
end
|
|
end
|
|
|
|
ohai "Moving #{self.class.english_name} '#{source.basename}' to '#{target}'"
|
|
|
|
Utils.gain_permissions_mkpath(target.dirname, command:) unless target.dirname.exist?
|
|
|
|
if target.directory? && Quarantine.app_management_permissions_granted?(app: target, command:)
|
|
if target.writable?
|
|
source.children.each { |child| FileUtils.move(child, target/child.basename) }
|
|
else
|
|
command.run!("/bin/cp", args: ["-pR", *source.children, target],
|
|
sudo: true)
|
|
end
|
|
Quarantine.copy_xattrs(source, target, command:)
|
|
FileUtils.rm_r(source)
|
|
elsif target.dirname.writable?
|
|
FileUtils.move(source, target)
|
|
else
|
|
# default sudo user isn't necessarily able to write to Homebrew's locations
|
|
# e.g. with runas_default set in the sudoers (5) file.
|
|
command.run!("/bin/cp", args: ["-pR", source, target], sudo: true)
|
|
FileUtils.rm_r(source)
|
|
end
|
|
|
|
post_move(command)
|
|
end
|
|
|
|
# Performs any actions necessary after the source has been moved to the target location.
|
|
sig { params(command: T.class_of(SystemCommand)).returns(T.nilable(SystemCommand::Result)) }
|
|
def post_move(command)
|
|
FileUtils.ln_sf target, source
|
|
|
|
add_altname_metadata(target, source.basename, command:)
|
|
end
|
|
|
|
sig { params(cask: T.nilable(Cask)).returns(T::Boolean) }
|
|
def matching_artifact?(cask)
|
|
return false unless cask
|
|
|
|
cask.artifacts.any? do |a|
|
|
a.instance_of?(self.class) && instance_of?(a.class) && a.target == target
|
|
end
|
|
end
|
|
|
|
sig {
|
|
params(
|
|
skip: T::Boolean,
|
|
force: T::Boolean,
|
|
adopt: T::Boolean,
|
|
command: T.class_of(SystemCommand),
|
|
successor: T.nilable(Cask),
|
|
).void
|
|
}
|
|
def move_back(skip: false, force: false, adopt: false, command: SystemCommand, successor: nil)
|
|
FileUtils.rm source if source.symlink? && source.dirname.join(source.readlink) == target
|
|
|
|
if Utils.path_occupied?(source)
|
|
message = "It seems there is already #{self.class.english_article} " \
|
|
"#{self.class.english_name} at '#{source}'"
|
|
raise CaskError, "#{message}." if !force && !adopt
|
|
|
|
opoo "#{message}; overwriting."
|
|
delete(source, force:, successor:, command:)
|
|
end
|
|
|
|
unless target.exist?
|
|
return if skip || force
|
|
|
|
raise CaskError, "It seems the #{self.class.english_name} source '#{target}' is not there."
|
|
end
|
|
|
|
ohai "Backing up #{self.class.english_name} '#{target.basename}' to '#{source}'"
|
|
source.dirname.mkpath
|
|
|
|
# We need to preserve extended attributes between copies.
|
|
# This may fail and need sudo if the source has files with restricted permissions.
|
|
[!source.parent.writable?, true].uniq.each do |sudo|
|
|
result = command.run(
|
|
"/bin/cp",
|
|
args: backup_copy_args(target, source),
|
|
must_succeed: sudo,
|
|
sudo:,
|
|
)
|
|
break if result.success?
|
|
end
|
|
|
|
delete(target, force:, successor:, command:)
|
|
end
|
|
|
|
sig {
|
|
params(
|
|
target: Pathname,
|
|
force: T::Boolean,
|
|
successor: T.nilable(Cask),
|
|
command: T.class_of(SystemCommand),
|
|
).void
|
|
}
|
|
def delete(target, force: false, successor: nil, command: SystemCommand)
|
|
ohai "Removing #{self.class.english_name} '#{target}'"
|
|
raise CaskError, "Cannot remove undeletable #{self.class.english_name}." if undeletable?(target)
|
|
|
|
return unless Utils.path_occupied?(target)
|
|
|
|
if target.directory? && matching_artifact?(successor) && Quarantine.app_management_permissions_granted?(
|
|
app: target, command:,
|
|
)
|
|
# If an app folder is deleted, macOS considers the app uninstalled and removes some data.
|
|
# Remove only the contents to handle this case.
|
|
target.children.each do |child|
|
|
Utils.gain_permissions_remove(child, command:)
|
|
end
|
|
else
|
|
Utils.gain_permissions_remove(target, command:)
|
|
end
|
|
end
|
|
|
|
sig { params(target: Pathname).returns(T::Boolean) }
|
|
def undeletable?(target)
|
|
!target.parent.writable?
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
require "extend/os/cask/artifact/moved"
|