list.go

/*
 * This file is part of arduino-cli.
 *
 * Copyright 2018 ARDUINO SA (http://www.arduino.cc/)
 *
 * This software is released under the GNU General Public License version 3,
 * which covers the main part of arduino-cli.
 * The terms of this license can be found at:
 * https://www.gnu.org/licenses/gpl-3.0.en.html
 *
 * You can be released from the requirements of the above licenses by purchasing
 * a commercial license. Buying such a license is mandatory if you want to modify or
 * otherwise use the software for commercial activities involving the Arduino
 * software without disclosing the source code of your own applications. To purchase
 * a commercial license, send an email to license@arduino.cc.
 */

package lib

import (
	"fmt"
	"os"

	"github.com/arduino/arduino-cli/cli"
	"github.com/arduino/arduino-cli/commands/lib"
	"github.com/arduino/arduino-cli/common/formatter"
	rpc "github.com/arduino/arduino-cli/rpc/commands"
	"github.com/gosuri/uitable"
	"github.com/sirupsen/logrus"
	"github.com/spf13/cobra"
	"golang.org/x/net/context"
)

func initListCommand() *cobra.Command {
	listCommand := &cobra.Command{
		Use:     "list",
		Short:   "Shows a list of all installed libraries.",
		Long:    "Shows a list of all installed libraries.",
		Example: "  " + cli.VersionInfo.Application + " lib list",
		Args:    cobra.NoArgs,
		Run:     runListCommand,
	}
	listCommand.Flags().BoolVar(&listFlags.all, "all", false, "Include built-in libraries (from platforms and IDE) in listing.")
	listCommand.Flags().BoolVar(&listFlags.updatable, "updatable", false, "List updatable libraries.")
	return listCommand
}

var listFlags struct {
	all       bool
	updatable bool
}

func runListCommand(cmd *cobra.Command, args []string) {
	instance := cli.CreateInstaceIgnorePlatformIndexErrors()
	logrus.Info("Listing")

	res, err := lib.LibraryList(context.Background(), &rpc.LibraryListReq{
		Instance:  instance,
		All:       listFlags.all,
		Updatable: listFlags.updatable,
	})
	if err != nil {
		formatter.PrintError(err, "Error listing Libraries")
		os.Exit(cli.ErrGeneric)
	}
	if len(res.GetInstalledLibrary()) > 0 {
		results := res.GetInstalledLibrary()
		if cli.OutputJSONOrElse(results) {
			if len(results) > 0 {
				fmt.Println(outputListLibrary(results))
			} else {
				formatter.Print("Error listing Libraries")
			}
		}
	}
	logrus.Info("Done")
}

func outputListLibrary(il []*rpc.InstalledLibrary) string {
	table := uitable.New()
	table.MaxColWidth = 100
	table.Wrap = true

	hasUpdates := false
	for _, libMeta := range il {
		if libMeta.GetRelease() != nil {
			hasUpdates = true
		}
	}

	if hasUpdates {
		table.AddRow("Name", "Installed", "Available", "Location")
	} else {
		table.AddRow("Name", "Installed", "Location")
	}

	lastName := ""
	for _, libMeta := range il {
		lib := libMeta.GetLibrary()
		name := lib.Name
		if name == lastName {
			name = ` "`
		} else {
			lastName = name
		}

		location := lib.GetLocation()
		if lib.ContainerPlatform != "" {
			location = lib.GetContainerPlatform()
		}
		if hasUpdates {
			var available string
			if libMeta.GetRelease() != nil {
				available = libMeta.GetRelease().GetVersion()
			}
			table.AddRow(name, lib.Version, available, location)
		} else {
			table.AddRow(name, lib.Version, location)
		}
	}
	return fmt.Sprintln(table)
}