vagrant-docker-hosts-manager 0.2.0 → 0.4.0

data/lib/vagrant-docker-hosts-manager/util/hosts_file.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require "base64"
 require "tempfile"
 require "time"
 require "open3"
 
 require_relative "../helpers"
 require_relative "docker"
+require_relative "verbose"
 
 module VagrantDockerHostsManager
   module Util
@@ -15,6 +17,10 @@ module VagrantDockerHostsManager
       WIN_SYSNATIVE_PATH = "C:/Windows/Sysnative/drivers/etc/hosts"
       WIN_SYSWOW64_PATH  = "C:/Windows/SysWOW64/drivers/etc/hosts"
 
+      BLOCK_START_RE = /^\s*#\s*>>>\s*vagrant-docker-hosts-manager\s+(.+?)\s*\(managed\)\s*>>>\s*$/i
+      BLOCK_STOP_RE  = /^\s*#\s*<<<\s*vagrant-docker-hosts-manager\s+(.+?)\s*\(managed\)\s*<<<\s*$/i
+      ENTRY_RE       = /\A\s*(\d{1,3}(?:\.\d{1,3}){3})\s+([^\s#]+)/
+
       def initialize(env, owner_id:)
         @env      = env || {}
         @owner_id = owner_id.to_s
@@ -27,8 +33,13 @@ module VagrantDockerHostsManager
       end
 
       def path_candidates
-        return [POSIX_PATH] unless Gem.win_platform?
+        # VDHM_HOSTS_PATH overrides the default location on every platform
+        # (used by tests and power users); honor it before anything else.
         return [override_path] if override_path
+        return [POSIX_PATH] unless Gem.win_platform?
+
+        # Sysnative lets a 32-bit Ruby process reach the real System32 hosts
+        # file on 64-bit Windows; keep it before System32/SysWOW64.
         [WIN_SYSNATIVE_PATH, WIN_SYS32_PATH, WIN_SYSWOW64_PATH]
       end
 
@@ -62,7 +73,11 @@ module VagrantDockerHostsManager
 
       def compose_block(entries, newline: "\n")
         start, stop = block_markers
-        ts = (Time.now.utc.iso8601 rescue Time.now.utc.to_s)
+        ts = begin
+               Time.now.utc.iso8601
+             rescue StandardError
+               Time.now.utc.to_s
+             end
 
         header = [
           start,
@@ -98,11 +113,20 @@ module VagrantDockerHostsManager
         str.end_with?(nl) ? str : (str + nl)
       end
 
+      # Applies managed host entries to the hosts file.
+      #
+      # Rewrites only this plugin's managed block and preserves unmanaged lines.
+      # Entries are normalized and sorted so repeated runs converge to the same
+      # file content.
+      #
+      # @param entries [Hash{String=>String}] Mapping of FQDN to IP address.
+      # @return [Integer] Number of managed entries present after applying changes.
+      # @raise [RuntimeError] When elevated writes fail.
       def apply(entries)
         entries = normalize_entries(entries)
         if entries.empty?
           UiHelpers.say(@ui, "#{UiHelpers.e(:info)} " +
-            ::I18n.t("messages.no_entries", default: "No hosts entries configured."))
+            ::I18n.t("vdhm.messages.no_entries", default: "No hosts entries configured."))
           return 0
         end
 
@@ -132,7 +156,7 @@ module VagrantDockerHostsManager
 
         if added.empty? && updated.empty?
           UiHelpers.say(@ui, "#{UiHelpers.e(:info)} " +
-            ::I18n.t("messages.no_change", default: "Nothing to apply. Already up-to-date."))
+            ::I18n.t("vdhm.messages.no_change", default: "Nothing to apply. Already up-to-date."))
           return existing_map.size
         end
 
@@ -141,14 +165,21 @@ module VagrantDockerHostsManager
         write(content)
 
         UiHelpers.say(@ui, "#{UiHelpers.e(:success)} " +
-          ::I18n.t("messages.applied", default: "Hosts entries applied."))
+          ::I18n.t("vdhm.messages.applied", default: "Hosts entries applied."))
         UiHelpers.say(@ui, "#{UiHelpers.e(:info)} " +
-          ::I18n.t("messages.apply_summary",
+          ::I18n.t("vdhm.messages.apply_summary",
                   default: "Added: %{a}, Updated: %{u}, Unchanged: %{s}",
                   a: added.size, u: updated.size, s: unchanged.size))
         merged.size
       end
 
+      # Removes matching entries from the current owner's managed block.
+      #
+      # With no filters this falls back to removing the whole current-owner block.
+      #
+      # @param ips [Array<String>] IP addresses to remove.
+      # @param domains [Array<String>] Domain names to remove.
+      # @return [Integer] Number of removed entries, or 1 when a whole block was removed.
       def remove_entries!(ips: [], domains: [])
         ips     = Array(ips).map(&:to_s).reject(&:empty?)
         domains = Array(domains).map(&:to_s).reject(&:empty?)
@@ -165,7 +196,7 @@ module VagrantDockerHostsManager
         removed_count = before - filtered.length
         if removed_count <= 0
           UiHelpers.say(@ui, "#{UiHelpers.e(:info)} " +
-            ::I18n.t("messages.remove_none",
+            ::I18n.t("vdhm.messages.remove_none",
               default: "No matching entry to remove."))
           return 0
         end
@@ -187,7 +218,7 @@ module VagrantDockerHostsManager
           @ui,
           "#{UiHelpers.e(:broom)} " +
             ::I18n.t(
-              "messages.removed_count",
+              "vdhm.messages.removed_count",
               default: "%{count} entries removed.",
               count: removed_count
             )
@@ -195,6 +226,9 @@ module VagrantDockerHostsManager
         removed_count
       end
 
+      # Removes the current owner's managed hosts block.
+      #
+      # @return [Boolean] Whether a block was removed.
       def remove!
         content = read
         newc = remove_block_from(content)
@@ -202,12 +236,44 @@ module VagrantDockerHostsManager
         write(newc) if removed
 
         UiHelpers.say(@ui, removed ?
-          "#{UiHelpers.e(:broom)} " + ::I18n.t("messages.cleaned", default: "Managed hosts entries removed.") :
-          "#{UiHelpers.e(:info)} "  + ::I18n.t("messages.nothing_to_clean", default: "Nothing to clean."))
+          "#{UiHelpers.e(:broom)} " + ::I18n.t("vdhm.messages.cleaned", default: "Managed hosts entries removed.") :
+          "#{UiHelpers.e(:info)} "  + ::I18n.t("vdhm.messages.nothing_to_clean", default: "Nothing to clean."))
+        removed
+      end
+
+      # Removes every block managed by this plugin, regardless of owner.
+      #
+      # @return [Boolean] Whether any managed block was removed.
+      def remove_all_managed!
+        content = read
+        newc = strip_managed_blocks(content)
+        removed = (newc != content)
+        write(newc) if removed
+
+        UiHelpers.say(@ui, removed ?
+          "#{UiHelpers.e(:broom)} " + ::I18n.t("vdhm.messages.cleaned_all", default: "All managed hosts blocks removed.") :
+          "#{UiHelpers.e(:info)} "  + ::I18n.t("vdhm.messages.nothing_to_clean", default: "Nothing to clean."))
         removed
       end
 
+      def strip_managed_blocks(content)
+        removing = false
+        content.lines.reject do |line|
+          if line.match?(BLOCK_START_RE)
+            removing = true
+            true
+          elsif line.match?(BLOCK_STOP_RE)
+            removing = false
+            true
+          else
+            removing
+          end
+        end.join
+      end
+
       def read
+        # Hosts files are often edited by Windows tools with BOMs or legacy
+        # encodings; normalize to UTF-8 before parsing managed blocks.
         pth = real_path
         UiHelpers.debug(@ui, "read(#{pth})")
 
@@ -216,7 +282,7 @@ module VagrantDockerHostsManager
         begin
           data = File.binread(pth)
           UiHelpers.debug(@ui, "File.binread ok, bytes=#{data.bytesize}, encoding=#{data.encoding}")
-        rescue => e
+        rescue StandardError => e
           UiHelpers.debug(@ui, "File.binread error: #{e.class}: #{e.message}")
           data = nil
         end
@@ -224,6 +290,7 @@ module VagrantDockerHostsManager
         if (data.nil? || data.empty?) && Gem.win_platform?
           ps_path = pth.gsub("'", "''")
           ps_cmd  = "Get-Content -LiteralPath '#{ps_path}' -Raw"
+          Verbose.log("powershell -Command #{ps_cmd}")
           out, err, st = Open3.capture3("powershell", "-NoProfile", "-NonInteractive", "-Command", ps_cmd)
           if st.success?
             data = out
@@ -253,7 +320,7 @@ module VagrantDockerHostsManager
                    .force_encoding("Windows-1252")
                    .encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: "")
             UiHelpers.debug(@ui, "Transcoded via Windows-1252 -> UTF-8, encoding=#{data.encoding}")
