Class: Homebrew::Livecheck::Strategy::Apache

Inherits:
Object
  • Object
show all
Defined in:
livecheck/strategy/apache.rb

Overview

The Apache strategy identifies versions of software at apache.org by checking directory listing pages.

Most Apache URLs start with https://www.apache.org/dyn/ and include a filename or path query string parameter where the value is a path to a file. The path takes one of the following formats:

  • example/1.2.3/example-1.2.3.tar.gz
  • example/example-1.2.3/example-1.2.3.tar.gz
  • example/example-1.2.3-bin.tar.gz

This strategy also handles a few common mirror/backup URLs where the path is provided outside of a query string parameter (e.g. https://archive.apache.org/dist/example/1.2.3/example-1.2.3.tar.gz).

When the path contains a version directory (e.g. /1.2.3/, /example-1.2.3/, etc.), the default regex matches numeric versions in directory names. Otherwise, the default regex matches numeric versions in filenames.

Constant Summary collapse

URL_MATCH_REGEX =

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.

The Regexp used to determine if the strategy applies to the URL.

%r{
  ^https?://
  (?:www\.apache\.org/dyn/.+(?:path|filename)=/?|
  archive\.apache\.org/dist/|
  dlcdn\.apache\.org/|
  downloads\.apache\.org/)
  (?<path>.+?)/      # Path to directory of files or version directories
  (?<prefix>[^/]*?)  # Any text in filename or directory before version
  v?\d+(?:\.\d+)+    # The numeric version
  (?<suffix>/|[^/]*) # Any text in filename or directory after version
}ix

Class Method Summary collapse

Class Method Details

.find_versions(url:, regex: nil, **unused, &block) ⇒ Hash{Symbol => T.untyped}

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.

Generates a URL and regex (if one isn't provided) and passes them to PageMatch.find_versions to identify versions in the content.

Parameters:

  • url (String) —

    the URL of the content to check

  • regex (Regexp, nil) (defaults to: nil) —

    a regex used for matching versions in content

  • unused (T.untyped)
  • block (Proc, nil)

Returns:



97
98
99
100
101
 
# File 'livecheck/strategy/apache.rb', line 97

def self.find_versions(url:, regex: nil, **unused, &block)
  generated = generate_input_values(url)

  PageMatch.find_versions(url: generated[:url], regex: regex || generated[:regex], **unused, &block)
end

.generate_input_values(url) ⇒ Hash{Symbol => T.untyped}

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.

Extracts information from a provided URL and uses it to generate various input values used by the strategy to check for new versions. Some of these values act as defaults and can be overridden in a livecheck block.

Parameters:

  • url (String) —

    the URL used to generate values

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'livecheck/strategy/apache.rb', line 59

def self.generate_input_values(url)
  values = {}

  match = url.match(URL_MATCH_REGEX)
  return values if match.blank?

  # Example URL: `https://archive.apache.org/dist/example/`
  values[:url] = "https://archive.apache.org/dist/#{match[:path]}/"

  regex_prefix = Regexp.escape(match[:prefix] || "").gsub("\\-", "-")

  # Use `\.t` instead of specific tarball extensions (e.g. .tar.gz)
  suffix = match[:suffix]&.sub(Strategy::TARBALL_EXTENSION_REGEX, ".t")
  regex_suffix = Regexp.escape(suffix || "").gsub("\\-", "-")

  # Example directory regex: `%r{href=["']?v?(\d+(?:\.\d+)+)/}i`
  # Example file regexes:
  # * `/href=["']?example-v?(\d+(?:\.\d+)+)\.t/i`
  # * `/href=["']?example-v?(\d+(?:\.\d+)+)-bin\.zip/i`
  values[:regex] = /href=["']?#{regex_prefix}v?(\d+(?:\.\d+)+)#{regex_suffix}/i

  values
end

.match?(url) ⇒ 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.

Whether the strategy can be applied to the provided URL.

Parameters:

  • url (String) —

    the URL to match against

Returns:

  • (Boolean) 


47
48
49
 
# File 'livecheck/strategy/apache.rb', line 47

def self.match?(url)
  URL_MATCH_REGEX.match?(url)
end