16 "github.com/blang/semver"
17 "github.com/yosuke-furukawa/json5/encoding/json5"
18 "github.com/yuin/gopher-lua"
22 pluginChannels PluginChannels = PluginChannels{
23 PluginChannel("https://www.boombuler.de/channel.json"),
26 allPluginPackages PluginPackages = nil
29 // CorePluginName is a plugin dependency name for the micro core.
30 const CorePluginName = "micro"
32 // PluginChannel contains an url to a json list of PluginRepository
33 type PluginChannel string
35 // PluginChannels is a slice of PluginChannel
36 type PluginChannels []PluginChannel
38 // PluginRepository contains an url to json file containing PluginPackages
39 type PluginRepository string
41 // PluginPackage contains the meta-data of a plugin and all available versions
42 type PluginPackage struct {
47 Versions PluginVersions
50 // PluginPackages is a list of PluginPackage instances.
51 type PluginPackages []*PluginPackage
53 // PluginVersion descripes a version of a PluginPackage. Containing a version, download url and also dependencies.
54 type PluginVersion struct {
56 Version semver.Version
58 Require PluginDependencies
61 // PluginVersions is a slice of PluginVersion
62 type PluginVersions []*PluginVersion
64 // PluginDenendency descripes a dependency to another plugin or micro itself.
65 type PluginDependency struct {
70 // PluginDependencies is a slice of PluginDependency
71 type PluginDependencies []*PluginDependency
73 func (pp *PluginPackage) String() string {
74 buf := new(bytes.Buffer)
75 buf.WriteString("Plugin: ")
76 buf.WriteString(pp.Name)
79 buf.WriteString("Author: ")
80 buf.WriteString(pp.Author)
83 if pp.Description != "" {
84 buf.WriteString(pp.Description)
89 func fetchAllSources(count int, fetcher func(i int) PluginPackages) PluginPackages {
90 wgQuery := new(sync.WaitGroup)
93 results := make(chan PluginPackages)
95 wgDone := new(sync.WaitGroup)
97 var packages PluginPackages
98 for i := 0; i < count; i++ {
100 results <- fetcher(i)
105 packages = make(PluginPackages, 0)
106 for res := range results {
107 packages = append(packages, res...)
117 // Fetch retrieves all available PluginPackages from the given channels
118 func (pc PluginChannels) Fetch() PluginPackages {
119 return fetchAllSources(len(pc), func(i int) PluginPackages {
124 // Fetch retrieves all available PluginPackages from the given channel
125 func (pc PluginChannel) Fetch() PluginPackages {
126 messenger.AddLog(fmt.Sprintf("Fetching channel: %q", string(pc)))
127 resp, err := http.Get(string(pc))
129 TermMessage("Failed to query plugin channel:\n", err)
130 return PluginPackages{}
132 defer resp.Body.Close()
133 decoder := json5.NewDecoder(resp.Body)
135 var repositories []PluginRepository
136 if err := decoder.Decode(&repositories); err != nil {
137 TermMessage("Failed to decode channel data:\n", err)
138 return PluginPackages{}
140 return fetchAllSources(len(repositories), func(i int) PluginPackages {
141 return repositories[i].Fetch()
145 // Fetch retrieves all available PluginPackages from the given repository
146 func (pr PluginRepository) Fetch() PluginPackages {
147 messenger.AddLog(fmt.Sprintf("Fetching repository: %q", string(pr)))
148 resp, err := http.Get(string(pr))
150 TermMessage("Failed to query plugin repository:\n", err)
151 return PluginPackages{}
153 defer resp.Body.Close()
154 decoder := json5.NewDecoder(resp.Body)
156 var plugins PluginPackages
157 if err := decoder.Decode(&plugins); err != nil {
158 TermMessage("Failed to decode repository data:\n", err)
159 return PluginPackages{}
164 // UnmarshalJSON unmarshals raw json to a PluginVersion
165 func (pv *PluginVersion) UnmarshalJSON(data []byte) error {
167 Version semver.Version
169 Require map[string]string
172 if err := json5.Unmarshal(data, &values); err != nil {
175 pv.Version = values.Version
177 pv.Require = make(PluginDependencies, 0)
179 for k, v := range values.Require {
180 if vRange, err := semver.ParseRange(v); err == nil {
181 pv.Require = append(pv.Require, &PluginDependency{k, vRange})
187 // UnmarshalJSON unmarshals raw json to a PluginPackage
188 func (pp *PluginPackage) UnmarshalJSON(data []byte) error {
194 Versions PluginVersions
196 if err := json5.Unmarshal(data, &values); err != nil {
199 pp.Name = values.Name
200 pp.Description = values.Description
201 pp.Author = values.Author
202 pp.Tags = values.Tags
203 pp.Versions = values.Versions
204 for _, v := range pp.Versions {
210 // GetAllPluginPackages gets all PluginPackages which may be available.
211 func GetAllPluginPackages() PluginPackages {
212 if allPluginPackages == nil {
213 allPluginPackages = pluginChannels.Fetch()
215 return allPluginPackages
218 func (pv PluginVersions) find(ppName string) *PluginVersion {
219 for _, v := range pv {
220 if v.pack.Name == ppName {
227 // Len returns the number of pluginversions in this slice
228 func (pv PluginVersions) Len() int {
232 // Swap two entries of the slice
233 func (pv PluginVersions) Swap(i, j int) {
234 pv[i], pv[j] = pv[j], pv[i]
237 // Less returns true if the version at position i is greater then the version at position j (used for sorting)
238 func (s PluginVersions) Less(i, j int) bool {
239 return s[i].Version.GT(s[j].Version)
242 // Match returns true if the package matches a given search text
243 func (pp PluginPackage) Match(text string) bool {
244 text = strings.ToLower(text)
245 for _, t := range pp.Tags {
246 if strings.ToLower(t) == text {
250 if strings.Contains(strings.ToLower(pp.Name), text) {
254 if strings.Contains(strings.ToLower(pp.Description), text) {
261 // IsInstallable returns true if the package can be installed.
262 func (pp PluginPackage) IsInstallable() bool {
263 _, err := GetAllPluginPackages().Resolve(GetInstalledVersions(), PluginDependencies{
266 Range: semver.Range(func(v semver.Version) bool { return true }),
271 // SearchPlugin retrieves a list of all PluginPackages which match the given search text and
272 // could be or are already installed
273 func SearchPlugin(text string) (plugins PluginPackages) {
274 plugins = make(PluginPackages, 0)
275 for _, pp := range GetAllPluginPackages() {
276 if pp.Match(text) && pp.IsInstallable() {
277 plugins = append(plugins, pp)
283 func newStaticPluginVersion(name, version string) *PluginVersion {
284 vers, err := semver.ParseTolerant(version)
287 if vers, err = semver.ParseTolerant("0.0.0-" + version); err != nil {
288 vers = semver.MustParse("0.0.0-unknown")
291 pl := &PluginPackage{
294 pv := &PluginVersion{
298 pl.Versions = PluginVersions{pv}
302 // GetInstalledVersions returns a list of all currently installed plugins including an entry for
303 // micro itself. This can be used to resolve dependencies.
304 func GetInstalledVersions() PluginVersions {
305 result := PluginVersions{
306 newStaticPluginVersion(CorePluginName, Version),
309 for _, name := range loadedPlugins {
310 version := GetInstalledPluginVersion(name)
311 if pv := newStaticPluginVersion(name, version); pv != nil {
312 result = append(result, pv)
319 // GetInstalledPluginVersion returns the string of the exported VERSION variable of a loaded plugin
320 func GetInstalledPluginVersion(name string) string {
321 plugin := L.GetGlobal(name)
322 if plugin != lua.LNil {
323 version := L.GetField(plugin, "VERSION")
324 if str, ok := version.(lua.LString); ok {
332 func (pv *PluginVersion) DownloadAndInstall() error {
333 messenger.AddLog(fmt.Sprintf("Downloading %q (%s) from %q", pv.pack.Name, pv.Version, pv.Url))
334 resp, err := http.Get(pv.Url)
338 defer resp.Body.Close()
339 data, err := ioutil.ReadAll(resp.Body)
343 zipbuf := bytes.NewReader(data)
344 z, err := zip.NewReader(zipbuf, zipbuf.Size())
348 targetDir := filepath.Join(configDir, "plugins", pv.pack.Name)
349 dirPerm := os.FileMode(0755)
350 if err = os.MkdirAll(targetDir, dirPerm); err != nil {
353 for _, f := range z.File {
354 targetName := filepath.Join(targetDir, filepath.Join(strings.Split(f.Name, "/")...))
355 if f.FileInfo().IsDir() {
356 if err := os.MkdirAll(targetName, dirPerm); err != nil {
360 content, err := f.Open()
364 defer content.Close()
365 if target, err := os.Create(targetName); err != nil {
369 if _, err = io.Copy(target, content); err != nil {
378 func (pl PluginPackages) Get(name string) *PluginPackage {
379 for _, p := range pl {
387 func (pl PluginPackages) GetAllVersions(name string) PluginVersions {
388 result := make(PluginVersions, 0)
391 for _, v := range p.Versions {
392 result = append(result, v)
398 func (req PluginDependencies) Join(other PluginDependencies) PluginDependencies {
399 m := make(map[string]*PluginDependency)
400 for _, r := range req {
403 for _, o := range other {
406 m[o.Name] = &PluginDependency{
408 o.Range.AND(cur.Range),
414 result := make(PluginDependencies, 0, len(m))
415 for _, v := range m {
416 result = append(result, v)
421 func (all PluginPackages) Resolve(selectedVersions PluginVersions, open PluginDependencies) (PluginVersions, error) {
423 return selectedVersions, nil
425 currentRequirement, stillOpen := open[0], open[1:]
426 if currentRequirement != nil {
427 if selVersion := selectedVersions.find(currentRequirement.Name); selVersion != nil {
428 if currentRequirement.Range(selVersion.Version) {
429 return all.Resolve(selectedVersions, stillOpen)
431 return nil, fmt.Errorf("unable to find a matching version for \"%s\"", currentRequirement.Name)
433 availableVersions := all.GetAllVersions(currentRequirement.Name)
434 sort.Sort(availableVersions)
436 for _, version := range availableVersions {
437 if currentRequirement.Range(version.Version) {
438 resolved, err := all.Resolve(append(selectedVersions, version), stillOpen.Join(version.Require))
445 return nil, fmt.Errorf("unable to find a matching version for \"%s\"", currentRequirement.Name)
448 return selectedVersions, nil
452 func (versions PluginVersions) install() {
453 anyInstalled := false
454 currentlyInstalled := GetInstalledVersions()
456 for _, sel := range versions {
457 if sel.pack.Name != CorePluginName {
458 shouldInstall := true
459 if pv := currentlyInstalled.find(sel.pack.Name); pv != nil {
460 if pv.Version.NE(sel.Version) {
461 messenger.AddLog(fmt.Sprint("Uninstalling %q", sel.pack.Name))
462 UninstallPlugin(sel.pack.Name)
464 shouldInstall = false
469 if err := sel.DownloadAndInstall(); err != nil {
478 messenger.Message("One or more plugins installed. Please restart micro.")
480 messenger.AddLog("Nothing to install / update")
484 // UninstallPlugin deletes the plugin folder of the given plugin
485 func UninstallPlugin(name string) {
486 if err := os.RemoveAll(filepath.Join(configDir, "plugins", name)); err != nil {
491 func (pl PluginPackage) Install() {
492 selected, err := GetAllPluginPackages().Resolve(GetInstalledVersions(), PluginDependencies{
495 Range: semver.Range(func(v semver.Version) bool { return true }),
504 func UpdatePlugins() {
505 messenger.AddLog("Checking for plugin updates")
506 microVersion := PluginVersions{
507 newStaticPluginVersion(CorePluginName, Version),
510 var updates = make(PluginDependencies, 0)
511 for _, name := range loadedPlugins {
512 pv := GetInstalledPluginVersion(name)
513 r, err := semver.ParseRange(">=" + pv) // Try to get newer versions.
515 updates = append(updates, &PluginDependency{
522 selected, err := GetAllPluginPackages().Resolve(microVersion, updates)