|
| 1 | +// SPDX-FileCopyrightText: Copyright The Lima Authors |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package plugin |
| 5 | + |
| 6 | +import ( |
| 7 | + "os" |
| 8 | + "path/filepath" |
| 9 | + "strings" |
| 10 | + |
| 11 | + "github.com/sirupsen/logrus" |
| 12 | + |
| 13 | + "github.com/lima-vm/lima/v2/pkg/usrlocalsharelima" |
| 14 | +) |
| 15 | + |
| 16 | +type Plugin struct { |
| 17 | + Name string `json:"name"` |
| 18 | + Path string `json:"path"` |
| 19 | + Description string `json:"description,omitempty"` |
| 20 | +} |
| 21 | + |
| 22 | +func DiscoverPlugins() ([]Plugin, error) { |
| 23 | + var plugins []Plugin |
| 24 | + seen := make(map[string]bool) |
| 25 | + |
| 26 | + dirs := getPluginDirectories() |
| 27 | + |
| 28 | + for _, dir := range dirs { |
| 29 | + pluginsInDir, err := scanDirectory(dir) |
| 30 | + if err != nil { |
| 31 | + logrus.Debugf("Failed to scan directory %s: %v", dir, err) |
| 32 | + continue |
| 33 | + } |
| 34 | + |
| 35 | + for _, plugin := range pluginsInDir { |
| 36 | + if !seen[plugin.Name] { |
| 37 | + plugins = append(plugins, plugin) |
| 38 | + seen[plugin.Name] = true |
| 39 | + } |
| 40 | + } |
| 41 | + } |
| 42 | + |
| 43 | + return plugins, nil |
| 44 | +} |
| 45 | + |
| 46 | +func getPluginDirectories() []string { |
| 47 | + var dirs []string |
| 48 | + |
| 49 | + selfPaths := []string{} |
| 50 | + |
| 51 | + selfViaArgs0, err := usrlocalsharelima.ExecutableViaArgs0() |
| 52 | + if err != nil { |
| 53 | + logrus.WithError(err).Debug("failed to find executable") |
| 54 | + } else { |
| 55 | + selfPaths = append(selfPaths, selfViaArgs0) |
| 56 | + } |
| 57 | + |
| 58 | + selfViaOS, err := os.Executable() |
| 59 | + if err != nil { |
| 60 | + logrus.WithError(err).Debug("failed to find os.Executable()") |
| 61 | + } else { |
| 62 | + selfFinalPathViaOS, err := filepath.EvalSymlinks(selfViaOS) |
| 63 | + if err != nil { |
| 64 | + logrus.WithError(err).Debug("failed to resolve symlinks") |
| 65 | + selfFinalPathViaOS = selfViaOS |
| 66 | + } |
| 67 | + |
| 68 | + if len(selfPaths) == 0 || selfFinalPathViaOS != selfPaths[0] { |
| 69 | + selfPaths = append(selfPaths, selfFinalPathViaOS) |
| 70 | + } |
| 71 | + } |
| 72 | + |
| 73 | + for _, self := range selfPaths { |
| 74 | + binDir := filepath.Dir(self) |
| 75 | + dirs = append(dirs, binDir) |
| 76 | + } |
| 77 | + |
| 78 | + pathEnv := os.Getenv("PATH") |
| 79 | + if pathEnv != "" { |
| 80 | + pathDirs := filepath.SplitList(pathEnv) |
| 81 | + dirs = append(dirs, pathDirs...) |
| 82 | + } |
| 83 | + |
| 84 | + if prefixDir, err := usrlocalsharelima.Prefix(); err == nil { |
| 85 | + libexecDir := filepath.Join(prefixDir, "libexec", "lima") |
| 86 | + if _, err := os.Stat(libexecDir); err == nil { |
| 87 | + dirs = append(dirs, libexecDir) |
| 88 | + } |
| 89 | + } |
| 90 | + |
| 91 | + return dirs |
| 92 | +} |
| 93 | + |
| 94 | +func scanDirectory(dir string) ([]Plugin, error) { |
| 95 | + var plugins []Plugin |
| 96 | + |
| 97 | + entries, err := os.ReadDir(dir) |
| 98 | + if err != nil { |
| 99 | + return nil, err |
| 100 | + } |
| 101 | + |
| 102 | + for _, entry := range entries { |
| 103 | + if entry.IsDir() { |
| 104 | + continue |
| 105 | + } |
| 106 | + |
| 107 | + name := entry.Name() |
| 108 | + if !strings.HasPrefix(name, "limactl-") { |
| 109 | + continue |
| 110 | + } |
| 111 | + |
| 112 | + pluginName := strings.TrimPrefix(name, "limactl-") |
| 113 | + |
| 114 | + if strings.Contains(pluginName, ".") { |
| 115 | + if filepath.Ext(name) == ".exe" { |
| 116 | + pluginName = strings.TrimSuffix(pluginName, ".exe") |
| 117 | + } else { |
| 118 | + continue |
| 119 | + } |
| 120 | + } |
| 121 | + |
| 122 | + fullPath := filepath.Join(dir, name) |
| 123 | + |
| 124 | + if !isExecutable(fullPath) { |
| 125 | + continue |
| 126 | + } |
| 127 | + |
| 128 | + plugin := Plugin{ |
| 129 | + Name: pluginName, |
| 130 | + Path: fullPath, |
| 131 | + } |
| 132 | + |
| 133 | + if desc := extractDescFromScript(fullPath); desc != "" { |
| 134 | + plugin.Description = desc |
| 135 | + } |
| 136 | + |
| 137 | + plugins = append(plugins, plugin) |
| 138 | + } |
| 139 | + |
| 140 | + return plugins, nil |
| 141 | +} |
| 142 | + |
| 143 | +func isExecutable(path string) bool { |
| 144 | + info, err := os.Stat(path) |
| 145 | + if err != nil { |
| 146 | + return false |
| 147 | + } |
| 148 | + |
| 149 | + mode := info.Mode() |
| 150 | + if mode&0o111 != 0 { |
| 151 | + return true |
| 152 | + } |
| 153 | + |
| 154 | + if filepath.Ext(path) == ".exe" { |
| 155 | + return true |
| 156 | + } |
| 157 | + |
| 158 | + return false |
| 159 | +} |
| 160 | + |
| 161 | +func extractDescFromScript(path string) string { |
| 162 | + content, err := os.ReadFile(path) |
| 163 | + if err != nil { |
| 164 | + logrus.Debugf("Failed to read plugin script %s: %v", path, err) |
| 165 | + return "" |
| 166 | + } |
| 167 | + |
| 168 | + lines := strings.Split(string(content), "\n") |
| 169 | + for _, line := range lines { |
| 170 | + line = strings.TrimSpace(line) |
| 171 | + |
| 172 | + // Look for pattern: # <limactl-desc>Description text</limactl-desc> |
| 173 | + if strings.HasPrefix(line, "#") && strings.Contains(line, "<limactl-desc>") && strings.Contains(line, "</limactl-desc>") { |
| 174 | + start := strings.Index(line, "<limactl-desc>") + len("<limactl-desc>") |
| 175 | + end := strings.Index(line, "</limactl-desc>") |
| 176 | + |
| 177 | + if start < end { |
| 178 | + desc := strings.TrimSpace(line[start:end]) |
| 179 | + logrus.Debugf("Plugin %s: extracted description from script: %q", filepath.Base(path), desc) |
| 180 | + return desc |
| 181 | + } |
| 182 | + } |
| 183 | + } |
| 184 | + |
| 185 | + logrus.Debugf("Plugin %s: no <limactl-desc> found in script", filepath.Base(path)) |
| 186 | + |
| 187 | + return "" |
| 188 | +} |
| 189 | + |
| 190 | +func UpdatePathForPlugins() error { |
| 191 | + pluginDirs := getPluginDirectories() |
| 192 | + newPath := strings.Join(pluginDirs, string(filepath.ListSeparator)) |
| 193 | + return os.Setenv("PATH", newPath) |
| 194 | +} |
0 commit comments