2022-10-11 00:52:32 +01:00
|
|
|
# typed: true
|
2019-04-19 15:38:03 +09:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2018-09-03 19:39:07 +01:00
|
|
|
require "cask/artifact/relocated"
|
2023-04-03 20:21:37 -05:00
|
|
|
require "cask/quarantine"
|
2016-08-18 22:11:42 +03:00
|
|
|
|
2018-09-06 08:29:14 +02:00
|
|
|
module Cask
|
2016-09-24 13:52:43 +02:00
|
|
|
module Artifact
|
2020-11-05 17:17:03 -05:00
|
|
|
# Superclass for all artifacts that are installed by moving them to the target location.
|
2020-08-19 10:23:41 +02:00
|
|
|
#
|
|
|
|
# @api private
|
2016-09-24 13:52:43 +02:00
|
|
|
class Moved < Relocated
|
2020-10-20 12:03:48 +02:00
|
|
|
extend T::Sig
|
|
|
|
|
|
|
|
sig { returns(String) }
|
2016-09-24 13:52:43 +02:00
|
|
|
def self.english_description
|
2017-04-06 00:33:31 +02:00
|
|
|
"#{english_name}s"
|
2016-09-24 13:52:43 +02:00
|
|
|
end
|
2016-08-18 22:11:42 +03:00
|
|
|
|
2017-04-06 00:33:31 +02:00
|
|
|
def install_phase(**options)
|
2017-11-16 10:40:32 -03:00
|
|
|
move(**options)
|
2016-09-24 13:52:43 +02:00
|
|
|
end
|
2016-08-18 22:11:42 +03:00
|
|
|
|
2017-04-06 00:33:31 +02:00
|
|
|
def uninstall_phase(**options)
|
2017-11-16 10:40:32 -03:00
|
|
|
move_back(**options)
|
2017-04-06 00:33:31 +02:00
|
|
|
end
|
|
|
|
|
|
|
|
def summarize_installed
|
|
|
|
if target.exist?
|
|
|
|
"#{printable_target} (#{target.abv})"
|
|
|
|
else
|
|
|
|
Formatter.error(printable_target, label: "Missing #{self.class.english_name}")
|
|
|
|
end
|
2016-09-24 13:52:43 +02:00
|
|
|
end
|
2016-08-18 22:11:42 +03:00
|
|
|
|
2016-09-24 13:52:43 +02:00
|
|
|
private
|
2016-08-18 22:11:42 +03:00
|
|
|
|
2023-04-08 16:13:12 -05:00
|
|
|
def move(adopt: false, force: false, verbose: false, predecessor: nil, reinstall: false,
|
2023-04-04 11:36:27 -05:00
|
|
|
command: nil, **options)
|
2022-10-21 23:28:51 -04:00
|
|
|
unless source.exist?
|
|
|
|
raise CaskError, "It seems the #{self.class.english_name} source '#{source}' is not there."
|
|
|
|
end
|
|
|
|
|
2016-09-24 13:52:43 +02:00
|
|
|
if Utils.path_occupied?(target)
|
2023-04-08 16:13:12 -05:00
|
|
|
if !predecessor.nil? && target.directory? && target.children.empty? && predecessor.artifacts.any? do |a|
|
2023-04-24 10:50:01 -05:00
|
|
|
a.instance_of?(self.class) && instance_of?(a.class) && a.target == target
|
2023-04-08 16:13:12 -05:00
|
|
|
end
|
2023-04-03 17:13:57 -05:00
|
|
|
# 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: command)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
else
|
|
|
|
if adopt
|
|
|
|
ohai "Adopting existing #{self.class.english_name} at '#{target}'"
|
|
|
|
same = command.run(
|
|
|
|
"/usr/bin/diff",
|
|
|
|
args: ["--recursive", "--brief", source, target],
|
|
|
|
verbose: verbose,
|
|
|
|
print_stdout: verbose,
|
|
|
|
).success?
|
|
|
|
|
|
|
|
unless same
|
|
|
|
raise CaskError,
|
|
|
|
"It seems the existing #{self.class.english_name} is different from " \
|
|
|
|
"the one being installed."
|
|
|
|
end
|
|
|
|
|
|
|
|
# Remove the source as we don't need to move it to the target location
|
|
|
|
source.rmtree
|
|
|
|
|
|
|
|
return post_move(command)
|
2022-10-21 23:28:51 -04:00
|
|
|
end
|
|
|
|
|
2023-04-03 17:13:57 -05:00
|
|
|
message = "It seems there is already #{self.class.english_article} " \
|
|
|
|
"#{self.class.english_name} at '#{target}'"
|
|
|
|
raise CaskError, "#{message}." unless force
|
2022-10-21 23:28:51 -04:00
|
|
|
|
2023-04-03 17:13:57 -05:00
|
|
|
opoo "#{message}; overwriting."
|
|
|
|
delete(target, force: force, command: command, **options)
|
2022-10-21 23:28:51 -04:00
|
|
|
end
|
2016-09-24 13:52:43 +02:00
|
|
|
end
|
2017-03-10 09:33:48 +01:00
|
|
|
|
2021-01-26 15:21:24 -05:00
|
|
|
ohai "Moving #{self.class.english_name} '#{source.basename}' to '#{target}'"
|
2023-01-13 16:15:31 -08:00
|
|
|
|
|
|
|
unless target.dirname.exist?
|
|
|
|
if target.dirname.ascend.find(&:directory?).writable?
|
|
|
|
target.dirname.mkpath
|
|
|
|
else
|
|
|
|
command.run!("/bin/mkdir", args: ["-p", target.dirname], sudo: true)
|
|
|
|
end
|
2019-02-06 21:18:06 +01:00
|
|
|
end
|
2017-04-01 01:53:29 +02:00
|
|
|
|
2023-04-03 17:13:57 -05:00
|
|
|
if target.directory?
|
|
|
|
if target.writable?
|
|
|
|
source.children.each { |child| FileUtils.move(child, target + child.basename) }
|
|
|
|
else
|
|
|
|
command.run!("/bin/cp", args: ["-pR", "#{source}/*", "#{source}/.*", "#{target}/"],
|
|
|
|
sudo: true)
|
|
|
|
end
|
2023-04-03 20:21:37 -05:00
|
|
|
unless Quarantine.copy_xattrs(source, target)
|
|
|
|
opoo "Unable to transfer extended attributes on the root directory"
|
|
|
|
end
|
2023-04-03 17:13:57 -05:00
|
|
|
source.rmtree
|
|
|
|
elsif target.dirname.writable?
|
2017-04-01 01:53:29 +02:00
|
|
|
FileUtils.move(source, target)
|
|
|
|
else
|
2023-01-13 18:10:21 -08:00
|
|
|
# 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)
|
|
|
|
source.rmtree
|
2017-04-01 01:53:29 +02:00
|
|
|
end
|
|
|
|
|
2022-10-21 23:28:51 -04:00
|
|
|
post_move(command)
|
|
|
|
end
|
|
|
|
|
|
|
|
# Performs any actions necessary after the source has been moved to the target location.
|
|
|
|
def post_move(command)
|
2019-10-24 15:15:40 +02:00
|
|
|
FileUtils.ln_sf target, source
|
|
|
|
|
2017-04-06 00:33:31 +02:00
|
|
|
add_altname_metadata(target, source.basename, command: command)
|
2016-09-24 13:52:43 +02:00
|
|
|
end
|
2016-08-18 22:11:42 +03:00
|
|
|
|
2017-11-16 10:40:32 -03:00
|
|
|
def move_back(skip: false, force: false, command: nil, **options)
|
2019-10-24 15:15:40 +02:00
|
|
|
FileUtils.rm source if source.symlink? && source.dirname.join(source.readlink) == target
|
|
|
|
|
2017-11-16 10:40:32 -03:00
|
|
|
if Utils.path_occupied?(source)
|
2018-09-02 16:15:09 +01:00
|
|
|
message = "It seems there is already #{self.class.english_article} " \
|
|
|
|
"#{self.class.english_name} at '#{source}'"
|
2017-11-16 10:40:32 -03:00
|
|
|
raise CaskError, "#{message}." unless force
|
2018-09-17 02:45:00 +02:00
|
|
|
|
2017-11-16 10:40:32 -03:00
|
|
|
opoo "#{message}; overwriting."
|
|
|
|
delete(source, force: force, command: command, **options)
|
|
|
|
end
|
|
|
|
|
|
|
|
unless target.exist?
|
2018-04-28 19:17:28 +10:00
|
|
|
return if skip || force
|
2018-09-17 02:45:00 +02:00
|
|
|
|
2017-11-16 10:40:32 -03:00
|
|
|
raise CaskError, "It seems the #{self.class.english_name} source '#{target}' is not there."
|
|
|
|
end
|
|
|
|
|
2021-01-26 15:21:24 -05:00
|
|
|
ohai "Backing #{self.class.english_name} '#{target.basename}' up to '#{source}'"
|
2017-11-16 10:40:32 -03:00
|
|
|
source.dirname.mkpath
|
|
|
|
|
2018-08-31 13:16:11 +00:00
|
|
|
# We need to preserve extended attributes between copies.
|
2023-01-13 13:37:50 -08:00
|
|
|
command.run!("/bin/cp", args: ["-pR", target, source], sudo: !source.parent.writable?)
|
2018-01-21 19:10:30 +10:00
|
|
|
|
|
|
|
delete(target, force: force, command: command, **options)
|
2017-11-16 10:40:32 -03:00
|
|
|
end
|
|
|
|
|
2023-04-08 16:13:12 -05:00
|
|
|
def delete(target, force: false, successor: nil, command: nil, **_)
|
2021-01-26 15:21:24 -05:00
|
|
|
ohai "Removing #{self.class.english_name} '#{target}'"
|
2017-04-06 00:33:31 +02:00
|
|
|
raise CaskError, "Cannot remove undeletable #{self.class.english_name}." if MacOS.undeletable?(target)
|
2016-09-20 15:11:33 +02:00
|
|
|
|
2017-04-01 01:53:29 +02:00
|
|
|
return unless Utils.path_occupied?(target)
|
|
|
|
|
2023-04-08 16:13:12 -05:00
|
|
|
if !successor.nil? && target.directory? && successor.artifacts.any? do |a|
|
2023-04-24 10:50:01 -05:00
|
|
|
a.instance_of?(self.class) && instance_of?(a.class) && a.target == self.target
|
2023-04-08 16:13:12 -05:00
|
|
|
end
|
2023-04-03 17:13:57 -05:00
|
|
|
# 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|
|
|
|
|
if target.writable? && !force
|
|
|
|
child.rmtree
|
|
|
|
else
|
|
|
|
Utils.gain_permissions_remove(child, command: command)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
elsif target.parent.writable? && !force
|
2016-09-24 13:52:43 +02:00
|
|
|
target.rmtree
|
2017-04-01 01:53:29 +02:00
|
|
|
else
|
2017-04-06 00:33:31 +02:00
|
|
|
Utils.gain_permissions_remove(target, command: command)
|
2016-09-24 13:52:43 +02:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2016-08-18 22:11:42 +03:00
|
|
|
end
|
|
|
|
end
|