103 lines
3.5 KiB
Ruby
103 lines
3.5 KiB
Ruby
# typed: strict
|
|
# frozen_string_literal: true
|
|
|
|
require "livecheck/strategic"
|
|
|
|
module Homebrew
|
|
module Livecheck
|
|
module Strategy
|
|
# The {HeaderMatch} strategy follows all URL redirections and scans
|
|
# the resulting headers for matching text using the provided regex.
|
|
#
|
|
# This strategy is not applied automatically and it's necessary to use
|
|
# `strategy :header_match` in a `livecheck` block to apply it.
|
|
class HeaderMatch
|
|
extend Strategic
|
|
|
|
NICE_NAME = "Header match"
|
|
|
|
# A priority of zero causes livecheck to skip the strategy. We do this
|
|
# for {HeaderMatch} so we can selectively apply it when appropriate.
|
|
PRIORITY = 0
|
|
|
|
# The `Regexp` used to determine if the strategy applies to the URL.
|
|
URL_MATCH_REGEX = %r{^https?://}i
|
|
|
|
# The header fields to check when a `strategy` block isn't provided.
|
|
DEFAULT_HEADERS_TO_CHECK = T.let(["content-disposition", "location"].freeze, T::Array[String])
|
|
|
|
# Whether the strategy can be applied to the provided URL.
|
|
#
|
|
# @param url [String] the URL to match against
|
|
# @return [Boolean]
|
|
sig { override.params(url: String).returns(T::Boolean) }
|
|
def self.match?(url)
|
|
URL_MATCH_REGEX.match?(url)
|
|
end
|
|
|
|
# Identify versions from HTTP headers.
|
|
#
|
|
# @param headers [Hash] a hash of HTTP headers to check for versions
|
|
# @param regex [Regexp, nil] a regex for matching versions
|
|
# @return [Array]
|
|
sig {
|
|
params(
|
|
headers: T::Hash[String, String],
|
|
regex: T.nilable(Regexp),
|
|
block: T.nilable(Proc),
|
|
).returns(T::Array[String])
|
|
}
|
|
def self.versions_from_headers(headers, regex = nil, &block)
|
|
if block
|
|
block_return_value = regex.present? ? yield(headers, regex) : yield(headers)
|
|
return Strategy.handle_block_return(block_return_value)
|
|
end
|
|
|
|
DEFAULT_HEADERS_TO_CHECK.filter_map do |header_name|
|
|
header_value = headers[header_name]
|
|
next if header_value.blank?
|
|
|
|
if regex
|
|
header_value[regex, 1]
|
|
else
|
|
v = Version.parse(header_value, detected_from_url: true)
|
|
v.null? ? nil : v.to_s
|
|
end
|
|
end.uniq
|
|
end
|
|
|
|
# Checks the final URL for new versions after following all redirections,
|
|
# using the provided regex for matching.
|
|
#
|
|
# @param url [String] the URL to fetch
|
|
# @param regex [Regexp, nil] a regex used for matching versions
|
|
# @param options [Options] options to modify behavior
|
|
# @return [Hash]
|
|
sig {
|
|
override(allow_incompatible: true).params(
|
|
url: String,
|
|
regex: T.nilable(Regexp),
|
|
options: Options,
|
|
block: T.nilable(Proc),
|
|
).returns(T::Hash[Symbol, T.anything])
|
|
}
|
|
def self.find_versions(url:, regex: nil, options: Options.new, &block)
|
|
match_data = { matches: {}, regex:, url: }
|
|
|
|
headers = Strategy.page_headers(url, options:)
|
|
|
|
# Merge the headers from all responses into one hash
|
|
merged_headers = headers.reduce(&:merge)
|
|
return match_data if merged_headers.blank?
|
|
|
|
versions_from_headers(merged_headers, regex, &block).each do |version_text|
|
|
match_data[:matches][version_text] = Version.new(version_text)
|
|
end
|
|
|
|
match_data
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|