require "extend/pathname" require "keg_fix_install_names" require "formula_lock" require "ostruct" class Keg < Pathname class AlreadyLinkedError < RuntimeError def initialize(keg) super <<-EOS.undent Cannot link #{keg.fname} Another version is already linked: #{keg.linked_keg_record.resolved_path} EOS end end class LinkError < RuntimeError attr_reader :keg, :src, :dst def initialize(keg, src, dst) @src = src @dst = dst @keg = keg end end class ConflictError < LinkError def suggestion conflict = Keg.for(dst) rescue NotAKegError "already exists. You may want to remove it:\n rm #{dst}\n" else <<-EOS.undent is a symlink belonging to #{conflict.fname}. You can unlink it: brew unlink #{conflict.fname} EOS end def to_s s = [] s << "Could not symlink #{src.relative_path_from(keg)}" s << "Target #{dst}" << suggestion s << <<-EOS.undent To force the link and overwrite all conflicting files: brew link --overwrite #{keg.fname} To list all files that would be deleted: brew link --overwrite --dry-run #{keg.fname} EOS s.join("\n") end end class DirectoryNotWritableError < LinkError def to_s; <<-EOS.undent Could not symlink #{src.relative_path_from(keg)} #{dst.dirname} is not writable. EOS end end # locale-specific directories have the form language[_territory][.codeset][@modifier] LOCALEDIR_RX = /(locale|man)\/([a-z]{2}|C|POSIX)(_[A-Z]{2})?(\.[a-zA-Z\-0-9]+(@.+)?)?/ INFOFILE_RX = %r[info/([^.].*?\.info|dir)$] TOP_LEVEL_DIRECTORIES = %w[bin etc include lib sbin share var Frameworks] PRUNEABLE_DIRECTORIES = %w[bin etc include lib sbin share Frameworks LinkedKegs].map do |d| case d when 'LinkedKegs' then HOMEBREW_LIBRARY/d else HOMEBREW_PREFIX/d end end # These paths relative to the keg's share directory should always be real # directories in the prefix, never symlinks. SHARE_PATHS = %w[ aclocal doc info locale man man/man1 man/man2 man/man3 man/man4 man/man5 man/man6 man/man7 man/man8 man/cat1 man/cat2 man/cat3 man/cat4 man/cat5 man/cat6 man/cat7 man/cat8 applications gnome gnome/help icons mime-info pixmaps sounds ] # if path is a file in a keg then this will return the containing Keg object def self.for path path = path.realpath while not path.root? return Keg.new(path) if path.parent.parent == HOMEBREW_CELLAR.realpath path = path.parent.realpath # realpath() prevents root? failing end raise NotAKegError, "#{path} is not inside a keg" end def initialize path super path raise "#{to_s} is not a valid keg" unless parent.parent.realpath == HOMEBREW_CELLAR.realpath raise "#{to_s} is not a directory" unless directory? end def uninstall rmtree parent.rmdir_if_possible end def unlink ObserverPathnameExtension.reset_counts! dirs = [] TOP_LEVEL_DIRECTORIES.map{ |d| self/d }.each do |dir| next unless dir.exist? dir.find do |src| dst = HOMEBREW_PREFIX + src.relative_path_from(self) dst.extend(ObserverPathnameExtension) dirs << dst if dst.directory? && !dst.symlink? # check whether the file to be unlinked is from the current keg first next if !dst.symlink? || !dst.exist? || src != dst.resolved_path dst.uninstall_info if dst.to_s =~ INFOFILE_RX dst.unlink Find.prune if src.directory? end end linked_keg_record.unlink if linked_keg_record.symlink? dirs.reverse_each(&:rmdir_if_possible) ObserverPathnameExtension.total end def fname parent.basename.to_s end def lock FormulaLock.new(fname).with_lock { yield } end def linked_keg_record @linked_keg_record ||= HOMEBREW_REPOSITORY/"Library/LinkedKegs"/fname end def linked? linked_keg_record.directory? && self == linked_keg_record.resolved_path end def completion_installed? shell dir = case shell when :bash then self/'etc/bash_completion.d' when :zsh then self/'share/zsh/site-functions' end return if dir.nil? dir.directory? and not dir.children.length.zero? end def plist_installed? not Dir.glob("#{self}/*.plist").empty? end def python_site_packages_installed? (self/'lib/python2.7/site-packages').directory? end def app_installed? not Dir.glob("#{self}/{,libexec/}*.app").empty? end def version require 'pkg_version' PkgVersion.parse(basename.to_s) end def basename Pathname.new(self).basename end def find(*args, &block) Pathname.new(self).find(*args, &block) end def link mode=OpenStruct.new raise AlreadyLinkedError.new(self) if linked_keg_record.directory? ObserverPathnameExtension.reset_counts! # yeah indeed, you have to force anything you need in the main tree into # these dirs REMEMBER that *NOT* everything needs to be in the main tree link_dir('etc', mode) {:mkpath} link_dir('bin', mode) {:skip_dir} link_dir('sbin', mode) {:skip_dir} link_dir('include', mode) {:link} link_dir('share', mode) do |path| case path.to_s when 'locale/locale.alias' then :skip_file when INFOFILE_RX then :info when LOCALEDIR_RX then :mkpath when *SHARE_PATHS then :mkpath when /^icons\/.*\/icon-theme\.cache$/ then :skip_file # all icons subfolders should also mkpath when /^icons\// then :mkpath when /^zsh/ then :mkpath else :link end end link_dir('lib', mode) do |path| case path.to_s when 'charset.alias' then :skip_file # pkg-config database gets explicitly created when 'pkgconfig' then :mkpath # lib/language folders also get explicitly created when 'dtrace' then :mkpath when /^gdk-pixbuf/ then :mkpath when 'ghc' then :mkpath when 'lua' then :mkpath when /^node/ then :mkpath when /^ocaml/ then :mkpath when /^perl5/ then :mkpath when 'php' then :mkpath when /^python[23]\.\d/ then :mkpath when 'ruby' then :mkpath # Everything else is symlinked to the cellar else :link end end link_dir('Frameworks', mode) do |path| # Frameworks contain symlinks pointing into a subdir, so we have to use # the :link strategy. However, for Foo.framework and # Foo.framework/Versions we have to use :mkpath so that multiple formulae # can link their versions into it and `brew [un]link` works. if path.to_s =~ /[^\/]*\.framework(\/Versions)?$/ :mkpath else :link end end unless mode.dry_run make_relative_symlink(linked_keg_record, self, mode) optlink end rescue LinkError unlink raise else ObserverPathnameExtension.total end def optlink from = HOMEBREW_PREFIX/:opt/fname if from.symlink? from.delete elsif from.directory? from.rmdir elsif from.exist? from.delete end make_relative_symlink(from, self) end def delete_pyc_files! find { |pn| pn.delete if pn.extname == ".pyc" } end protected def resolve_any_conflicts dst, mode # if it isn't a directory then a severe conflict is about to happen. Let # it, and the exception that is generated will message to the user about # the situation if dst.symlink? and dst.directory? src = dst.resolved_path keg = Keg.for(src) dst.unlink unless mode.dry_run keg.link_dir(src, mode) { :mkpath } return true end rescue NotAKegError puts "Won't resolve conflicts for symlink #{dst} as it doesn't resolve into the Cellar" if ARGV.verbose? end def make_relative_symlink dst, src, mode=OpenStruct.new if dst.symlink? && dst.exist? && dst.resolved_path == src puts "Skipping; link already exists: #{dst}" if ARGV.verbose? return end # cf. git-clean -n: list files to delete, don't really link or delete if mode.dry_run and mode.overwrite if dst.symlink? puts "#{dst} -> #{dst.resolved_path}" elsif dst.exist? puts dst end return end # list all link targets if mode.dry_run puts dst return end dst.delete if mode.overwrite && (dst.exist? || dst.symlink?) dst.make_relative_symlink(src) rescue Errno::EEXIST if dst.exist? raise ConflictError.new(self, src, dst) elsif dst.symlink? dst.unlink retry end rescue Errno::EACCES raise DirectoryNotWritableError.new(self, src, dst) rescue SystemCallError raise LinkError.new(self, src, dst) end # symlinks the contents of self+foo recursively into #{HOMEBREW_PREFIX}/foo def link_dir foo, mode root = self+foo return unless root.exist? root.find do |src| next if src == root dst = HOMEBREW_PREFIX+src.relative_path_from(self) dst.extend ObserverPathnameExtension if src.file? Find.prune if File.basename(src) == '.DS_Store' # Don't link pyc files because Python overwrites these cached object # files and next time brew wants to link, the pyc file is in the way. if src.extname == '.pyc' && src.to_s =~ /site-packages/ Find.prune end case yield src.relative_path_from(root) when :skip_file, nil Find.prune when :info next if File.basename(src) == 'dir' # skip historical local 'dir' files make_relative_symlink dst, src, mode dst.install_info else make_relative_symlink dst, src, mode end elsif src.directory? # If the `src` in the Cellar is a symlink itself, link it directly. # For example Qt has `Frameworks/QtGui.framework -> lib/QtGui.framework` # Not making a link here, would result in an empty dir because the # `src` is not followed by `find`. if src.symlink? && !dst.exist? make_relative_symlink dst, src, mode Find.prune end # if the dst dir already exists, then great! walk the rest of the tree tho next if dst.directory? and not dst.symlink? # no need to put .app bundles in the path, the user can just use # spotlight, or the open command and actual mac apps use an equivalent Find.prune if src.extname == '.app' case yield src.relative_path_from(root) when :skip_dir Find.prune when :mkpath dst.mkpath unless resolve_any_conflicts(dst, mode) else unless resolve_any_conflicts(dst, mode) make_relative_symlink dst, src, mode Find.prune end end end end end end