Merge pull request #118 from contre95/fix/plugin_autolaod

fix(plugins): Load plugins from repo's url

Author: contre95

README.md

@@ -6,9 +6,21 @@
 </table>
 
 [![Join Discord](https://img.shields.io/badge/Discord-Join%20Server-5865F2?logo=discord&logoColor=white)](https://discord.gg/mHRjGAjEJz)
-[See Demo](https://soulsolid-demo.contre.io/)
 
-A feature rich music organization app built for the music hoarder. Heavily under development, focused on ease of usage.
+A work in progress, feature rich music organization app built for the music hoarder. Heavily under development, focused on ease of usage and start up. Feel free to check the [docs](https://soulsolid.contre.io) or [demo](https://soulsolid-demo.contre.io)
+
+## Screenshots
+<table>
+  <tr>
+    <td>
+      <img src="./docs/screen0.jpg" />
+    </td>
+    <td>
+      <img src="./docs/screen1.jpg" />
+    </td>
+  </tr>
+</table>
+
 ## Features
 - **Music Library Management**: Organize and browse albums, artists, and tracks
 - **Downloading**: Download tracks and albums. 
@@ -20,6 +32,8 @@ A feature rich music organization app built for the music hoarder. Heavily under
 - **Job Management**: Background processing for downloads, imports, and syncs
 
 Documentation: https://soulsolid.contre.io
+Demo: https://soulsolid-demo.contre.io
+
 
 ## Quick Start
 
@@ -52,7 +66,7 @@ podman run -d \
   -p 3535:3535 \
   -v /host/music:/app/library \
   -v /host/downloads:/app/downloads \
-  -v /host/logs:/app/logs \
+  -v /host/logs:/app/logs \ # optional
   -v /host/library.db:/data/library.db \
   -v /host/config.yaml:/config/config.yaml \
   soulsolid
@@ -92,6 +106,4 @@ nix-shell dev.nix
 # Then, simply run:
 go run ./src/main.go
 ```
-
 The web interface will be available at `http://localhost:3535`.
-

docs/plugins.md

@@ -136,7 +136,10 @@ Example config.yaml:
 downloaders:
   plugins:
     - name: "mydownloader"
-      path: "/path/to/mydownloader.so"
+      # Either specify a URL to build from git:
+      url: "https://github.com/user/soulsolid-myplugin.git"
+      # Or specify a path to a pre-built .so file:
+      # path: "/path/to/mydownloader.so"
       icon: "path/to/icon.png"  # Optional icon for the downloader
       config:
         api_key: "your_api_key_here"
@@ -146,11 +149,55 @@ downloaders:
 
 ## Distribution
 
-1. **Build for the target platform:** Make sure to build the plugin for the same OS and architecture as the Soulsolid binary.
+There are two ways to distribute plugins:
 
+### Option 1: Pre-built .so files
+1. **Build for the target platform:** Make sure to build the plugin for the same OS and architecture as the Soulsolid binary.
 2. **Distribute the .so file:** Users can place the `.so` file anywhere accessible to Soulsolid and configure the path in their config.
 
-3. **Version compatibility:** Plugins should be built against the same version of Soulsolid to ensure API compatibility.
+### Option 2: Git repositories
+1. **Publish your plugin source code** in a public git repository with a valid `go.mod` file.
+2. **Users configure the repository URL** in their Soulsolid config (see "Building from Git Repositories" section below).
+
+### Version compatibility
+Plugins should be built against the same version of Soulsolid to ensure API compatibility.
+
+## Building from Git Repositories
+
+Soulsolid can automatically build plugins directly from git repositories. Instead of distributing pre-built `.so` files, you can specify a repository URL in your configuration.
+
+### Configuration Example
+
+```yaml
+downloaders:
+  plugins:
+    - name: "mydownloader"
+      url: "https://github.com/user/soulsolid-myplugin.git"
+      # path: "/fallback.so"  # Optional fallback path if URL building fails
+      config:
+        api_key: "your_api_key_here"
+```
+
+### Requirements
+
+- **git** must be installed and available in PATH
+- **go** must be installed (same version as the main application) and available in PATH
+- Network access to clone the repository
+
+### How It Works
+
+1. Soulsolid clones the repository (default branch only, depth=1)
+2. Adds a replace directive to use the local soulsolid module
+3. Runs `go mod tidy` to resolve dependencies
+4. Builds the plugin with `go build -buildmode=plugin`
+5. Loads the built `.so` file into memory
+
+### Notes
+
+- Plugins are rebuilt each time Soulsolid starts (no caching)
+- Only the default branch is cloned (no branch/tag/commit support)
+- Repository must contain a `go.mod` file at the root
+- Building arbitrary code carries inherent security risks (same as loading pre-built `.so` files)
 
 ## Best Practices
 

docs/screen0.jpg

@@ -127,6 +127,7 @@ type EmbeddedArtwork struct {
 type PluginConfig struct {
 	Name   string         `yaml:"name"`
 	Path   string         `yaml:"path"`
+	URL    string         `yaml:"url,omitempty"`
 	Icon   string         `yaml:"icon,omitempty"`
 	Config map[string]any `yaml:"config"`
 }

docs/screen1.jpg

@@ -1,14 +1,19 @@
 package downloading
 
 import (
+	"bytes"
+	"context"
 	"fmt"
 	"io"
 	"log/slog"
 	"net/http"
 	"os"
+	"os/exec"
+	"path/filepath"
 	"plugin"
 	"strings"
 	"sync"
+	"time"
 
 	"github.com/contre95/soulsolid/src/features/config"
 )
@@ -22,6 +27,139 @@ type PluginManager struct {
 	mu          sync.RWMutex
 }
 
+// findModuleRoot finds the root directory of the current Go module by looking for go.mod
+func findModuleRoot() (string, error) {
+	dir, err := os.Getwd()
+	if err != nil {
+		return "", fmt.Errorf("failed to get working directory: %w", err)
+	}
+
+	for {
+		goModPath := filepath.Join(dir, "go.mod")
+		if _, err := os.Stat(goModPath); err == nil {
+			return dir, nil
+		}
+
+		parent := filepath.Dir(dir)
+		if parent == dir {
+			break // reached root
+		}
+		dir = parent
+	}
+
+	return "", fmt.Errorf("go.mod not found in current or parent directories")
+}
+
+// buildFromGit builds a plugin from a git repository URL
+func buildFromGit(url string) (string, error) {
+	// Create temporary directory for cloning and building
+	tempDir, err := os.MkdirTemp("", "soulsolid-plugin-*")
+	if err != nil {
+		return "", fmt.Errorf("failed to create temp directory: %w", err)
+	}
+
+	// Clean up temp directory on error
+	var buildErr error
+	defer func() {
+		if buildErr != nil {
+			os.RemoveAll(tempDir)
+		}
+	}()
+
+	slog.Debug("Cloning git repository", "url", url, "tempDir", tempDir)
+
+	// Clone repository
+	ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
+	defer cancel()
+
+	cmd := exec.CommandContext(ctx, "git", "clone", "--depth", "1", url, tempDir)
+	var stderr bytes.Buffer
+	cmd.Stderr = &stderr
+	if err := cmd.Run(); err != nil {
+		buildErr = fmt.Errorf("failed to clone repository: %w: %s", err, stderr.String())
+		return "", buildErr
+	}
+
+	// Find module root of soulsolid
+	moduleRoot, err := findModuleRoot()
+	if err != nil {
+		buildErr = fmt.Errorf("failed to find soulsolid module root: %w", err)
+		return "", buildErr
+	}
+
+	pluginDir := tempDir
+
+	// Check if go.mod exists in plugin directory
+	goModPath := filepath.Join(pluginDir, "go.mod")
+	if _, err := os.Stat(goModPath); err != nil {
+		buildErr = fmt.Errorf("plugin directory does not contain go.mod: %w", err)
+		return "", buildErr
+	}
+
+	// Add replace directive for soulsolid module
+	cmd = exec.Command("go", "mod", "edit", "-replace=github.com/contre95/soulsolid="+moduleRoot)
+	cmd.Dir = pluginDir
+	if output, err := cmd.CombinedOutput(); err != nil {
+		buildErr = fmt.Errorf("failed to add replace directive: %w: %s", err, output)
+		return "", buildErr
+	}
+
+	// Run go mod tidy
+	cmd = exec.Command("go", "mod", "tidy")
+	cmd.Dir = pluginDir
+	if output, err := cmd.CombinedOutput(); err != nil {
+		buildErr = fmt.Errorf("failed to run go mod tidy: %w: %s", err, output)
+		return "", buildErr
+	}
+
+	// Build the plugin
+	outputFile := filepath.Join(tempDir, "plugin.so")
+	cmd = exec.Command("go", "build", "-buildmode=plugin", "-o", outputFile, ".")
+	cmd.Dir = pluginDir
+	if output, err := cmd.CombinedOutput(); err != nil {
+		buildErr = fmt.Errorf("failed to build plugin: %w: %s", err, output)
+		return "", buildErr
+	}
+
+	slog.Debug("Successfully built plugin from git", "url", url, "output", outputFile)
+
+	// Move .so file to a new temporary file (outside the source directory)
+	// so we can clean up the source directory
+	pluginSo, err := os.CreateTemp("", "*.so")
+	if err != nil {
+		buildErr = fmt.Errorf("failed to create temp .so file: %w", err)
+		return "", buildErr
+	}
+	pluginSo.Close()
+
+	if err := os.Rename(outputFile, pluginSo.Name()); err != nil {
+		// If rename fails (cross-device), copy instead
+		src, err := os.Open(outputFile)
+		if err != nil {
+			buildErr = fmt.Errorf("failed to open built plugin: %w", err)
+			return "", buildErr
+		}
+		defer src.Close()
+
+		dst, err := os.Create(pluginSo.Name())
+		if err != nil {
+			buildErr = fmt.Errorf("failed to create destination .so file: %w", err)
+			return "", buildErr
+		}
+		defer dst.Close()
+
+		if _, err := io.Copy(dst, src); err != nil {
+			buildErr = fmt.Errorf("failed to copy built plugin: %w", err)
+			return "", buildErr
+		}
+	}
+
+	// Clean up source directory
+	os.RemoveAll(tempDir)
+
+	return pluginSo.Name(), nil
+}
+
 // NewPluginManager creates a new plugin manager
 func NewPluginManager() *PluginManager {
 	return &PluginManager{
@@ -49,12 +187,24 @@ func (pm *PluginManager) LoadPlugins(cfg *config.Config) error {
 
 // loadPlugin loads a single plugin
 func (pm *PluginManager) loadPlugin(pluginCfg config.PluginConfig) error {
-	slog.Debug("Loading plugin", "name", pluginCfg.Name, "path", pluginCfg.Path)
+	slog.Debug("Loading plugin", "name", pluginCfg.Name, "path", pluginCfg.Path, "url", pluginCfg.URL)
 
 	pluginPath := pluginCfg.Path
+	isTempFile := false
+	var tempFilePath string
 
-	// If path is a URL, download the plugin to a temporary file
-	if strings.HasPrefix(pluginCfg.Path, "http://") || strings.HasPrefix(pluginCfg.Path, "https://") {
+	// If URL is specified, build plugin from git repository
+	if pluginCfg.URL != "" {
+		slog.Info("Building plugin from git repository", "name", pluginCfg.Name, "url", pluginCfg.URL)
+		builtPath, err := buildFromGit(pluginCfg.URL)
+		if err != nil {
+			return fmt.Errorf("failed to build plugin %s from git: %w", pluginCfg.Name, err)
+		}
+		pluginPath = builtPath
+		isTempFile = true
+		tempFilePath = builtPath
+	} else if strings.HasPrefix(pluginCfg.Path, "http://") || strings.HasPrefix(pluginCfg.Path, "https://") {
+		// If path is a URL, download the plugin to a temporary file
 		tempFile, err := os.CreateTemp("", "*.so")
 		if err != nil {
 			return fmt.Errorf("failed to create temp file for plugin %s: %w", pluginCfg.Name, err)
@@ -81,28 +231,43 @@ func (pm *PluginManager) loadPlugin(pluginCfg config.PluginConfig) error {
 
 		tempFile.Close() // close before opening as plugin
 		pluginPath = tempFile.Name()
+		isTempFile = true
+		tempFilePath = tempFile.Name()
 	}
 
 	p, err := plugin.Open(pluginPath)
 	if err != nil {
-		if strings.HasPrefix(pluginCfg.Path, "http://") || strings.HasPrefix(pluginCfg.Path, "https://") {
-			os.Remove(pluginPath) // cleanup temp file on error
+		// Clean up temporary files if we created them
+		if isTempFile {
+			os.Remove(tempFilePath)
 		}
 		return fmt.Errorf("failed to open plugin %s: %w", pluginCfg.Path, err)
 	}
 
 	sym, err := p.Lookup("NewDownloader")
 	if err != nil {
+		// Clean up temporary files if we created them
+		if isTempFile {
+			os.Remove(tempFilePath)
+		}
 		return fmt.Errorf("plugin %s does not export NewDownloader function: %w", pluginCfg.Name, err)
 	}
 
 	newDownloaderFunc, ok := sym.(func(map[string]interface{}) (Downloader, error))
 	if !ok {
+		// Clean up temporary files if we created them
+		if isTempFile {
+			os.Remove(tempFilePath)
+		}
 		return fmt.Errorf("plugin %s NewDownloader function has incorrect signature", pluginCfg.Name)
 	}
 
 	downloader, err := newDownloaderFunc(pluginCfg.Config)
 	if err != nil {
+		// Clean up temporary files if we created them
+		if isTempFile {
+			os.Remove(tempFilePath)
+		}
 		return fmt.Errorf("failed to create downloader from plugin %s: %w", pluginCfg.Name, err)
 	}