admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

cask_loader: improve error handling.

Browse Source 
Handle weird edge cases where we try to read a cask from invalid paths.
This commit is contained in:
Mike McQuaid 2025-06-06 14:18:56 +01:00
parent b23bc5e0fe
commit e7f667c198
No known key found for this signature in database
1 changed files with 23 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Library/Homebrew/cask/cask_loader.rb
View File

@ -6,6 +6,7 @@ require "cask/cask"
require "uri" require "uri"
require "utils/curl" require "utils/curl"
require "extend/hash/keys" require "extend/hash/keys"
require "api"
module Cask module Cask
# Loads a cask from various sources. # Loads a cask from various sources.
@ -104,8 +105,8 @@ module Cask
return return
end end
return if %w[.rb .json].exclude?(path.extname)
return unless path.expand_path.exist? return unless path.expand_path.exist?
return if invalid_path?(path)
return if Homebrew::EnvConfig.forbid_packages_from_paths? && return if Homebrew::EnvConfig.forbid_packages_from_paths? &&
!path.realpath.to_s.start_with?("#{Caskroom.path}/", "#{HOMEBREW_LIBRARY}/Taps/") !path.realpath.to_s.start_with?("#{Caskroom.path}/", "#{HOMEBREW_LIBRARY}/Taps/")
@ -113,6 +114,14 @@ module Cask
new(path) new(path)
end end
sig { params(pathname: Pathname, valid_extnames: T::Array[String]).returns(T::Boolean) }
def self.invalid_path?(pathname, valid_extnames: %w[.rb .json])
return true if valid_extnames.exclude?(pathname.extname)
@invalid_basenames ||= %w[INSTALL_RECEIPT.json sbom.spdx.json].freeze
@invalid_basenames.include?(pathname.basename.to_s)
end
attr_reader :token, :path attr_reader :token, :path
sig { params(path: T.any(Pathname, String), token: String).void } sig { params(path: T.any(Pathname, String), token: String).void }
@ -135,8 +144,10 @@ module Cask
@content = path.read(encoding: "UTF-8") @content = path.read(encoding: "UTF-8")
@config = config @config = config
if path.extname == ".json" if !self.class.invalid_path?(path, valid_extnames: %w[.json]) &&
return FromAPILoader.new(token, from_json: JSON.parse(@content), path:).load(config:) (from_json = JSON.parse(@content).presence) &&
from_json.is_a?(Hash)
return FromAPILoader.new(token, from_json:, path:).load(config:)
end end
begin begin
@ -284,7 +295,7 @@ module Cask
sig { returns(Pathname) } sig { returns(Pathname) }
attr_reader :path attr_reader :path
sig { returns(T.nilable(Hash)) } sig { returns(T.nilable(T::Hash[T.any(String, Symbol), T.anything])) }
attr_reader :from_json attr_reader :from_json
sig { sig {
@ -306,7 +317,13 @@ module Cask
new("#{tap}/#{token}") new("#{tap}/#{token}")
end end
sig { params(token: String, from_json: Hash, path: T.nilable(Pathname)).void } sig {
params(
token: String,
from_json: T.nilable(T::Hash[T.any(String, Symbol), T.anything]),
path: T.nilable(Pathname),
).void
}
def initialize(token, from_json: T.unsafe(nil), path: nil) def initialize(token, from_json: T.unsafe(nil), path: nil)
@token = token.sub(%r{^homebrew/(?:homebrew-)?cask/}i, "") @token = token.sub(%r{^homebrew/(?:homebrew-)?cask/}i, "")
@sourcefile_path = path || Homebrew::API::Cask.cached_json_file_path @sourcefile_path = path || Homebrew::API::Cask.cached_json_file_path
@ -400,7 +417,7 @@ module Cask
container(**container_hash) container(**container_hash)
end end
json_cask[:artifacts].each do |artifact| json_cask[:artifacts]&.each do |artifact|
# convert generic string replacements into actual ones # convert generic string replacements into actual ones
artifact = cask.loader.from_h_gsubs(artifact, appdir) artifact = cask.loader.from_h_gsubs(artifact, appdir)
key = artifact.keys.first key = artifact.keys.first