1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 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 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
|
package core
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"os"
"path/filepath"
"strings"
"github.com/h2non/filetype"
"github.com/hashicorp/go-getter"
"github.com/hashicorp/go-hclog"
"github.com/hashicorp/vagrant-plugin-sdk/core"
"github.com/hashicorp/vagrant-plugin-sdk/helper/path"
"github.com/hashicorp/vagrant-plugin-sdk/localizer"
"github.com/hashicorp/vagrant-plugin-sdk/proto/vagrant_plugin_sdk"
"github.com/hashicorp/vagrant/internal/server/proto/vagrant_server"
"google.golang.org/protobuf/types/known/emptypb"
)
const (
TempPrefix = "vagrant-box-add-temp-"
VagrantSlash = "-VAGRANTSLASH-"
VagrantColon = "-VAGRANTCOLON-"
)
type BoxCollection struct {
basis *Basis
directory string
logger hclog.Logger
}
func NewBoxCollection(basis *Basis, dir string, logger hclog.Logger) (bc *BoxCollection, err error) {
bc = &BoxCollection{
basis: basis,
directory: dir,
logger: logger,
}
err = bc.RecoverBoxes()
return
}
// This adds a new box to the system.
// There are some exceptional cases:
// - BoxAlreadyExists - The box you're attempting to add already exists.
// - BoxProviderDoesntMatch - If the given box provider doesn't match the
// actual box provider in the untarred box.
// - BoxUnpackageFailure - An invalid tar file.
func (b *BoxCollection) Add(p path.Path, name, version, metadataURL string, force bool, providers ...string) (box core.Box, err error) {
if _, err := os.Stat(p.String()); err != nil {
return nil, fmt.Errorf("Could not add box, unable to find path %s", p.String())
}
exists, err := b.Find(name, version, providers...)
if err != nil {
return nil, err
}
if exists != nil && !force {
return nil, fmt.Errorf("Box already exits, can't add %s v%s", name, version)
} else {
if exists != nil {
// If the box already exists but force is enabled, then delete the box
exists.Destroy()
}
}
tempDir := filepath.Join(b.basis.dir.TempDir().String(), "box-extractor")
err = os.MkdirAll(tempDir, 0755)
if err != nil {
return nil, err
} // delete tempdir when finished
defer os.RemoveAll(tempDir)
b.logger.Debug("Unpacking box")
boxFile, err := os.Open(p.String())
if err != nil {
return nil, err
}
buffer := make([]byte, 512)
n, err := boxFile.Read(buffer)
if err != nil && err != io.EOF {
return nil, err
}
io.MultiReader(bytes.NewBuffer(buffer[:n]), boxFile)
typ, err := filetype.Match(buffer)
ext := typ.Extension
if typ.Extension == "gz" {
ext = "tar.gz"
}
decompressor := getter.Decompressors[ext]
err = decompressor.Decompress(tempDir, p.String(), true, os.ModeDir)
if err != nil {
return nil, err
}
// Check if the box is a V1 Vagrant box
if b.isV1Box(tempDir) {
b.basis.ui.Output(
localizer.LocalizeMsg("adding_v1_box", map[string]string{"BoxName": name}),
)
tempDir, err = b.upgradeV1Box(tempDir)
if err != nil {
return nil, err
}
}
newBox, err := NewBox(
BoxWithBasis(b.basis),
BoxWithBox(&vagrant_server.Box{
Name: name,
Version: version,
Directory: tempDir,
}),
)
if err != nil {
return nil, err
}
provider := newBox.box.Provider
if providers != nil {
foundProvider := false
for _, p := range providers {
if p == provider {
foundProvider = true
break
}
}
if !foundProvider {
return nil, fmt.Errorf("could not add box %s, provider '%s' does not match the expected providers %s", p.String(), provider, providers)
}
}
destDir := filepath.Join(b.directory, b.generateDirectoryName(name), version, provider)
b.logger.Debug("Box directory: %s", destDir)
os.MkdirAll(destDir, 0755)
// Copy the contents of the tempdir to the final dir
err = filepath.Walk(tempDir, func(path string, info os.FileInfo, erro error) (err error) {
destPath, err := validateNewPath(filepath.Join(destDir, info.Name()), destDir)
if err != nil {
return err
}
if info.IsDir() {
err = os.MkdirAll(destPath, info.Mode())
return err
} else {
data, err := os.Open(path)
if err != nil {
return err
}
defer data.Close()
dest, err := os.Create(destPath)
if err != nil {
return err
}
defer dest.Close()
if err != nil {
return err
}
if _, err := io.Copy(dest, data); err != nil {
return err
}
}
return
})
newBox, err = NewBox(
BoxWithBasis(b.basis),
BoxWithBox(&vagrant_server.Box{
Name: name,
Version: version,
Directory: destDir,
Provider: provider,
MetadataUrl: metadataURL,
}),
)
newBox.Save()
return newBox, nil
}
// This returns an array of all the boxes on the system
func (b *BoxCollection) All() (boxes []core.Box, err error) {
resp, err := b.basis.client.ListBoxes(
b.basis.ctx,
&emptypb.Empty{},
)
boxes = []core.Box{}
for _, boxRef := range resp.Boxes {
box, err := NewBox(
BoxWithBasis(b.basis),
BoxWithRef(boxRef, b.basis.ctx),
)
if err != nil {
return nil, err
}
boxes = append(boxes, box)
}
return
}
// Find a box in the collection with the given name, version and provider.
func (b *BoxCollection) Find(name, version string, providers ...string) (box core.Box, err error) {
// If no providers are spcified then search for any provider
if len(providers) == 0 {
providers = append(providers, "")
}
for _, provider := range providers {
resp, err := b.basis.client.FindBox(
b.basis.ctx,
&vagrant_server.FindBoxRequest{
Box: &vagrant_plugin_sdk.Ref_Box{
Name: name, Version: version, Provider: provider,
},
},
)
if err != nil {
return nil, err
}
if resp.Box != nil {
// Return the first box that is found
return NewBox(
BoxWithBasis(b.basis),
BoxWithBox(resp.Box),
)
}
}
return
}
// Cleans the directory for a box by removing the folders that are
// empty.
func (b *BoxCollection) Clean(name string) (err error) {
path := filepath.Join(b.directory, name)
return os.RemoveAll(path)
}
func (b *BoxCollection) RecoverBoxes() (err error) {
resp, err := b.basis.client.ListBoxes(
b.basis.ctx,
&emptypb.Empty{},
)
if err != nil {
return err
}
// Ensure that each box exists
for _, boxRef := range resp.Boxes {
box, erro := b.basis.client.GetBox(b.basis.ctx, &vagrant_server.GetBoxRequest{Box: boxRef})
// If the box directory does not exist, then the box doesn't exist.
if _, err := os.Stat(box.Box.Directory); err != nil {
// Remove the box
_, erro := b.basis.client.DeleteBox(b.basis.ctx, &vagrant_server.DeleteBoxRequest{Box: boxRef})
if erro != nil {
return erro
}
}
if erro != nil {
return erro
}
}
return
}
func (b *BoxCollection) generateDirectoryName(path string) (out string) {
out = strings.ReplaceAll(path, ":", VagrantColon)
return strings.ReplaceAll(out, "/", VagrantSlash)
}
func validateNewPath(path string, parentPath string) (newPath string, err error) {
newPath, err = filepath.Abs(path)
if err != nil {
return "", err
}
// Ensure that the newPath is within the parentPath
if !strings.HasPrefix(newPath, parentPath) {
return "", fmt.Errorf("could not add box outside of box directory %s", parentPath)
}
return
}
// Checks is the given directory represents a V1 box
func (b *BoxCollection) isV1Box(dir string) bool {
// If there is a box.ovf file then there is a good chance that this is a V1 box
boxOvfPath := filepath.Join(dir, "box.ovf")
if _, err := os.Stat(boxOvfPath); errors.Is(err, os.ErrNotExist) {
return false
}
// If a metadata.json file exists then this is not a V1 box
metadataPath := filepath.Join(dir, "metadata.json")
if _, err := os.Stat(metadataPath); err == nil {
return false
}
return true
}
// Upgrade the V1 box. This will destroy the contents of the old box
// in order to build the new box. The provider for the new box will
// be defaulted to be virtualbox.
func (b *BoxCollection) upgradeV1Box(dir string) (newDir string, err error) {
newDir, err = ioutil.TempDir(b.basis.dir.TempDir().String(), "box-update")
if err != nil {
return "", err
}
// Move contents of dir into tempDir
files, err := filepath.Glob(filepath.Join(dir, "*"))
if err != nil {
return "", err
}
for _, f := range files {
rel, err := filepath.Rel(dir, f)
if err != nil {
continue
}
if s, _ := os.Stat(f); s.IsDir() {
err = os.MkdirAll(filepath.Join(newDir, rel), os.ModePerm)
if err != nil {
return "", err
}
} else {
err = os.Rename(f, filepath.Join(newDir, rel))
if err != nil {
return "", err
}
}
}
// Write the metadata.json file if it does not exist
metadataFile := filepath.Join(newDir, "metadata.json")
if _, err := os.Stat(metadataFile); errors.Is(err, os.ErrNotExist) {
file, _ := json.MarshalIndent(
map[string]string{"provider": "virtualbox"}, "", " ",
)
err = ioutil.WriteFile(metadataFile, file, 0644)
if err != nil {
return "", err
}
}
return
}
var _ core.BoxCollection = (*BoxCollection)(nil)
|