Added support for external libraries

arduino/libraries/librariesmanager/install.go

@@ -16,13 +16,18 @@
 package librariesmanager
 
 import (
+	"context"
 	"errors"
 	"fmt"
+	"os"
+	"strings"
 
 	"github.com/arduino/arduino-cli/arduino/libraries"
 	"github.com/arduino/arduino-cli/arduino/libraries/librariesindex"
 	"github.com/arduino/arduino-cli/arduino/utils"
 	paths "github.com/arduino/go-paths-helper"
+	"github.com/codeclysm/extract/v3"
+	"gopkg.in/src-d/go-git.v4"
 )
 
 var (
@@ -85,3 +90,42 @@ func (lm *LibrariesManager) Uninstall(lib *libraries.Library) error {
 	lm.Libraries[lib.Name].Remove(lib)
 	return nil
 }
+
+//InstallZipLib  installs a Zip library on the specified path.
+func (lm *LibrariesManager) InstallZipLib(ctx context.Context, archivePath string) error {
+	libsDir := lm.getUserLibrariesDir()
+	if libsDir == nil {
+		return fmt.Errorf("User directory not set")
+	}
+
+	file, err := os.Open(archivePath)
+	if err != nil {
+		return err
+	}
+	defer file.Close()
+
+	if err := extract.Archive(ctx, file, libsDir.String(), nil); err != nil {
+		return fmt.Errorf("extracting archive: %s", err)
+	}
+	return nil
+}
+
+//InstallGitLib  installs a library hosted on a git repository on the specified path.
+func (lm *LibrariesManager) InstallGitLib(url string) error {
+	libsDir := lm.getUserLibrariesDir()
+	if libsDir == nil {
+		return fmt.Errorf("User directory not set")
+	}
+	i := strings.LastIndex(url, "/")
+	folder := strings.TrimRight(url[i+1:], ".git")
+	path := libsDir.Join(folder)
+
+	_, err := git.PlainClone(path.String(), false, &git.CloneOptions{
+		URL:      url,
+		Progress: os.Stdout,
+	})
+	if err != nil {
+		return err
+	}
+	return nil
+}

cli/lib/install.go

@@ -40,65 +40,91 @@ func initInstallCommand() *cobra.Command {
 		Run:  runInstallCommand,
 	}
 	installCommand.Flags().BoolVar(&installFlags.noDeps, "no-deps", false, "Do not install dependencies.")
+	installCommand.Flags().BoolVar(&installFlags.gitURL, "git-url", false, "Enter git url for libraries hosted on repositories")
+	installCommand.Flags().BoolVar(&installFlags.zipPath, "zip-path", false, "Enter a path to zip file")
 	return installCommand
 }
 
 var installFlags struct {
-	noDeps bool
+	noDeps  bool
+	gitURL  bool
+	zipPath bool
 }
 
 func runInstallCommand(cmd *cobra.Command, args []string) {
 	instance := instance.CreateInstanceIgnorePlatformIndexErrors()
-	libRefs, err := ParseLibraryReferenceArgsAndAdjustCase(instance, args)
-	if err != nil {
-		feedback.Errorf("Arguments error: %v", err)
-		os.Exit(errorcodes.ErrBadArgument)
-	}
-
-	toInstall := map[string]*rpc.LibraryDependencyStatus{}
-	if installFlags.noDeps {
-		for _, libRef := range libRefs {
-			toInstall[libRef.Name] = &rpc.LibraryDependencyStatus{
-				Name:            libRef.Name,
-				VersionRequired: libRef.Version,
-			}
+	if installFlags.zipPath {
+		ziplibraryInstallReq := &rpc.ZipLibraryInstallReq{
+			Instance: instance,
+			Path:     args[0],
+		}
+		err := lib.ZipLibraryInstall(context.Background(), ziplibraryInstallReq, output.TaskProgress())
+		if err != nil {
+			feedback.Errorf("Error installing Zip Library: %v", err)
+			os.Exit(errorcodes.ErrGeneric)
+		}
+	} else if installFlags.gitURL {
+		gitlibraryInstallReq := &rpc.GitLibraryInstallReq{
+			Instance: instance,
+			Url:      args[0],
+		}
+		err := lib.GitLibraryInstall(context.Background(), gitlibraryInstallReq, output.TaskProgress())
+		if err != nil {
+			feedback.Errorf("Error installing Git Library: %v", err)
+			os.Exit(errorcodes.ErrGeneric)
 		}
 	} else {
-		for _, libRef := range libRefs {
-			depsResp, err := lib.LibraryResolveDependencies(context.Background(), &rpc.LibraryResolveDependenciesReq{
-				Instance: instance,
-				Name:     libRef.Name,
-				Version:  libRef.Version,
-			})
-			if err != nil {
-				feedback.Errorf("Error resolving dependencies for %s: %s", libRef, err)
-				os.Exit(errorcodes.ErrGeneric)
+		libRefs, err := ParseLibraryReferenceArgsAndAdjustCase(instance, args)
+		if err != nil {
+			feedback.Errorf("Arguments error: %v", err)
+			os.Exit(errorcodes.ErrBadArgument)
+		}
+
+		toInstall := map[string]*rpc.LibraryDependencyStatus{}
+		if installFlags.noDeps {
+			for _, libRef := range libRefs {
+				toInstall[libRef.Name] = &rpc.LibraryDependencyStatus{
+					Name:            libRef.Name,
+					VersionRequired: libRef.Version,
+				}
 			}
-			for _, dep := range depsResp.GetDependencies() {
-				feedback.Printf("%s depends on %s@%s", libRef, dep.GetName(), dep.GetVersionRequired())
-				if existingDep, has := toInstall[dep.GetName()]; has {
-					if existingDep.GetVersionRequired() != dep.GetVersionRequired() {
-						// TODO: make a better error
-						feedback.Errorf("The library %s is required in two different versions: %s and %s",
-							dep.GetName(), dep.GetVersionRequired(), existingDep.GetVersionRequired())
-						os.Exit(errorcodes.ErrGeneric)
+		} else {
+			for _, libRef := range libRefs {
+				depsResp, err := lib.LibraryResolveDependencies(context.Background(), &rpc.LibraryResolveDependenciesReq{
+					Instance: instance,
+					Name:     libRef.Name,
+					Version:  libRef.Version,
+				})
+				if err != nil {
+					feedback.Errorf("Error resolving dependencies for %s: %s", libRef, err)
+					os.Exit(errorcodes.ErrGeneric)
+				}
+				for _, dep := range depsResp.GetDependencies() {
+					feedback.Printf("%s depends on %s@%s", libRef, dep.GetName(), dep.GetVersionRequired())
+					if existingDep, has := toInstall[dep.GetName()]; has {
+						if existingDep.GetVersionRequired() != dep.GetVersionRequired() {
+							// TODO: make a better error
+							feedback.Errorf("The library %s is required in two different versions: %s and %s",
+								dep.GetName(), dep.GetVersionRequired(), existingDep.GetVersionRequired())
+							os.Exit(errorcodes.ErrGeneric)
+						}
 					}
+					toInstall[dep.GetName()] = dep
 				}
-				toInstall[dep.GetName()] = dep
 			}
 		}
-	}
 
-	for _, library := range toInstall {
-		libraryInstallReq := &rpc.LibraryInstallReq{
-			Instance: instance,
-			Name:     library.Name,
-			Version:  library.VersionRequired,
-		}
-		err := lib.LibraryInstall(context.Background(), libraryInstallReq, output.ProgressBar(), output.TaskProgress())
-		if err != nil {
-			feedback.Errorf("Error installing %s: %v", library, err)
-			os.Exit(errorcodes.ErrGeneric)
+		for _, library := range toInstall {
+			libraryInstallReq := &rpc.LibraryInstallReq{
+				Instance: instance,
+				Name:     library.Name,
+				Version:  library.VersionRequired,
+			}
+			err := lib.LibraryInstall(context.Background(), libraryInstallReq, output.ProgressBar(), output.TaskProgress())
+			if err != nil {
+				feedback.Errorf("Error installing %s: %v", library, err)
+				os.Exit(errorcodes.ErrGeneric)
+			}
 		}
 	}
 }

commands/daemon/daemon.go

@@ -356,3 +356,27 @@ func (s *ArduinoCoreServerImpl) LibraryList(ctx context.Context, req *rpc.Librar
 func (s *ArduinoCoreServerImpl) ArchiveSketch(ctx context.Context, req *rpc.ArchiveSketchReq) (*rpc.ArchiveSketchResp, error) {
 	return sketch.ArchiveSketch(ctx, req)
 }
+
+//ZipLibraryInstall FIXMEDOC
+func (s *ArduinoCoreServerImpl) ZipLibraryInstall(req *rpc.ZipLibraryInstallReq, stream rpc.ArduinoCore_ZipLibraryInstallServer) error {
+	err := lib.ZipLibraryInstall(
+		stream.Context(), req,
+		func(p *rpc.TaskProgress) { stream.Send(&rpc.ZipLibraryInstallResp{TaskProgress: p}) },
+	)
+	if err != nil {
+		return err
+	}
+	return stream.Send(&rpc.ZipLibraryInstallResp{})
+}
+
+//GitLibraryInstall FIXMEDOC
+func (s *ArduinoCoreServerImpl) GitLibraryInstall(req *rpc.GitLibraryInstallReq, stream rpc.ArduinoCore_GitLibraryInstallServer) error {
+	err := lib.GitLibraryInstall(
+		stream.Context(), req,
+		func(p *rpc.TaskProgress) { stream.Send(&rpc.GitLibraryInstallResp{TaskProgress: p}) },
+	)
+	if err != nil {
+		return err
+	}
+	return stream.Send(&rpc.GitLibraryInstallResp{})
+}

commands/lib/install.go

@@ -75,3 +75,25 @@ func installLibrary(lm *librariesmanager.LibrariesManager, libRelease *libraries
 	taskCB(&rpc.TaskProgress{Message: "Installed " + libRelease.String(), Completed: true})
 	return nil
 }
+
+//ZipLibraryInstall FIXMEDOC
+func ZipLibraryInstall(ctx context.Context, req *rpc.ZipLibraryInstallReq, taskCB commands.TaskProgressCB) error {
+	lm := commands.GetLibraryManager(req.GetInstance().GetId())
+	archivePath := req.GetPath()
+	if err := lm.InstallZipLib(ctx, archivePath); err != nil {
+		return err
+	}
+	taskCB(&rpc.TaskProgress{Message: "Installed Archived Library", Completed: true})
+	return nil
+}
+
+//GitLibraryInstall FIXMEDOC
+func GitLibraryInstall(ctx context.Context, req *rpc.GitLibraryInstallReq, taskCB commands.TaskProgressCB) error {
+	lm := commands.GetLibraryManager(req.GetInstance().GetId())
+	url := req.GetUrl()
+	if err := lm.InstallGitLib(url); err != nil {
+		return err
+	}
+	taskCB(&rpc.TaskProgress{Message: "Installed Library from Git URL", Completed: true})
+	return nil
+}

go.mod

@@ -21,18 +21,22 @@ require (
 	github.com/h2non/filetype v1.0.8 // indirect
 	github.com/imjasonmiller/godice v0.1.2
 	github.com/juju/loggo v0.0.0-20190526231331-6e530bcce5d8 // indirect
+	github.com/kr/pretty v0.2.0 // indirect
+	github.com/kr/text v0.2.0 // indirect
 	github.com/leonelquinteros/gotext v1.4.0
 	github.com/marcinbor85/gohex v0.0.0-20200531163658-baab2527a9a2
 	github.com/mattn/go-colorable v0.1.2
 	github.com/mattn/go-isatty v0.0.8
 	github.com/mattn/go-runewidth v0.0.9 // indirect
 	github.com/miekg/dns v1.0.5 // indirect
+	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
 	github.com/oleksandr/bonjour v0.0.0-20160508152359-5dcf00d8b228 // indirect
 	github.com/pkg/errors v0.9.1
 	github.com/pmylund/sortutil v0.0.0-20120526081524-abeda66eb583
 	github.com/rifflock/lfshook v0.0.0-20180920164130-b9218ef580f5
 	github.com/schollz/closestmatch v2.1.0+incompatible
 	github.com/segmentio/stats/v4 v4.5.3
+	github.com/sergi/go-diff v1.1.0 // indirect
 	github.com/sirupsen/logrus v1.4.2
 	github.com/spf13/cobra v1.0.1-0.20200710201246-675ae5f5a98c
 	github.com/spf13/jwalterweatherman v1.0.0
@@ -43,11 +47,13 @@ require (
 	go.bug.st/relaxed-semver v0.0.0-20190922224835-391e10178d18
 	go.bug.st/serial v1.1.1
 	go.bug.st/serial.v1 v0.0.0-20180827123349-5f7892a7bb45 // indirect
-	golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2
-	golang.org/x/net v0.0.0-20200202094626-16171245cfb2
+	golang.org/x/crypto v0.0.0-20200406173513-056763e48d71
+	golang.org/x/net v0.0.0-20200324143707-d3edc9973b7e
 	golang.org/x/text v0.3.2
 	google.golang.org/grpc v1.27.0
 	google.golang.org/protobuf v1.25.0
+	gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
 	gopkg.in/mgo.v2 v2.0.0-20180705113604-9856a29383ce // indirect
+	gopkg.in/src-d/go-git.v4 v4.13.1
 	gopkg.in/yaml.v2 v2.3.0
 )