require "digest/md5" require "tap" # The Formulary is responsible for creating instances of Formula. # It is not meant to be used directy from formulae. class Formulary FORMULAE = {} def self.formula_class_defined?(path) FORMULAE.key?(path) end def self.formula_class_get(path) FORMULAE.fetch(path) end def self.load_formula(name, path, contents, namespace) mod = Module.new const_set(namespace, mod) mod.module_eval(contents, path) class_name = class_s(name) begin mod.const_get(class_name) rescue NameError => original_exception class_list = mod.constants. map { |const_name| mod.const_get(const_name) }. select { |const| const.is_a?(Class) } e = FormulaClassUnavailableError.new(name, path, class_name, class_list) raise e, "", original_exception.backtrace end end def self.load_formula_from_path(name, path) contents = path.open("r") { |f| set_encoding(f).read } namespace = "FormulaNamespace#{Digest::MD5.hexdigest(path.to_s)}" klass = load_formula(name, path, contents, namespace) FORMULAE[path] = klass end if IO.method_defined?(:set_encoding) def self.set_encoding(io) io.set_encoding(Encoding::UTF_8) end else def self.set_encoding(io) io end end def self.class_s(name) class_name = name.capitalize class_name.gsub!(/[-_.\s]([a-zA-Z0-9])/) { $1.upcase } class_name.tr!("+", "x") class_name end # A FormulaLoader returns instances of formulae. # Subclasses implement loaders for particular sources of formulae. class FormulaLoader # The formula's name attr_reader :name # The formula's ruby file's path or filename attr_reader :path def initialize(name, path) @name = name @path = path.resolved_path end # Gets the formula instance. def get_formula(spec) klass.new(name, path, spec) end def klass load_file unless Formulary.formula_class_defined?(path) Formulary.formula_class_get(path) end private def load_file STDERR.puts "#{$0} (#{self.class.name}): loading #{path}" if ARGV.debug? raise FormulaUnavailableError.new(name) unless path.file? Formulary.load_formula_from_path(name, path) end end # Loads formulae from bottles. class BottleLoader < FormulaLoader def initialize(bottle_name) @bottle_filename = Pathname(bottle_name).realpath name, full_name = bottle_resolve_formula_names @bottle_filename super name, Formulary.path(full_name) end def get_formula(spec) formula = super formula.local_bottle_path = @bottle_filename formula_version = formula.pkg_version bottle_version = bottle_resolve_version(@bottle_filename) unless formula_version == bottle_version raise BottleVersionMismatchError.new(@bottle_filename, bottle_version, formula, formula_version) end formula end end class AliasLoader < FormulaLoader def initialize(alias_path) path = alias_path.resolved_path name = path.basename(".rb").to_s super name, path end end # Loads formulae from disk using a path class FromPathLoader < FormulaLoader def initialize(path) path = Pathname.new(path).expand_path super path.basename(".rb").to_s, path end end # Loads formulae from URLs class FromUrlLoader < FormulaLoader attr_reader :url def initialize(url) @url = url uri = URI(url) formula = File.basename(uri.path, ".rb") super formula, HOMEBREW_CACHE_FORMULA/File.basename(uri.path) end def load_file HOMEBREW_CACHE_FORMULA.mkpath FileUtils.rm_f(path) curl url, "-o", path super end end # Loads tapped formulae. class TapLoader < FormulaLoader attr_reader :tap def initialize(tapped_name) user, repo, name = tapped_name.split("/", 3).map(&:downcase) @tap = Tap.fetch user, repo formula_dir = @tap.formula_dir || @tap.path path = formula_dir/"#{name}.rb" unless path.file? if (possible_alias = @tap.alias_dir/name).file? path = possible_alias.resolved_path name = path.basename(".rb").to_s elsif (new_name = @tap.formula_renames[name]) && (new_path = formula_dir/"#{new_name}.rb").file? path = new_path name = new_name end end super name, path end def get_formula(spec) super rescue FormulaUnavailableError => e raise TapFormulaUnavailableError.new(tap, name), "", e.backtrace end end class NullLoader < FormulaLoader def initialize(name) super name, Formulary.core_path(name) end def get_formula(_spec) raise FormulaUnavailableError.new(name) end end # Load formulae directly from their contents class FormulaContentsLoader < FormulaLoader # The formula's contents attr_reader :contents def initialize(name, path, contents) @contents = contents super name, path end def klass STDERR.puts "#{$0} (#{self.class.name}): loading #{path}" if ARGV.debug? namespace = "FormulaNamespace#{Digest::MD5.hexdigest(contents)}" Formulary.load_formula(name, path, contents, namespace) end end # Return a Formula instance for the given reference. # `ref` is string containing: # * a formula name # * a formula pathname # * a formula URL # * a local bottle reference def self.factory(ref, spec = :stable) loader_for(ref).get_formula(spec) end # Return a Formula instance for the given rack. # It will auto resolve formula's spec when requested spec is nil def self.from_rack(rack, spec = nil) kegs = rack.directory? ? rack.subdirs.map { |d| Keg.new(d) } : [] keg = kegs.detect(&:linked?) || kegs.detect(&:optlinked?) || kegs.max_by(&:version) return factory(rack.basename.to_s, spec || :stable) unless keg tab = Tab.for_keg(keg) tap = tab.tap spec ||= tab.spec if tap.nil? factory(rack.basename.to_s, spec) else begin factory("#{tap}/#{rack.basename}", spec) rescue FormulaUnavailableError # formula may be migrated to different tap. Try to search in core and all taps. factory(rack.basename.to_s, spec) end end end # Return a Formula instance directly from contents def self.from_contents(name, path, contents, spec = :stable) FormulaContentsLoader.new(name, path, contents).get_formula(spec) end def self.to_rack(ref) # First, check whether the rack with the given name exists. if (rack = HOMEBREW_CELLAR/File.basename(ref, ".rb")).directory? return rack.resolved_path end # Second, use canonical name to locate rack. (HOMEBREW_CELLAR/canonical_name(ref)).resolved_path end def self.canonical_name(ref) loader_for(ref).name rescue TapFormulaAmbiguityError # If there are multiple tap formulae with the name of ref, # then ref is the canonical name ref.downcase end def self.path(ref) loader_for(ref).path end def self.loader_for(ref) case ref when %r{(https?|ftp|file)://} return FromUrlLoader.new(ref) when Pathname::BOTTLE_EXTNAME_RX return BottleLoader.new(ref) when HOMEBREW_TAP_FORMULA_REGEX return TapLoader.new(ref) end if File.extname(ref) == ".rb" return FromPathLoader.new(ref) end formula_with_that_name = core_path(ref) if formula_with_that_name.file? return FormulaLoader.new(ref, formula_with_that_name) end possible_alias = CoreTap.instance.alias_dir/ref if possible_alias.file? return AliasLoader.new(possible_alias) end possible_tap_formulae = tap_paths(ref) if possible_tap_formulae.size > 1 raise TapFormulaAmbiguityError.new(ref, possible_tap_formulae) elsif possible_tap_formulae.size == 1 path = possible_tap_formulae.first.resolved_path name = path.basename(".rb").to_s return FormulaLoader.new(name, path) end if newref = CoreTap.instance.formula_renames[ref] formula_with_that_oldname = core_path(newref) if formula_with_that_oldname.file? return FormulaLoader.new(newref, formula_with_that_oldname) end end possible_tap_newname_formulae = [] Tap.each do |tap| if newref = tap.formula_renames[ref] possible_tap_newname_formulae << "#{tap.name}/#{newref}" end end if possible_tap_newname_formulae.size > 1 raise TapFormulaWithOldnameAmbiguityError.new(ref, possible_tap_newname_formulae) elsif !possible_tap_newname_formulae.empty? return TapLoader.new(possible_tap_newname_formulae.first) end possible_cached_formula = Pathname.new("#{HOMEBREW_CACHE_FORMULA}/#{ref}.rb") if possible_cached_formula.file? return FormulaLoader.new(ref, possible_cached_formula) end NullLoader.new(ref) end def self.core_path(name) CoreTap.instance.formula_dir/"#{name.downcase}.rb" end def self.tap_paths(name, taps = Dir["#{HOMEBREW_LIBRARY}/Taps/*/*/"]) name = name.downcase taps.map do |tap| Pathname.glob([ "#{tap}Formula/#{name}.rb", "#{tap}HomebrewFormula/#{name}.rb", "#{tap}#{name}.rb", "#{tap}Aliases/#{name}", ]).detect(&:file?) end.compact end def self.find_with_priority(ref, spec = :stable) possible_pinned_tap_formulae = tap_paths(ref, Dir["#{HOMEBREW_LIBRARY}/PinnedTaps/*/*/"]).map(&:realpath) if possible_pinned_tap_formulae.size > 1 raise TapFormulaAmbiguityError.new(ref, possible_pinned_tap_formulae) elsif possible_pinned_tap_formulae.size == 1 selected_formula = factory(possible_pinned_tap_formulae.first, spec) if core_path(ref).file? opoo <<-EOS.undent #{ref} is provided by core, but is now shadowed by #{selected_formula.full_name}. To refer to the core formula, use Homebrew/core/#{ref} instead. EOS end selected_formula else factory(ref, spec) end end end