vagrant/plugins/hosts/bsd/host.rb

require 'log4r'

require "vagrant"
require 'vagrant/util/platform'
require "vagrant/util/subprocess"

module VagrantPlugins
  module HostBSD
    # Represents a BSD host, such as FreeBSD and Darwin (Mac OS X).
    class Host < Vagrant.plugin("2", :host)
      include Vagrant::Util
      include Vagrant::Util::Retryable

      def self.match?
        Vagrant::Util::Platform.darwin? || Vagrant::Util::Platform.bsd?
      end

      def self.precedence
        # Set a lower precedence because this is a generic OS. We
        # want specific distros to match first.
        2
      end

      def initialize(*args)
        super

        @logger = Log4r::Logger.new("vagrant::hosts::bsd")
        @nfs_restart_command = "sudo nfsd restart"
        @nfs_exports_template = "nfs/exports"
      end

      def nfs?
        retryable(:tries => 10, :on => TypeError) do
          system("which nfsd > /dev/null 2>&1")
        end
      end

      def nfs_export(id, ips, folders)
        nfs_checkexports!

        # We need to build up mapping of directories that are enclosed
        # within each other because the exports file has to have subdirectories
        # of an exported directory on the same line. e.g.:
        #
        #   "/foo" "/foo/bar" ...
        #   "/bar"
        #
        # We build up this mapping within the following hash.
        @logger.debug("Compiling map of sub-directories for NFS exports...")
        dirmap = {}
        folders.each do |_, opts|
          hostpath = opts[:hostpath].dup
          hostpath.gsub!('"', '\"')

          found = false
          dirmap.each do |dirs, diropts|
            dirs.each do |dir|
              if dir.start_with?(hostpath) || hostpath.start_with?(dir)
                # TODO: verify opts and diropts are _identical_, raise an error
                # if not. NFS mandates subdirectories have identical options.
                dirs << hostpath
                found = true
                break
              end
            end

            break if found
          end

          if !found
            dirmap[[hostpath]] = opts.dup
          end
        end

        # Sort all the keys by length so that the directory closest to
        # the root is exported first.
        dirmap.each do |dirs, _|
          dirs.sort_by! { |d| d.length }
        end

        # Setup the NFS options
        dirmap.each do |dirs, opts|
          if !opts[:bsd__nfs_options]
            opts[:bsd__nfs_options] = ["alldirs"]
          end

          hasmapall = false
          opts[:bsd__nfs_options].each do |opt|
            # mapall/maproot are mutually exclusive, so we have to check
            # for both here.
            if opt =~ /^mapall=/ || opt =~ /^maproot=/
              hasmapall = true
              break
            end
          end

          if !hasmapall
            opts[:bsd__nfs_options] << "mapall=#{opts[:map_uid]}:#{opts[:map_gid]}"
          end

          opts[:bsd__compiled_nfs_options] = opts[:bsd__nfs_options].map do |opt|
            "-#{opt}"
          end.join(" ")
        end

        @logger.info("Exporting the following for NFS...")
        dirmap.each do |dirs, opts|
          @logger.info("NFS DIR: #{dirs.inspect}")
          @logger.info("NFS OPTS: #{opts.inspect}")
        end

        output = TemplateRenderer.render(@nfs_exports_template,
                                         :uuid => id,
                                         :ips => ips,
                                         :folders => dirmap,
                                         :user => Process.uid)

        # The sleep ensures that the output is truly flushed before any `sudo`
        # commands are issued.
        @ui.info I18n.t("vagrant.hosts.bsd.nfs_export")
        sleep 0.5

        # First, clean up the old entry
        nfs_cleanup(id)

        # Output the rendered template into the exports
        output.split("\n").each do |line|
          line.gsub!('"', '\"')
          line.gsub!("'", "'\\\\''")
          system(%Q[sudo -s -- "echo '#{line}' >> /etc/exports"])
        end

        # We run restart here instead of "update" just in case nfsd
        # is not starting
        system(@nfs_restart_command)
      end

      def nfs_prune(valid_ids)
        return if !File.exist?("/etc/exports")

        @logger.info("Pruning invalid NFS entries...")

        output = false
        user = Process.uid

        File.read("/etc/exports").lines.each do |line|
          if id = line[/^# VAGRANT-BEGIN:( #{user})? ([A-Za-z0-9-]+?)$/, 2]
            if valid_ids.include?(id)
              @logger.debug("Valid ID: #{id}")
            else
              if !output
                # We want to warn the user but we only want to output once
                @ui.info I18n.t("vagrant.hosts.bsd.nfs_prune")
                output = true
              end

              @logger.info("Invalid ID, pruning: #{id}")
              nfs_cleanup(id)
            end
          end
        end
      rescue Errno::EACCES
        raise Vagrant::Errors::NFSCantReadExports
      end

      protected

      def nfs_checkexports!
        r = Subprocess.execute("nfsd", "checkexports")
        if r.exit_code != 0
          raise Vagrant::Errors::NFSBadExports, output: r.stderr
        end
      end

      def nfs_cleanup(id)
        return if !File.exist?("/etc/exports")

        # Escape sed-sensitive characters:
        id = id.gsub("/", "\\/")
        id = id.gsub(".", "\\.")

        user = Process.uid

        # Use sed to just strip out the block of code which was inserted
        # by Vagrant, and restart NFS.
        system("sudo sed -E -e '/^# VAGRANT-BEGIN:( #{user})? #{id}/,/^# VAGRANT-END:( #{user})? #{id}/ d' -ibak /etc/exports")
      end
    end
  end
end