Class: Vagrant::Action::Builtin::HandleBoxUrl

Inherits:
Object
  • Object
show all
Defined in:
lib/vagrant/action/builtin/handle_box_url.rb

Overview

This built-in middleware handles the ‘box_url` setting, downloading the box if necessary. You should place this early in your middleware sequence for a provider after configuration validation but before you attempt to use any box.

Constant Summary collapse

@@big_lock = 
Mutex.new
@@handle_box_url_locks = 
Hash.new { |h,k| h[k] = Mutex.new }

Instance Method Summary collapse

Constructor Details

#initialize(app, env) ⇒ HandleBoxUrl 



16
17
18
19
 
# File 'lib/vagrant/action/builtin/handle_box_url.rb', line 16

def initialize(app, env)
  @app = app
  @logger = Log4r::Logger.new("vagrant::action::builtin::handle_box_url")
end

Instance Method Details

#call(env) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/vagrant/action/builtin/handle_box_url.rb', line 21

def call(env)
  if !env[:machine].config.vm.box || !env[:machine].config.vm.box_url
    @logger.info("Skipping HandleBoxUrl because box or box_url not set.")
    @app.call(env)
    return
  end

  if !env[:machine].box
    # Get a "big lock" to make sure that our more fine grained
    # lock access is thread safe.
    lock = nil
    @@big_lock.synchronize do
      lock = @@handle_box_url_locks[env[:machine].config.vm.box]
    end

    # We can assume a box URL is set because the Vagrantfile
    # validation should do this for us. If not, though, we do
    # raise a terrible runtime error.
    box_name = env[:machine].config.vm.box
    box_url  = env[:machine].config.vm.box_url
    box_download_insecure = env[:machine].config.vm.box_download_insecure

    lock.synchronize do
      # First see if we actually have the box now.
      has_box = false

      box_formats = env[:machine].provider_options[:box_format] ||
        env[:machine].provider_name
      if env[:box_collection].find(box_name, box_formats)
        has_box = true
        break
      end

      if !has_box
        # Add the box then reload the box collection so that it becomes
        # aware of it.
        env[:ui].info I18n.t(
          "vagrant.actions.vm.check_box.not_found",
          :name => box_name,
          :provider => env[:machine].provider_name)

        begin
          env[:action_runner].run(Vagrant::Action.action_box_add, {
            :box_download_insecure => box_download_insecure,
            :box_name     => box_name,
            :box_provider => box_formats,
            :box_url      => box_url
          })
        rescue Errors::BoxAlreadyExists
          # Just ignore this, since it means the next part will succeed!
          # This can happen in a multi-threaded environment.
        end
      end
    end

    # Reload the environment and set the VM to be the new loaded VM.
    env[:machine] = env[:machine].env.machine(
      env[:machine].name, env[:machine].provider_name, true)
  end

  @app.call(env)
end