add directories module

Author: Massimiliano Pippi

configuration/configuration.go

@@ -19,6 +19,7 @@ import (
 	"os"
 	"path/filepath"
 	"runtime"
+	"strings"
 
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/go-win32-utils"
@@ -27,17 +28,21 @@ import (
 )
 
 // Init initialize defaults and read the configuration file
-func Init() {
+func Init(configPath string) {
 	// Config file metadata
 	viper.SetConfigName("arduino-cli")
 
+	// Get default data path if none was provided
+	if configPath == "" {
+		configPath = getDefaultArduinoDataDir()
+	}
+
 	// Add paths where to search for a config file
-	configPath := GetDefaultArduinoDataDir()
 	logrus.Infof("Checking for config file in: %s", configPath)
 	viper.AddConfigPath(configPath)
 
 	// Set configuration defaults
-	setDefaults()
+	setDefaults(configPath, getDefaultSketchbookDir())
 
 	// Attempt to read config file
 	if err := viper.ReadInConfig(); err != nil {
@@ -50,11 +55,17 @@ func Init() {
 
 	// Bind env vars
 	viper.SetEnvPrefix("ARDUINO")
+	viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_"))
 	viper.AutomaticEnv()
+
+	// Bind env aliases to keep backward compatibility
+	viper.BindEnv("directories.Sketchbook", "ARDUINO_SKETCHBOOK_DIR")
+	viper.BindEnv("directories.Downloads", "ARDUINO_DOWNLOADS_DIR")
+	viper.BindEnv("directories.Data", "ARDUINO_DATA_DIR")
 }
 
-// GetDefaultArduinoDataDir returns the full path to the default arduino folder
-func GetDefaultArduinoDataDir() string {
+// getDefaultArduinoDataDir returns the full path to the default arduino folder
+func getDefaultArduinoDataDir() string {
 	userHomeDir, err := os.UserHomeDir()
 	if err != nil {
 		logrus.Errorf("Unable to get user home dir: %v", err)
@@ -77,3 +88,78 @@ func GetDefaultArduinoDataDir() string {
 		return "."
 	}
 }
+
+// getDefaultSketchbookDir returns the full path to the default sketchbook folder
+func getDefaultSketchbookDir() string {
+	userHomeDir, err := os.UserHomeDir()
+	if err != nil {
+		logrus.Errorf("Unable to get user home dir: %v", err)
+		return "."
+	}
+
+	switch runtime.GOOS {
+	case "linux":
+		return filepath.Join(userHomeDir, "Arduino")
+	case "darwin":
+		return filepath.Join(userHomeDir, "Documents", "Arduino")
+	case "windows":
+		documentsPath, err := win32.GetDocumentsFolder()
+		if err != nil {
+			logrus.Errorf("Unable to get Documents Folder: %v", err)
+			return "."
+		}
+		return filepath.Join(documentsPath, "Arduino")
+	default:
+		return "."
+	}
+}
+
+// IsBundledInDesktopIDE returns true if the CLI is bundled with the Arduino IDE.
+func IsBundledInDesktopIDE() bool {
+	// value is cached the first time we run the check
+	if viper.IsSet("IDE.Bundled") {
+		return viper.GetBool("IDE.Bundled")
+	}
+
+	viper.Set("IDE.Bundled", false)
+	viper.Set("IDE.Portable", false)
+
+	logrus.Info("Checking if CLI is Bundled into the IDE")
+	executable, err := os.Executable()
+	if err != nil {
+		logrus.WithError(err).Warn("Cannot get executable path")
+		return viper.GetBool("IDE.Bundled")
+	}
+
+	executablePath, err := filepath.EvalSymlinks(executable)
+	if err != nil {
+		logrus.WithError(err).Warn("Cannot get executable path")
+		return viper.GetBool("IDE.Bundled")
+	}
+
+	ideDir := filepath.Dir(executablePath)
+	logrus.Info("Candidate IDE Directory: ", ideDir)
+
+	// We check an arbitrary number of folders that are part of the IDE
+	// install tree
+	tests := []string{
+		"tools-builder",
+		"examples/01.Basics/Blink",
+		"portable",
+	}
+
+	for _, test := range tests {
+		if _, err := os.Stat(filepath.Join(ideDir, test)); err != nil {
+			// the test folder doesn't exist or is not accessible
+			return viper.GetBool("IDE.Bundled")
+		}
+
+		if test == "portable" {
+			logrus.Info("IDE is portable")
+			viper.Set("IDE.Portable", true)
+		}
+	}
+
+	viper.Set("IDE.Directory", ideDir)
+	return true
+}

configuration/defaults.go

@@ -21,11 +21,14 @@ import (
 	"github.com/spf13/viper"
 )
 
-func setDefaults() {
-	urls := []string{"https://downloads.arduino.cc/packages/package_index.json"}
-	viper.SetDefault("BoardManagerAdditionalUrls", urls)
+func setDefaults(dataDir, sketchBookDir string) {
+	// board manager settings
+	viper.SetDefault("board_manager.additional_urls", []string{})
 
-	dataDir := GetDefaultArduinoDataDir()
-	viper.SetDefault("DataDir", dataDir)
-	viper.SetDefault("DownloadsDir", filepath.Join(dataDir, "staging"))
+	// arduino directories
+	viper.SetDefault("directories.Data", dataDir)
+	viper.SetDefault("directories.Downloads", filepath.Join(dataDir, "staging"))
+	viper.SetDefault("directories.Packages", filepath.Join(dataDir, "packages"))
+	viper.SetDefault("directories.SketchBook", sketchBookDir)
+	viper.SetDefault("directories.Libraries", filepath.Join(sketchBookDir, "libraries"))
 }

configuration/directories.go

@@ -0,0 +1,78 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2019 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 [email protected].
+
+package configuration
+
+import (
+	"github.com/arduino/go-paths-helper"
+	"github.com/spf13/viper"
+)
+
+// HardwareDirectories returns all paths that may contains hardware packages.
+func HardwareDirectories() paths.PathList {
+	res := paths.PathList{}
+
+	if IsBundledInDesktopIDE() {
+		ideDir := paths.New(viper.GetString("IDE.Directory"))
+		bundledHardwareDir := ideDir.Join("hardware")
+		if bundledHardwareDir.IsDir() {
+			res.Add(bundledHardwareDir)
+		}
+	}
+
+	if viper.IsSet("directories.Packages") {
+		res.Add(paths.New(viper.GetString("directories.Packages")))
+	}
+
+	if viper.IsSet("directories.Sketchbook") {
+		skDir := paths.New(viper.GetString("directories.Sketchbook"))
+		hwDir := skDir.Join("hardware")
+		if hwDir.IsDir() {
+			res.Add(hwDir)
+		}
+	}
+
+	return res
+}
+
+// BundleToolsDirectories returns all paths that may contains bundled-tools.
+func BundleToolsDirectories() paths.PathList {
+	res := paths.PathList{}
+
+	if IsBundledInDesktopIDE() {
+		ideDir := paths.New(viper.GetString("IDE.Directory"))
+		bundledToolsDir := ideDir.Join("hardware", "tools")
+		if bundledToolsDir.IsDir() {
+			res = append(res, bundledToolsDir)
+		}
+	}
+
+	return res
+}
+
+// IDEBundledLibrariesDir returns the libraries directory bundled in
+// the Arduino IDE. If there is no Arduino IDE or the directory doesn't
+// exists then nil is returned
+func IDEBundledLibrariesDir() *paths.Path {
+	if IsBundledInDesktopIDE() {
+		ideDir := paths.New(viper.GetString("IDE.Directory"))
+		libDir := ideDir.Join("libraries")
+		if libDir.IsDir() {
+			return libDir
+		}
+	}
+
+	return nil
+}