Allow zip sketches with embedded libraries

Author: facchinm

Diff for: container_setup.go

@@ -46,8 +46,8 @@ func (s *ContainerSetupHardwareToolsLibsSketchAndProps) Run(ctx *types.Context)
 		&ToolsLoader{},
 		&TargetBoardResolver{},
 		&AddBuildBoardPropertyIfMissing{},
-		&LibrariesLoader{},
 		&SketchLoader{},
+		&LibrariesLoader{},
 		&SetupBuildProperties{},
 		&LoadVIDPIDSpecificProperties{},
 		&SetCustomBuildProperties{},

Diff for: libraries_loader.go

@@ -63,6 +63,10 @@ func (s *LibrariesLoader) Run(ctx *types.Context) error {
 
 	sortedLibrariesFolders = appendPathToLibrariesFolders(sortedLibrariesFolders, filepath.Join(platform.Folder, constants.FOLDER_LIBRARIES))
 
+	if ctx.SketchZipped {
+		sortedLibrariesFolders = appendPathToLibrariesFolders(sortedLibrariesFolders, filepath.Join(filepath.Dir(ctx.SketchLocation), constants.FOLDER_LIBRARIES))
+	}
+
 	librariesFolders := ctx.OtherLibrariesFolders
 	librariesFolders, err = utils.AbsolutizePaths(librariesFolders)
 	if err != nil {

Diff for: resolve_library.go

@@ -84,6 +84,11 @@ func ResolveLibrary(ctx *types.Context, header string) *types.Library {
 
 	library = useAlreadyImportedLibraryWithSameNameIfExists(library, importedLibraries)
 
+	if ctx.SketchZipped {
+		// select embedded library, in any case
+		library = libraryContainedInSketchFolder(libraries, filepath.Dir(ctx.SketchLocation))
+	}
+
 	libraryResolutionResults[header] = types.LibraryResolutionResult{
 		Library:          library,
 		NotUsedLibraries: filterOutLibraryFrom(libraries, library),
@@ -119,6 +124,15 @@ func useAlreadyImportedLibraryWithSameNameIfExists(library *types.Library, impor
 	return library
 }
 
+func libraryContainedInSketchFolder(libraries []*types.Library, sketchFolder string) *types.Library {
+	for _, lib := range libraries {
+		if strings.Contains(lib.Folder, sketchFolder) {
+			return lib
+		}
+	}
+	return libraries[0]
+}
+
 func filterOutLibraryFrom(libraries []*types.Library, libraryToRemove *types.Library) []*types.Library {
 	filteredOutLibraries := []*types.Library{}
 	for _, lib := range libraries {

Diff for: sketch_loader.go

@@ -30,7 +30,9 @@
 package builder
 
 import (
+	"bufio"
 	"io/ioutil"
+	"net/http"
 	"os"
 	"path/filepath"
 	"sort"
@@ -63,6 +65,17 @@ func (s *SketchLoader) Run(ctx *types.Context) error {
 		sketchLocation = filepath.Join(sketchLocation, mainSketchStat.Name()+".ino")
 	}
 
+	if mimeType(sketchLocation) == "application/zip" {
+		dir, _ := ioutil.TempDir("", "arduino_sketch_zip_temp")
+		sketchLocation, err = utils.ExtractZip(sketchLocation, dir)
+		if err != nil {
+			return nil
+		}
+		mainSketchFileName := filepath.Base(sketchLocation) + ".ino"
+		sketchLocation = filepath.Join(sketchLocation, mainSketchFileName)
+		ctx.SketchZipped = true
+	}
+
 	ctx.SketchLocation = sketchLocation
 
 	allSketchFilePaths, err := collectAllSketchFiles(filepath.Dir(sketchLocation))
@@ -87,6 +100,22 @@ func (s *SketchLoader) Run(ctx *types.Context) error {
 	return nil
 }
 
+func mimeType(fileName string) string {
+	fs, err := os.Open(fileName)
+
+	if err != nil {
+		return ""
+	}
+
+	defer fs.Close()
+
+	reader := bufio.NewReader(fs)
+
+	buf := make([]byte, 512)
+	reader.Read(buf)
+	return http.DetectContentType(buf)
+}
+
 func collectAllSketchFiles(from string) ([]string, error) {
 	filePaths := []string{}
 	// Source files in the root are compiled, non-recursively. This

Diff for: types/context.go

@@ -79,6 +79,9 @@ type Context struct {
 	Verbose           bool
 	DebugPreprocessor bool
 
+	// inoz handling
+	SketchZipped bool
+
 	// Contents of a custom build properties file (line by line)
 	CustomBuildProperties []string
 

Diff for: utils/utils.go

@@ -30,8 +30,10 @@
 package utils
 
 import (
+	"archive/zip"
 	"crypto/md5"
 	"encoding/hex"
+	"io"
 	"io/ioutil"
 	"os"
 	"os/exec"
@@ -488,3 +490,71 @@ func ParseCppString(line string) (string, string, bool) {
 		i += width
 	}
 }
+
+func ExtractZip(filePath string, location string) (string, error) {
+	r, err := zip.OpenReader(filePath)
+	if err != nil {
+		return location, err
+	}
+
+	var dirList []string
+
+	for _, f := range r.File {
+		dirList = append(dirList, f.Name)
+	}
+
+	basedir := findBaseDir(dirList)
+
+	for _, f := range r.File {
+		fullname := filepath.Join(location, strings.Replace(f.Name, "", "", -1))
+		if f.FileInfo().IsDir() {
+			os.MkdirAll(fullname, f.FileInfo().Mode().Perm())
+		} else {
+			os.MkdirAll(filepath.Dir(fullname), 0755)
+			perms := f.FileInfo().Mode().Perm()
+			out, err := os.OpenFile(fullname, os.O_CREATE|os.O_RDWR, perms)
+			if err != nil {
+				return location, err
+			}
+			rc, err := f.Open()
+			if err != nil {
+				return location, err
+			}
+			_, err = io.CopyN(out, rc, f.FileInfo().Size())
+			if err != nil {
+				return location, err
+			}
+			rc.Close()
+			out.Close()
+
+			mtime := f.FileInfo().ModTime()
+			err = os.Chtimes(fullname, mtime, mtime)
+			if err != nil {
+				return location, err
+			}
+		}
+	}
+	return filepath.Join(location, basedir), nil
+}
+
+func findBaseDir(dirList []string) string {
+	baseDir := ""
+	// https://github.com/backdrop-ops/contrib/issues/55#issuecomment-73814500
+	dontdiff := []string{"pax_global_header"}
+	for index := range dirList {
+		if SliceContains(dontdiff, dirList[index]) {
+			continue
+		}
+		candidateBaseDir := dirList[index]
+		for i := index; i < len(dirList); i++ {
+			if !strings.Contains(dirList[i], candidateBaseDir) {
+				return baseDir
+			}
+		}
+		// avoid setting the candidate if it is the last file
+		if dirList[len(dirList)-1] != candidateBaseDir {
+			baseDir = candidateBaseDir
+		}
+	}
+	return baseDir
+}