-          rescue => e2
+          rescue StandardError => e2
             UiHelpers.debug(@ui, "Windows-1252 fallback failed: #{e2.class}: #{e2.message}")
             data = data.force_encoding(Encoding::UTF_8)
           end
@@ -265,34 +332,33 @@ module VagrantDockerHostsManager
         end
 
         data
-      rescue => e
+      rescue StandardError => e
         UiHelpers.debug(@ui, "read() fatal: #{e.class}: #{e.message}")
         ""
       end
 
-      def list_pairs(scope = :all)
-        content = read
-        return [] if content.to_s.empty?
+      def each_managed_entry(scope = :all)
+        # A single scanner powers both current-owner and all-owner cleanup paths
+        # so marker parsing rules stay identical.
+        return enum_for(:each_managed_entry, scope) unless block_given?
 
-        start_re = /^\s*#\s*>>>\s*vagrant-docker-hosts-manager\s+(.+?)\s*\(managed\)\s*>>>\s*$/i
-        stop_re  = /^\s*#\s*<<<\s*vagrant-docker-hosts-manager\s+(.+?)\s*\(managed\)\s*<<<\s*$/i
-        ip_re    = /^\s*(\d{1,3}(?:\.\d{1,3}){3})\s+([^\s#]+)/
+        content = read
+        return if content.to_s.empty?
 
-        out      = []
         in_block = false
         owner    = nil
 
         content.each_line.with_index(1) do |raw, idx|
           line = raw.delete_suffix("\n").delete_suffix("\r")
 
-          if (m = line.match(start_re))
+          if (m = line.match(BLOCK_START_RE))
             in_block = true
             owner    = m[1].to_s.strip
             UiHelpers.debug(@ui, "start block(owner=#{owner}) at line #{idx}")
             next
           end
 
-          if (m = line.match(stop_re))
+          if line.match?(BLOCK_STOP_RE)
             UiHelpers.debug(@ui, "stop  block(owner=#{owner}) at line #{idx}") if in_block
             in_block = false
             owner    = nil
@@ -302,103 +368,25 @@ module VagrantDockerHostsManager
           next unless in_block
           next unless scope == :all || owner == @owner_id
 
-          if (m = line.match(ip_re))
-            ip, fqdn = m[1], m[2]
-            out << [ip, fqdn, owner]
-            UiHelpers.debug(@ui, "  ip line: #{ip} #{fqdn} (owner=#{owner})")
+          if (m = line.match(ENTRY_RE))
+            UiHelpers.debug(@ui, "  ip line: #{m[1]} #{m[2]} (owner=#{owner})")
+            yield m[1], m[2], owner
           end
         end
-
-        UiHelpers.debug(@ui, "list_pairs found #{out.length} pair(s)")
-        out
       end
 
-      def entries_in_blocks(scope = :current)
-        content = read
-        return {} if content.to_s.empty?
-
-        start_prefix = "# >>> vagrant-docker-hosts-manager "
-        stop_prefix  = "# <<< vagrant-docker-hosts-manager "
-
-        in_block = false
-        owner    = nil
-        out      = {}
-
-        content.each_line do |raw|
-          line = raw.sub(/\r?\n\z/, "")
-          lstr = line.lstrip
-
-          if lstr.start_with?(start_prefix)
-            in_block = true
-            tail  = lstr[start_prefix.length..-1].to_s
-            owner = tail.split(" (managed)").first.to_s.strip
-            next
-          end
-
-          if lstr.start_with?(stop_prefix)
-            in_block = false
-            owner    = nil
-            next
-          end
-
-          next unless in_block
-          next unless scope == :all || owner == @owner_id
-
-          if lstr =~ /\A\s*(\d{1,3}(?:\.\d{1,3}){3})\s+([^\s#]+)/
-            ip, fqdn = $1, $2
-            if out.key?(fqdn)
-              arr = out[fqdn].is_a?(Array) ? out[fqdn] : [out[fqdn]]
-              arr << ip unless arr.include?(ip)
-              out[fqdn] = arr
-            else
-              out[fqdn] = [ip]
-            end
-          end
-        end
-
-        out
+      def list_pairs(scope = :all)
+        pairs = []
+        each_managed_entry(scope) { |ip, fqdn, owner| pairs << [ip, fqdn, owner] }
+        UiHelpers.debug(@ui, "list_pairs found #{pairs.length} pair(s)")
+        pairs
       end
 
-      def managed_blocks_dump(scope = :all)
-        content = read
-        return "" if content.to_s.empty?
-
-        start_re = /^\s*#\s*>>>\s*vagrant-docker-hosts-manager\s+(.+?)\s*\(managed\)\s*>>>\s*$/i
-        stop_re  = /^\s*#\s*<<<\s*vagrant-docker-hosts-manager\s+(.+?)\s*\(managed\)\s*<<<\s*$/i
-
-        buff     = []
-        cur      = []
-        in_block = false
-        owner    = nil
-
-        content.each_line do |raw|
-          line = raw.delete_suffix("\n").delete_suffix("\r")
-
-          if (m = line.match(start_re))
-            in_block = true
-            owner    = m[1].to_s.strip
-            cur = [line]
-            next
-          end
-
-          if in_block
-            cur << line
-            if line.match?(stop_re)
-              if scope == :all || owner == @owner_id
-                buff << cur.join("\n")
-              end
-              in_block = false
-              owner    = nil
-              cur      = []
-            end
-          end
+      def entries_in_blocks(scope = :current)
+        each_managed_entry(scope).with_object({}) do |(ip, fqdn, _owner), out|
+          arr = (out[fqdn] ||= [])
+          arr << ip unless arr.include?(ip)
         end
-
-        buff.join("\n\n\n")
-      end
-
-      def current_entries
-        entries_in_blocks(:current)
       end
 
       def remove_block_from(content)
@@ -424,12 +412,13 @@ module VagrantDockerHostsManager
               [Security.Principal.WindowsIdentity]::GetCurrent()
             )).IsInRole([Security.Principal.WindowsBuiltInRole]::Administrator)
           }.strip
+          Verbose.log("powershell -Command (check administrator role)")
           out, _err, st = Open3.capture3("powershell", "-NoProfile", "-NonInteractive", "-Command", cmd)
           st.success? && out.to_s.strip.downcase == "true"
         else
           begin
             Process.euid == 0
-          rescue
+          rescue StandardError
             false
           end
         end
@@ -446,31 +435,50 @@ module VagrantDockerHostsManager
         begin
           tf.binmode
           tf.write(content); tf.flush
-          system("sudo cp #{tf.path} #{real_path}") || raise("sudo copy failed")
+          Verbose.log("sudo", "cp", tf.path, real_path)
+          system("sudo", "cp", tf.path, real_path) || raise("sudo copy failed")
         ensure
           tf.close!
         end
       end
 
       def write_windows(content)
-        tf = Tempfile.new("vdhm-hosts")
-        begin
-          tf.binmode
-          tf.write(content); tf.flush
-          ps = <<~POW
-            $ErrorActionPreference = "Stop"
-            Copy-Item -LiteralPath '#{tf.path.gsub("'", "''")}' -Destination '#{real_path.gsub("'", "''")}' -Force
-          POW
-          system(%{powershell -NoProfile -NonInteractive -Command #{Util::Docker.shell_escape(ps)}}) ||
-            system(
-              %{
-                powershell -NoProfile -NonInteractive -Command
-                "Start-Process PowerShell -Verb RunAs -ArgumentList #{Util::Docker.shell_escape(ps)}"
-              }.strip
-            ) || raise("elevated copy failed")
-        ensure
-          tf.close!
-        end
+        # Try a direct write first; fall back to UAC only when the hosts file
+        # rejects it. Base64/UTF-16LE keeps PowerShell quoting predictable.
+        b64  = Base64.strict_encode64(
+          content.encode("UTF-8", invalid: :replace, undef: :replace, replace: "")
+        )
+        dest = real_path.gsub("'", "''")
+
+        ps = <<~POW
+          $ErrorActionPreference = "Stop"
+          try {
+            $bytes = [System.Convert]::FromBase64String('#{b64}')
+            [System.IO.File]::WriteAllBytes('#{dest}', $bytes)
+            exit 0
+          } catch {
+            exit 1
+          }
+        POW
+        encoded = Base64.strict_encode64(ps.encode("UTF-16LE"))
+
+        Verbose.log("powershell -EncodedCommand (write hosts file: #{real_path})")
+        _out, _err, st = Open3.capture3("powershell", "-NoProfile", "-NonInteractive", "-EncodedCommand", encoded)
+        return if st.success?
+
+        elev_ps = <<~POW
+          $ErrorActionPreference = 'Stop'
+          try {
+            $p = Start-Process PowerShell -Verb RunAs -Wait -PassThru -ArgumentList '-NonInteractive','-NoProfile','-EncodedCommand','#{encoded}'
+            exit $p.ExitCode
+          } catch {
+            exit 1
+          }
+        POW
+        elev_encoded = Base64.strict_encode64(elev_ps.encode("UTF-16LE"))
+        Verbose.log("powershell -EncodedCommand (elevated write hosts file via RunAs: #{real_path})")
+        system("powershell", "-NoProfile", "-NonInteractive", "-EncodedCommand", elev_encoded) ||
+          raise("elevated write failed")
       end
     end
   end

data/lib/vagrant-docker-hosts-manager/util/i18n.rb

@@ -1,34 +1,42 @@
 # frozen_string_literal: true
 
 require "i18n"
+require_relative "../helpers"
 
 module VagrantDockerHostsManager
   module Util
     module I18n
-      SUPPORTED = [:en, :fr].freeze
       @json = false
 
       module_function
 
       def setup!(env, forced: nil)
-        ::I18n.enforce_available_locales = false
+        UiHelpers.setup_i18n!
 
-        gem_root = File.expand_path("../..", __dir__)
-        paths    = Dir[File.join(gem_root, "locales", "*.yml")]
-        ::I18n.load_path |= paths
-        ::I18n.available_locales = SUPPORTED
-        ::I18n.backend.load_translations
+        if forced
+          begin
+            UiHelpers.set_locale!(forced)
+          rescue UiHelpers::UnsupportedLocaleError
+            UiHelpers.set_locale!("en")
+          end
+        end
 
-        lang = forced || ENV["VDHM_LANG"] || ENV["LANG"] || "en"
-        sym  = lang.to_s[0, 2].downcase.to_sym
-        ::I18n.locale = SUPPORTED.include?(sym) ? sym : :en
+        begin
+          cfg = env[:machine]&.config&.docker_hosts
+          if cfg&.respond_to?(:locale) && !cfg.locale.to_s.strip.empty?
+            UiHelpers.setup_locale_from_config!(cfg)
+          end
+        rescue StandardError
+          nil
+        end
 
         begin
-          if env[:ui] && env[:machine] && env[:machine].config.docker_hosts.respond_to?(:verbose) &&
+          if env[:ui] && env[:machine]&.config&.docker_hosts&.respond_to?(:verbose) &&
              env[:machine].config.docker_hosts.verbose
-            env[:ui].info(::I18n.t("messages.lang_set", lang: ::I18n.locale))
+            env[:ui].info(::I18n.t("vdhm.messages.lang_set", lang: ::I18n.locale))
           end
         rescue StandardError
+          nil
         end
       end
 

data/lib/vagrant-docker-hosts-manager/util/verbose.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "shellwords"
+
+module VagrantDockerHostsManager
+  module Util
+    module Verbose
+      module_function
+
+      def enabled?
+        ENV["VDHM_VERBOSE"].to_s == "1"
+      end
+
+      def log(*args)
+        return unless enabled?
+
+        line = args.length == 1 && args.first.is_a?(String) ? args.first : args.map(&:to_s).shelljoin
+        warn("[VDHM] #{line}")
+      end
+    end
+  end
+end

data/lib/vagrant-docker-hosts-manager/version.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 module VagrantDockerHostsManager
-  VERSION = begin
-    path = File.expand_path("VERSION", __dir__)
-    File.exist?(path) ? File.read(path).strip : "0.0.0"
-  rescue
-    "0.0.0"
+  unless defined?(VERSION)
+    VERSION = begin
+      path = File.expand_path("VERSION", __dir__)
+      File.exist?(path) ? File.read(path).strip : "0.0.0"
+    rescue StandardError
+      "0.0.0"
+    end
   end
 end