Skip to content

[skip-changelog] Avoid getting locked up in a perpetual symlink loop when loading a library #2146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 9, 2023
Merged

[skip-changelog] Avoid getting locked up in a perpetual symlink loop when loading a library #2146

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a760b7c
Improve library examples loading process by filtering out unneeded di…
MatteoPologruto Apr 12, 2023
a34f57d
Add tests for the changes
MatteoPologruto Apr 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Improve library examples loading process by filtering out unneeded di… 
…rectories
  • Loading branch information
@MatteoPologruto
MatteoPologruto committed May 3, 2023
commit a760b7c7dee1c7ea623763138f34cbdd44290c57
28 changes: 16 additions & 12 deletions arduino/libraries/loader.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import (
"strings"

"github.com/arduino/arduino-cli/arduino/globals"
"github.com/arduino/arduino-cli/arduino/sketch"
"github.com/arduino/go-paths-helper"
properties "github.com/arduino/go-properties-orderedmap"
"github.com/pkg/errors"
Expand Down Expand Up @@ -176,20 +175,11 @@ func addExamples(lib *Library) error {
}

func addExamplesToPathList(examplesPath *paths.Path, list *paths.PathList) error {
files, err := examplesPath.ReadDir()
files, err := examplesPath.ReadDirRecursiveFiltered(nil, paths.AndFilter(paths.FilterDirectories(), filterExamplesDirs))
if err != nil {
return err
}
for _, file := range files {
_, err := sketch.New(file)
if err == nil {
list.Add(file)
} else if file.IsDir() {
if err := addExamplesToPathList(file, list); err != nil {
return err
}
}
}
list.AddAll(files)
return nil
}

Expand All @@ -208,3 +198,17 @@ func containsHeaderFile(d *paths.Path) (bool, error) {
dirContent.FilterSuffix(headerExtensions...)
return len(dirContent) > 0, nil
}

// filterExamplesDirs filters out any directory that does not contain a ".ino" or ".pde" file
// with the correct casing
func filterExamplesDirs(dir *paths.Path) bool {
if list, err := dir.ReadDir(); err == nil {
list.FilterOutDirs()
list.FilterPrefix(dir.Base()+".ino", dir.Base()+".pde")
// accept only directories that contain a single correct sketch
if list.Len() == 1 {
return true
}
}
return false
}