utils

Documentation

Index

• Constants
• Variables
• func CheckConnection(url string, timeOut int) error
• func CleanPath(path string) string
• func CopyFile(source, destination string) error
• func CountLines(content string) int
• func DirExists(dirPath string) bool
• func DownloadFile(URL string, timeout int) (string, error)
• func EnsureDir(dirName string) error
• func FileExists(filePath string) bool
• func FilterPackID(content string, filter string) string
• func FormatPackVersion(pack []string) string
• func GetEncodedProgress() bool
• func GetSkipTouch() bool
• func IsBase64(s string) bool
• func IsEmpty(dir string) bool
• func IsPackNameValid(packName string) bool
• func IsPackVendorNameValid(vendorName string) bool
• func IsPackVersionValid(packVersion string) bool
• func IsTerminalInteractive() bool
• func ListDir(dir, pattern string) ([]string, error)
• func MoveFile(source, destination string) error
• func RandStringBytes(n int) string
• func ReadXML(path string, targetStruct interface{}) error
• func SecureCopy(dst io.Writer, src io.Reader) (int64, error)
• func SecureInflateFile(file *zip.File, destinationDir, stripPrefix string) error
• func SemverCompare(version1, version2 string) int
• func SemverMajor(version string) string
• func SetEncodedProgress(encodedProgress bool)
• func SetReadOnly(path string)
• func SetReadOnlyR(path string)
• func SetSkipTouch(skipTouch bool)
• func StartSignalWatcher()
• func StopSignalWatcher()
• func TouchFile(filePath string) error
• func UnsetReadOnly(path string)
• func UnsetReadOnlyR(path string)
• func WriteXML(path string, targetStruct interface{}) error
• type EncodedProgress
  • func NewEncodedProgress(max int64, instNo int, filename string) *EncodedProgress
  • func (p *EncodedProgress) Add(count int) int
  • func (p *EncodedProgress) Print()
  • func (p *EncodedProgress) Write(bs []byte) (int, error)
• type PackInfo
  • func ExtractPackInfo(packPath string) (PackInfo, error)
• type TimeoutTransport
  • func (t *TimeoutTransport) RoundTrip(req *http.Request) (*http.Response, error)

Constants

const (
	// Examples: Vendor::PackName@x.y.z, Vendor.PackName.x.y.z
	ExactVersion int = 0

	// Example: Vendor::PackName@latest
	LatestVersion = 1

	// Examples: Vendor::PackName, Vendor.PackName
	AnyVersion = 2

	// Example: Vendor::PackName>=x.y.z
	GreaterVersion = 3

	// Example: Vendor::PackName@~x.y.z (the greatest version of the pack keeping the same major number)
	GreatestCompatibleVersion = 4

	// For the <package/requirements/packages> spec only. Example: Vendor.PackName.a.b.c:x.y.z
	RangeVersion = 5
)

The version modifiers below are helpers to determine how to interpret the version specified by the packID.

const DownloadBufferSize = 4096

DownloadBufferSize is the number of bytes to transfer from the stream to the downloaded file per iteration. It is 4kb

Variables

var (
	// File RO (ReadOnly) and RW (Read + Write) modes
	FileModeRO = fs.FileMode(0444)
	FileModeRW = fs.FileMode(0666)

	// Directory RO (ReadOnly + Traverse) and RW (Read + Write + Traverse) modes
	DirModeRO = fs.FileMode(0555)
	DirModeRW = fs.FileMode(0777)
)

var CacheDir string

CacheDir is used for cpackget to temporarily host downloaded pack files before moving it to CMSIS_PACK_ROOT

var HTTPClient *http.Client

var MaxDownloadSize = int64(20 * 1024 * 1024 * 1024)

MaxDownloadSize determines that the max file to be downloaded. Defaults to 20G It prevents malicious requests from providing infinite or very long files

var ShouldAbortFunction func() bool

ShouldAbortFunction is a function that determines whether early termination was requested by the user

Functions

func CheckConnection

func CheckConnection(url string, timeOut int) error

func CleanPath

func CleanPath(path string) string

func CopyFile

func CopyFile(source, destination string) error

CopyFile copies the contents of source into a new file in destination

func CountLines

func CountLines(content string) int

CountLines returns the number of lines in a string Ref: https://stackoverflow.com/a/24563853

func DirExists

func DirExists(dirPath string) bool

DirExists checks if dirPath is an actual directory in the local file system

func DownloadFile

func DownloadFile(URL string, timeout int) (string, error)

DownloadFile downloads a file from an URL and saves it locally under destionationFilePath

func EnsureDir

func EnsureDir(dirName string) error

EnsureDir recursevily creates a directory tree if it doesn't exist already

func FileExists

func FileExists(filePath string) bool

FileExists checks if filePath is an actual file in the local file system

func FilterPackID

func FilterPackID(content string, filter string) string

FilterPackId returns the original string if any of the received filter words are present - designed specifically to filter pack IDs

func FormatPackVersion

func FormatPackVersion(pack []string) string

FormatPackVersion returns a modern representation of an internally versioned pack (for dependencies). Example: CMSIS,ARM,5.6.0:_ -> ARM::CMSIS@>=5.6.0 Ref: https://github.com/Open-CMSIS-Pack/devtools/blob/main/tools/projmgr/docs/Manual/YML-Input-Format.md#pack-name-conventions

func GetEncodedProgress

func GetEncodedProgress() bool

func GetSkipTouch

func GetSkipTouch() bool

func IsBase64

func IsBase64(s string) bool

