Class: Vagrant::Action::Builtin::BoxAdd

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

Overview

This middleware will download a remote box and add it to the given box collection.

Instance Method Summary collapse

Constructor Details

#initialize(app, env) ⇒ BoxAdd

Returns a new instance of BoxAdd.



12
13
14
15
 
# File 'lib/vagrant/action/builtin/box_add.rb', line 12

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

Instance Method Details

#call(env) ⇒ Object 



17
18
19
20
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/box_add.rb', line 17

def call(env)
  @temp_path = env[:tmp_path].join("box" + Time.now.to_i.to_s)
  @logger.info("Downloading box to: #{@temp_path}")

  url = env[:box_url]
  if File.file?(url) || url !~ /^[a-z0-9]+:.*$/i
    @logger.info("URL is a file or protocol not found and assuming file.")
    file_path = File.expand_path(url)
    file_path = Util::Platform.cygwin_windows_path(file_path)
    url = "file:#{file_path}"
  end

  downloader_options = {}
  downloader_options[:insecure] = env[:box_download_insecure]
  downloader_options[:ui] = env[:ui]

  # Download the box to a temporary path. We store the temporary
  # path as an instance variable so that the `#recover` method can
  # access it.
  env[:ui].info(I18n.t("vagrant.actions.box.download.downloading"))
  begin
    downloader = Util::Downloader.new(url, @temp_path, downloader_options)
    downloader.download!
  rescue Errors::DownloaderInterrupted
    # The downloader was interrupted, so just return, because that
    # means we were interrupted as well.
    env[:ui].info(I18n.t("vagrant.actions.box.download.interrupted"))
    return
  end

  box_formats = env[:box_provider]
  if box_formats
    # Determine the formats a box can support and allow the box to
    # be any of those formats.
    provider_plugin = Vagrant.plugin("2").manager.providers[env[:box_provider]]
    if provider_plugin
      box_formats = provider_plugin[1][:box_format]
      box_formats ||= env[:box_provider]
    end
  end

  # Add the box
  env[:ui].info I18n.t("vagrant.actions.box.add.adding", :name => env[:box_name])
  added_box = nil
  begin
    added_box = env[:box_collection].add(
      @temp_path, env[:box_name], box_formats, env[:box_force])
  rescue Vagrant::Errors::BoxUpgradeRequired
    # Upgrade the box
    env[:box_collection].upgrade(env[:box_name])

    # Try adding it again
    retry
  end

  # Call the 'recover' method in all cases to clean up the
  # downloaded temporary file.
  recover(env)

  # Success, we added a box!
  env[:ui].success(
    I18n.t("vagrant.actions.box.add.added", name: added_box.name, provider: added_box.provider))

  # Carry on!
  @app.call(env)
end

#recover(env) ⇒ Object 



84
85
86
87
88
 
# File 'lib/vagrant/action/builtin/box_add.rb', line 84

def recover(env)
  if @temp_path && File.exist?(@temp_path)
    File.unlink(@temp_path)
  end
end