Add --all flag to core list command and gRPC interface

Setting that flags return all installed and installable platforms,
including installed manually by the user in their Sketchbook hardware
folder.

Author: silvanocerza

arduino/cores/cores.go

@@ -28,11 +28,12 @@ import (
 
 // Platform represents a platform package.
 type Platform struct {
-	Architecture string // The name of the architecture of this package.
-	Name         string
-	Category     string
-	Releases     map[string]*PlatformRelease // The Releases of this platform, labeled by version.
-	Package      *Package                    `json:"-"`
+	Architecture      string // The name of the architecture of this package.
+	Name              string
+	Category          string
+	Releases          map[string]*PlatformRelease // The Releases of this platform, labeled by version.
+	Package           *Package                    `json:"-"`
+	ManuallyInstalled bool                        // true if the Platform has been installed without the CLI
 }
 
 // PlatformReleaseHelp represents the help URL for this Platform release

arduino/cores/packagemanager/loader.go

@@ -166,18 +166,15 @@ func (pm *PackageManager) loadPlatforms(targetPackage *cores.Package, packageDir
 			return fmt.Errorf("looking for boards.txt in %s: %s", possibleBoardTxtPath, err)
 
 		} else if exist {
-
-			// case: ARCHITECTURE/boards.txt
-			// this is the general case for unversioned Platform
-			version := semver.MustParse("")
-
-			// FIXME: this check is duplicated, find a better way to handle this
-			if exist, err := platformPath.Join("boards.txt").ExistCheck(); err != nil {
-				return fmt.Errorf("opening boards.txt: %s", err)
-			} else if !exist {
-				continue
+			platformTxtPath := platformPath.Join("platform.txt")
+			platformProperties, err := properties.SafeLoad(platformTxtPath.String())
+			if err != nil {
+				return fmt.Errorf("loading platform.txt: %w", err)
 			}
 
+			platformName := platformProperties.Get("name")
+			version := semver.MustParse(platformProperties.Get("version"))
+
 			// check if package_bundled_index.json exists
 			isIDEBundled := false
 			packageBundledIndexPath := packageDir.Parent().Join("package_index_bundled.json")
@@ -210,6 +207,12 @@ func (pm *PackageManager) loadPlatforms(targetPackage *cores.Package, packageDir
 			}
 
 			platform := targetPackage.GetOrCreatePlatform(architecture)
+			if platform.Name == "" {
+				platform.Name = platformName
+			}
+			if !isIDEBundled {
+				platform.ManuallyInstalled = true
+			}
 			release := platform.GetOrCreateRelease(version)
 			release.IsIDEBundled = isIDEBundled
 			if isIDEBundled {

cli/core/list.go

@@ -39,11 +39,13 @@ func initListCommand() *cobra.Command {
 		Run:     runListCommand,
 	}
 	listCommand.Flags().BoolVar(&listFlags.updatableOnly, "updatable", false, "List updatable platforms.")
+	listCommand.Flags().BoolVar(&listFlags.all, "all", false, "If set return all installable and installed cores, including manually installed.")
 	return listCommand
 }
 
 var listFlags struct {
 	updatableOnly bool
+	all           bool
 }
 
 func runListCommand(cmd *cobra.Command, args []string) {
@@ -58,6 +60,7 @@ func runListCommand(cmd *cobra.Command, args []string) {
 	platforms, err := core.GetPlatforms(&rpc.PlatformListReq{
 		Instance:      inst,
 		UpdatableOnly: listFlags.updatableOnly,
+		All:           listFlags.all,
 	})
 	if err != nil {
 		feedback.Errorf("Error listing platforms: %v", err)

commands/core.go

@@ -51,13 +51,14 @@ func PlatformReleaseToRPC(platformRelease *cores.PlatformRelease) *rpc.Platform
 	}
 
 	result := &rpc.Platform{
-		ID:         platformRelease.Platform.String(),
-		Name:       platformRelease.Platform.Name,
-		Maintainer: platformRelease.Platform.Package.Maintainer,
-		Website:    platformRelease.Platform.Package.WebsiteURL,
-		Email:      platformRelease.Platform.Package.Email,
-		Boards:     boards,
-		Latest:     platformRelease.Version.String(),
+		ID:                platformRelease.Platform.String(),
+		Name:              platformRelease.Platform.Name,
+		Maintainer:        platformRelease.Platform.Package.Maintainer,
+		Website:           platformRelease.Platform.Package.WebsiteURL,
+		Email:             platformRelease.Platform.Package.Email,
+		Boards:            boards,
+		Latest:            platformRelease.Version.String(),
+		ManuallyInstalled: platformRelease.Platform.ManuallyInstalled,
 	}
 
 	return result

commands/core/list.go

@@ -39,6 +39,21 @@ func GetPlatforms(req *rpc.PlatformListReq) ([]*rpc.Platform, error) {
 	for _, targetPackage := range packageManager.Packages {
 		for _, platform := range targetPackage.Platforms {
 			platformRelease := packageManager.GetInstalledPlatformRelease(platform)
+
+			// If both All and UpdatableOnly are set All takes precedence
+			if req.All {
+				installedVersion := ""
+				if platformRelease == nil {
+					platformRelease = platform.GetLatestRelease()
+				} else {
+					installedVersion = platformRelease.Version.String()
+				}
+				rpcPlatform := commands.PlatformReleaseToRPC(platform.GetLatestRelease())
+				rpcPlatform.Installed = installedVersion
+				res = append(res, rpcPlatform)
+				continue
+			}
+
 			if platformRelease != nil {
 				if req.UpdatableOnly {
 					if latest := platform.GetLatestRelease(); latest == nil || latest == platformRelease {

commands/core/search.go

@@ -50,7 +50,10 @@ func PlatformSearch(req *rpc.PlatformSearchReq) (*rpc.PlatformSearchResp, error)
 		for _, targetPackage := range pm.Packages {
 			for _, platform := range targetPackage.Platforms {
 				// discard invalid platforms
-				if platform == nil || platform.Name == "" {
+				// Users can install platforms manually in the Sketchbook hardware folder,
+				// the core search command must operate only on platforms installed through
+				// the PlatformManager, thus we skip the manually installed ones.
+				if platform == nil || platform.Name == "" || platform.ManuallyInstalled {
 					continue
 				}
 

rpc/commands/core.pb.go

@@ -109,6 +109,10 @@ message PlatformListReq {
 	// Set to true to only list platforms which have a newer version available
 	// than the one currently installed.
 	bool updatable_only = 2;
+	// Set to true to list platforms installed manually in the user' sketchbook
+	// hardware folder, installed with the PlatformManager through the CLI or IDE
+	// and that are available to install
+	bool all = 3;
 }
 
 message PlatformListResp {
@@ -137,6 +141,9 @@ message Platform {
 	// not installed, this is an arbitrary list of board names provided by the
 	// platform author for display and may not match boards.txt.
 	repeated Board Boards = 8;
+	// If true this Platform has been installed manually in the user' sketchbook
+	// hardware folder
+	bool ManuallyInstalled = 9;
 }
 
 message Board {