IsBase64 tells whether a string is correctly b64 encoded.

func IsEmpty

func IsEmpty(dir string) bool

IsEmpty tells whether a directory specified by "dir" is empty or not

func IsPackNameValid

func IsPackNameValid(packName string) bool

IsPackNameValid checks whether a pack name string matches specified regular expression.

func IsPackVendorNameValid

func IsPackVendorNameValid(vendorName string) bool

IsVendorNameValid checks whether a pack vendor name string matches specified regular expression.

func IsPackVersionValid

func IsPackVersionValid(packVersion string) bool

IsPackVersion checks whether a pack version string matches specified regular expression

func IsTerminalInteractive

func IsTerminalInteractive() bool

IsTerminalInteractive tells whether or not the current terminal is capable of complex interactions

func ListDir

func ListDir(dir, pattern string) ([]string, error)

ListDir generates a list of files and directories in "dir". If pattern is specified, generates a list with matches only. It does NOT walk subdirectories

func MoveFile

func MoveFile(source, destination string) error

MoveFile moves a file from one source to destination

func RandStringBytes

func RandStringBytes(n int) string

RandStringBytes returns a random string with n bytes long Ref: https://stackoverflow.com/a/31832326/3908350

func ReadXML

func ReadXML(path string, targetStruct interface{}) error

ReadXML reads in a file into an XML struct

func SecureCopy

func SecureCopy(dst io.Writer, src io.Reader) (int64, error)

SecureCopy avoids potential DoS vulnerabilities when downloading a stream from a remote origin or decompressing a file. Ref: G110: Potential DoS vulnerability via decompression bomb (https://cwe.mitre.org/data/definitions/409.html)

func SecureInflateFile

func SecureInflateFile(file *zip.File, destinationDir, stripPrefix string) error

SecureInflateFile avoids potentions file traversal vulnerabilities when inflating compressed files. It avoids extracting files with "../" if stripPrefix is provided, use that to strip file.Name files

func SemverCompare

func SemverCompare(version1, version2 string) int

SemverCompare extends `semver.Compare` to work with leading zeros

func SemverMajor

func SemverMajor(version string) string

SemverMajor extends `semver.Major` to work with leading zeros

func SetEncodedProgress

func SetEncodedProgress(encodedProgress bool)

func SetReadOnly

func SetReadOnly(path string)

SetReadOnly takes in a file or directory and set it to read-only mode. Should work on both Windows and Linux.

func SetReadOnlyR

func SetReadOnlyR(path string)

SetReadOnlyR works the same as SetReadOnly, except that it is recursive

func SetSkipTouch

func SetSkipTouch(skipTouch bool)

func StartSignalWatcher

func StartSignalWatcher()

startSignalWatcher spins off a thread monitoring termination signals and retuns a function that returns whether termination was requested

func StopSignalWatcher

func StopSignalWatcher()

stopSignalWatcher sends a fake signal to the monitoring thread making it terminate

func TouchFile

func TouchFile(filePath string) error

TouchFile touches the file specified by filePath. If the file does not exist, create it. Touch also updates the modified timestamp of the file.

func UnsetReadOnly

func UnsetReadOnly(path string)

UnsetReadOnly takes in a file or directory and set it to read-only mode. Should work on both Windows and Linux.

func UnsetReadOnlyR

func UnsetReadOnlyR(path string)

UnsetReadOnlyR works the same as UnsetReadOnly, but recursive

func WriteXML

func WriteXML(path string, targetStruct interface{}) error

WriteXML writes an XML struct to a file

Types

type EncodedProgress

type EncodedProgress struct {
	// contains filtered or unexported fields
}

func NewEncodedProgress

func NewEncodedProgress(max int64, instNo int, filename string) *EncodedProgress

func (*EncodedProgress) Add

func (p *EncodedProgress) Add(count int) int

func (*EncodedProgress) Print

func (p *EncodedProgress) Print()

Encodes information to show progress when called by GUI or other tools * I: Instance number (always counts up), connected to the filename * F: Filename currently processed * T: Total bytes of file or numbers of files * P: Currently processed percentage * C: Currently processed bytes or numbers of files * J: Total number of files beeing processed * L: License file follows * O: Online connection Status [offline|online]

func (*EncodedProgress) Write

func (p *EncodedProgress) Write(bs []byte) (int, error)

type PackInfo

type PackInfo struct {
	Location, Vendor, Pack, Version, Extension string
	IsPackID                                   bool
	VersionModifier                            int
}

PackInfo defines a basic pack information set

func ExtractPackInfo

func ExtractPackInfo(packPath string) (PackInfo, error)

ExtractPackInfo takes in a path to a pack and extracts the needed information. It returns an error if any information is wrong Valid packPath's are: - /path/to/dev/Vendor.Pack.pdsc - /path/to/local/Vendor.Pack.Version.pack (or .zip) - https://web.com/Vendor.Pack.Version.pack (or .zip) If short is true, then prepare it considering that path is in the simpler form of Vendor.Pack[.x.y.z], used when removing packs/pdscs. NOTE: a malformed packPath e.g. "my.pack" DOES look like a valid

pack name, with "my" for vendor and "pack" for pack name.

type TimeoutTransport

type TimeoutTransport struct {
	http.Transport
	RoundTripTimeout time.Duration
}

func (*TimeoutTransport) RoundTrip

func (t *TimeoutTransport) RoundTrip(req *http.Request) (*http.Response, error)

Helper function to set timeouts on HTTP connections that use keep-alive connections (the most common one)