Compare commits
29 Commits
owlry-core
...
owlry-core
| Author | SHA1 | Date | |
|---|---|---|---|
| 33b4f410e5 | |||
| a7683f16bf | |||
| 178f81082a | |||
| 7863de9971 | |||
| dacc194d02 | |||
| 5871609c73 | |||
| e3c4988e01 | |||
| 46b5d8518f | |||
| 95a698225c | |||
| 709e1b04cb | |||
| 827bf383ea | |||
| b706347ec9 | |||
| 32b4b144f4 | |||
| 5615002062 | |||
| 0a3af9fa56 | |||
| c93b11e899 | |||
| bd69f8eafe | |||
| edfb079bb1 | |||
| 3de382cd73 | |||
| 82f35e5a54 | |||
| a920588df9 | |||
| c32b6c5456 | |||
| 2a5f184230 | |||
| b2f068269a | |||
| e210a604f7 | |||
| 1adec7bf47 | |||
| 7f07a93dec | |||
| 7351ba868e | |||
| 44e1430ea5 |
877
Cargo.lock
generated
877
Cargo.lock
generated
File diff suppressed because it is too large
Load Diff
125
README.md
125
README.md
@@ -11,17 +11,18 @@ A lightweight, owl-themed application launcher for Wayland, built with GTK4 and
|
||||
## Features
|
||||
|
||||
- **Client/daemon architecture** — Instant window appearance, providers stay loaded in memory
|
||||
- **Modular plugin architecture** — Install only what you need
|
||||
- **Fuzzy search with tags** — Fast matching across names, descriptions, and category tags
|
||||
- **Built-in calculator, converter, and system actions** — Works out of the box
|
||||
- **11 optional plugins** — Clipboard, emoji, weather, media, and more
|
||||
- **Built-in providers** — Calculator, unit/currency converter, and system actions out of the box
|
||||
- **Built-in settings editor** — Configure everything from within the launcher (`:config`)
|
||||
- **11 optional plugins** — Clipboard, emoji, weather, media, bookmarks, and more
|
||||
- **Widget providers** — Weather, media controls, and pomodoro timer at the top of results
|
||||
- **Fuzzy search with tags** — Fast matching across names, descriptions, and category tags
|
||||
- **Config profiles** — Named mode presets for different workflows
|
||||
- **Filter prefixes** — Scope searches with `:app`, `:cmd`, `:tag:development`, etc.
|
||||
- **Filter prefixes** — Scope searches with `:app`, `:cmd`, `:config`, `:tag:X`, etc.
|
||||
- **Frecency ranking** — Frequently/recently used items rank higher
|
||||
- **Toggle behavior** — Bind one key to open/close the launcher
|
||||
- **GTK4 theming** — System theme by default, with 9 built-in themes
|
||||
- **GTK4 theming** — System theme by default, with 10 built-in themes
|
||||
- **Wayland native** — Uses Layer Shell for proper overlay behavior
|
||||
- **dmenu compatible** — Pipe-based selection mode, no daemon required
|
||||
- **Extensible** — Create custom plugins in Lua or Rune
|
||||
|
||||
## Installation
|
||||
@@ -29,13 +30,13 @@ A lightweight, owl-themed application launcher for Wayland, built with GTK4 and
|
||||
### Arch Linux (AUR)
|
||||
|
||||
```bash
|
||||
# Core (includes calculator, converter, system actions)
|
||||
# Core (includes calculator, converter, system actions, settings editor)
|
||||
yay -S owlry
|
||||
|
||||
# Add individual plugins as needed
|
||||
yay -S owlry-plugin-bookmarks owlry-plugin-weather owlry-plugin-clipboard
|
||||
|
||||
# For custom Lua/Rune plugins
|
||||
# For custom Lua/Rune user plugins
|
||||
yay -S owlry-lua # Lua 5.4 runtime
|
||||
yay -S owlry-rune # Rune runtime
|
||||
```
|
||||
@@ -47,7 +48,7 @@ yay -S owlry-rune # Rune runtime
|
||||
| Package | Description |
|
||||
|---------|-------------|
|
||||
| `owlry` | GTK4 UI client |
|
||||
| `owlry-core` | Headless daemon with built-in calculator, converter, and system providers |
|
||||
| `owlry-core` | Daemon (`owlryd`) with built-in calculator, converter, system, and settings providers |
|
||||
| `owlry-lua` | Lua 5.4 script runtime for user plugins |
|
||||
| `owlry-rune` | Rune script runtime for user plugins |
|
||||
|
||||
@@ -67,7 +68,7 @@ yay -S owlry-rune # Rune runtime
|
||||
| `owlry-plugin-weather` | Weather widget |
|
||||
| `owlry-plugin-websearch` | Web search (`? query`) |
|
||||
|
||||
> **Note:** Calculator, converter, and system actions are built into `owlry-core` and no longer require separate plugin packages.
|
||||
> **Note:** Calculator, converter, and system actions are built into `owlry-core` and do not require separate packages.
|
||||
|
||||
### Build from Source
|
||||
|
||||
@@ -102,7 +103,7 @@ cargo build --release --workspace
|
||||
```bash
|
||||
git clone https://somegit.dev/Owlibou/owlry-plugins.git
|
||||
cd owlry-plugins
|
||||
cargo build --release -p owlry-plugin-calculator # or any plugin
|
||||
cargo build --release -p owlry-plugin-bookmarks # or any plugin
|
||||
```
|
||||
|
||||
**Install locally:**
|
||||
@@ -110,11 +111,11 @@ cargo build --release -p owlry-plugin-calculator # or any plugin
|
||||
just install-local
|
||||
```
|
||||
|
||||
This installs the UI, daemon, runtimes, and systemd service files.
|
||||
This installs the UI (`owlry`), daemon (`owlryd`), runtimes, and systemd service files.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Owlry uses a client/daemon architecture. The daemon (`owlry-core`) loads providers and plugins into memory. The UI client (`owlry`) connects to the daemon over a Unix socket for instant results.
|
||||
Owlry uses a client/daemon architecture. The daemon (`owlryd`) loads providers and plugins into memory. The UI client (`owlry`) connects to the daemon over a Unix socket for instant results.
|
||||
|
||||
### Starting the Daemon
|
||||
|
||||
@@ -144,7 +145,7 @@ systemctl --user enable --now owlryd.service
|
||||
systemctl --user enable owlryd.socket
|
||||
```
|
||||
|
||||
The daemon starts automatically when the UI client first connects. No manual startup needed.
|
||||
The daemon starts automatically when the UI client first connects.
|
||||
|
||||
### Launching the UI
|
||||
|
||||
@@ -158,7 +159,7 @@ bind = SUPER, Space, exec, owlry
|
||||
bindsym $mod+space exec owlry
|
||||
```
|
||||
|
||||
Running `owlry` a second time while it is already open sends a toggle command — the window closes. This means a single keybind acts as open/close.
|
||||
Running `owlry` a second time while it is already open sends a toggle command — the window closes. A single keybind acts as open/close.
|
||||
|
||||
If the daemon is not running when the UI launches, it will attempt to start it via systemd automatically.
|
||||
|
||||
@@ -168,7 +169,7 @@ If the daemon is not running when the UI launches, it will attempt to start it v
|
||||
owlry # Launch with all providers
|
||||
owlry -m app # Applications only
|
||||
owlry -m cmd # PATH commands only
|
||||
owlry -m calc # Calculator plugin only (if installed)
|
||||
owlry -m calc # Calculator only
|
||||
owlry --profile dev # Use a named profile from config
|
||||
owlry --help # Show all options with examples
|
||||
```
|
||||
@@ -203,14 +204,16 @@ bind = SUPER, D, exec, owlry --profile dev
|
||||
bind = SUPER, M, exec, owlry --profile media
|
||||
```
|
||||
|
||||
Profiles can also be managed from the launcher itself — see [Settings Editor](#settings-editor).
|
||||
|
||||
### dmenu Mode
|
||||
|
||||
Owlry is dmenu-compatible. Pipe input for interactive selection — the selected item is printed to stdout (not executed), so you pipe the output to execute it.
|
||||
|
||||
dmenu mode is self-contained: it does not use the daemon and works without `owlry-core` running.
|
||||
dmenu mode is self-contained: it does not use the daemon and works without `owlryd` running.
|
||||
|
||||
```bash
|
||||
# Screenshot menu (execute selected command)
|
||||
# Screenshot menu
|
||||
printf '%s\n' \
|
||||
"grimblast --notify copy screen" \
|
||||
"grimblast --notify copy area" \
|
||||
@@ -229,9 +232,6 @@ find ~/projects -maxdepth 1 -type d | owlry -m dmenu | xargs code
|
||||
|
||||
# Package manager search
|
||||
pacman -Ssq | owlry -m dmenu -p "install" | xargs sudo pacman -S
|
||||
|
||||
# Open selected file
|
||||
ls ~/Documents | owlry -m dmenu | xargs xdg-open
|
||||
```
|
||||
|
||||
The `-p` / `--prompt` flag sets a custom label for the search input.
|
||||
@@ -254,7 +254,7 @@ Type `:config` to browse and modify settings without editing files:
|
||||
| Command | What it does |
|
||||
|---------|-------------|
|
||||
| `:config` | Show all setting categories |
|
||||
| `:config providers` | Toggle providers on/off |
|
||||
| `:config providers` | Toggle built-in providers on/off (calculator, converter, system, frecency) |
|
||||
| `:config theme` | Select color theme |
|
||||
| `:config engine` | Select web search engine |
|
||||
| `:config frecency` | Toggle frecency, set weight |
|
||||
@@ -265,6 +265,8 @@ Type `:config` to browse and modify settings without editing files:
|
||||
|
||||
Changes are saved to `config.toml` immediately. Some settings (theme, frecency) take effect on the next search. Others (font size, dimensions) require a restart.
|
||||
|
||||
> **Note:** `:config providers` only covers built-in providers. To enable or disable plugins, use `owlry plugin enable/disable <name>` or set `disabled_plugins` in `[plugins]`.
|
||||
|
||||
### Search Prefixes
|
||||
|
||||
| Prefix | Provider | Example |
|
||||
@@ -281,6 +283,7 @@ Changes are saved to `config.toml` immediately. Some settings (theme, frecency)
|
||||
| `:calc` | Calculator | `:calc sqrt(16)` |
|
||||
| `:web` | Web search | `:web rust docs` |
|
||||
| `:uuctl` | systemd | `:uuctl docker` |
|
||||
| `:config` | Settings | `:config theme` |
|
||||
| `:tag:X` | Filter by tag | `:tag:development` |
|
||||
|
||||
### Trigger Prefixes
|
||||
@@ -289,6 +292,7 @@ Changes are saved to `config.toml` immediately. Some settings (theme, frecency)
|
||||
|---------|----------|---------|
|
||||
| `=` | Calculator | `= 5+3` |
|
||||
| `calc ` | Calculator | `calc sqrt(16)` |
|
||||
| `>` | Converter | `> 20 km to mi` |
|
||||
| `?` | Web search | `? rust programming` |
|
||||
| `web ` | Web search | `web linux tips` |
|
||||
| `/` | File search | `/ .bashrc` |
|
||||
@@ -308,6 +312,7 @@ Owlry follows the [XDG Base Directory Specification](https://specifications.free
|
||||
| `~/.local/share/owlry/frecency.json` | Usage history |
|
||||
|
||||
System locations:
|
||||
|
||||
| Path | Purpose |
|
||||
|------|---------|
|
||||
| `/usr/lib/owlry/plugins/*.so` | Installed native plugins |
|
||||
@@ -322,35 +327,61 @@ mkdir -p ~/.config/owlry
|
||||
cp /usr/share/doc/owlry/config.example.toml ~/.config/owlry/config.toml
|
||||
```
|
||||
|
||||
Or configure from within the launcher: type `:config` to interactively change settings.
|
||||
|
||||
### Example Configuration
|
||||
|
||||
```toml
|
||||
[general]
|
||||
show_icons = true
|
||||
max_results = 10
|
||||
tabs = ["app", "cmd", "uuctl"]
|
||||
# terminal_command = "kitty" # Auto-detected
|
||||
# use_uwsm = false # Enable for systemd session integration
|
||||
max_results = 100
|
||||
tabs = ["app", "cmd", "uuctl"] # Provider tabs shown in the header bar
|
||||
# terminal_command = "kitty" # Auto-detected; overrides $TERMINAL and xdg-terminal-exec
|
||||
# use_uwsm = false # Enable for systemd session integration (uwsm app --)
|
||||
|
||||
[appearance]
|
||||
width = 850
|
||||
height = 650
|
||||
font_size = 14
|
||||
border_radius = 12
|
||||
# theme = "owl" # Or: catppuccin-mocha, nord, dracula, etc.
|
||||
# theme = "owl" # Or: catppuccin-mocha, nord, dracula, etc. (see Theming section)
|
||||
|
||||
[plugins]
|
||||
disabled = [] # Plugin IDs to disable, e.g., ["emoji", "pomodoro"]
|
||||
# Optional per-element color overrides — all fields are optional, unset inherits from theme
|
||||
# [appearance.colors]
|
||||
# background = "#1e1e2e"
|
||||
# background_secondary = "#313244"
|
||||
# border = "#45475a"
|
||||
# text = "#cdd6f4"
|
||||
# accent = "#cba6f7"
|
||||
# badge_app = "#a6e3a1" # All badge_* keys: app, cmd, clip, ssh, emoji, file,
|
||||
# badge_web = "#89dceb" # script, sys, uuctl, web, calc, bm, dmenu,
|
||||
# badge_media = "#f38ba8" # media, weather, pomo
|
||||
|
||||
[providers]
|
||||
applications = true # .desktop files
|
||||
commands = true # PATH executables
|
||||
calculator = true # Built-in math expressions (= or calc trigger)
|
||||
converter = true # Built-in unit/currency converter (> trigger)
|
||||
system = true # Built-in shutdown/reboot/lock actions
|
||||
frecency = true # Boost frequently used items
|
||||
frecency_weight = 0.3 # 0.0-1.0
|
||||
frecency_weight = 0.3 # 0.0 = disabled, 1.0 = strong boost
|
||||
|
||||
# Web search engine: google, duckduckgo, bing, startpage, brave, ecosia
|
||||
# Web search engine: google, duckduckgo, bing, startpage, searxng, brave, ecosia
|
||||
# Or a custom URL with a {query} placeholder: "https://example.com/search?q={query}"
|
||||
search_engine = "duckduckgo"
|
||||
|
||||
[plugins]
|
||||
# disabled_plugins = ["emoji", "pomodoro"] # Plugin IDs to disable
|
||||
# enabled_plugins = [] # Empty = all discovered plugins are loaded
|
||||
# registry_url = "https://..." # Custom plugin registry URL
|
||||
|
||||
# Sandboxing for Lua/Rune user plugins (~/.config/owlry/plugins/)
|
||||
# [plugins.sandbox]
|
||||
# allow_filesystem = false # Allow access outside plugin directory
|
||||
# allow_network = false # Allow outbound network requests
|
||||
# allow_commands = false # Allow shell command execution
|
||||
# memory_limit = 67108864 # Lua memory cap in bytes (default: 64 MB)
|
||||
|
||||
# Profiles: named sets of modes
|
||||
[profiles.dev]
|
||||
modes = ["app", "cmd", "ssh"]
|
||||
@@ -363,7 +394,7 @@ See `/usr/share/doc/owlry/config.example.toml` for all options with documentatio
|
||||
|
||||
## Plugin System
|
||||
|
||||
Owlry uses a modular plugin architecture. Plugins are loaded by the daemon (`owlry-core`) from:
|
||||
Owlry uses a modular plugin architecture. Plugins are loaded by the daemon from:
|
||||
|
||||
- `/usr/lib/owlry/plugins/*.so` — System plugins (AUR packages)
|
||||
- `~/.config/owlry/plugins/` — User plugins (requires `owlry-lua` or `owlry-rune`)
|
||||
@@ -374,9 +405,18 @@ Add plugin IDs to the disabled list in your config:
|
||||
|
||||
```toml
|
||||
[plugins]
|
||||
disabled = ["emoji", "pomodoro"]
|
||||
disabled_plugins = ["emoji", "pomodoro"]
|
||||
```
|
||||
|
||||
Or use the CLI:
|
||||
|
||||
```bash
|
||||
owlry plugin disable emoji
|
||||
owlry plugin enable emoji
|
||||
```
|
||||
|
||||
> **Note:** `:config providers` in the launcher only manages built-in providers (calculator, converter, system). Use `disabled_plugins` or `owlry plugin disable` for plugins.
|
||||
|
||||
### Plugin Management CLI
|
||||
|
||||
```bash
|
||||
@@ -432,12 +472,15 @@ See [docs/PLUGIN_DEVELOPMENT.md](docs/PLUGIN_DEVELOPMENT.md) for:
|
||||
| `tokyo-night` | Tokyo city lights |
|
||||
| `solarized-dark` | Precision colors |
|
||||
| `one-dark` | Atom's One Dark |
|
||||
| `apex-neon` | Neon cyberpunk |
|
||||
|
||||
```toml
|
||||
[appearance]
|
||||
theme = "catppuccin-mocha"
|
||||
```
|
||||
|
||||
Or select interactively: type `:config theme` in the launcher.
|
||||
|
||||
### Custom Theme
|
||||
|
||||
Create `~/.config/owlry/themes/mytheme.css`:
|
||||
@@ -465,18 +508,24 @@ Create `~/.config/owlry/themes/mytheme.css`:
|
||||
| `--owlry-text-secondary` | Muted text |
|
||||
| `--owlry-accent` | Accent color |
|
||||
| `--owlry-accent-bright` | Bright accent |
|
||||
| `--owlry-shadow` | Window shadow (default: none) |
|
||||
|
||||
## Architecture
|
||||
|
||||
Owlry uses a client/daemon split:
|
||||
|
||||
```
|
||||
owlry-core (daemon) owlry (GTK4 UI client)
|
||||
owlryd (daemon) owlry (GTK4 UI client)
|
||||
├── Loads config + plugins ├── Connects to daemon via Unix socket
|
||||
├── Applications provider ├── Renders results in GTK4 window
|
||||
├── Commands provider ├── Handles keyboard input
|
||||
├── Plugin loader ├── Toggle: second launch closes window
|
||||
│ ├── /usr/lib/owlry/plugins/*.so └── dmenu mode (self-contained, no daemon)
|
||||
├── Built-in providers ├── Renders results in GTK4 window
|
||||
│ ├── Applications (.desktop) ├── Handles keyboard input
|
||||
│ ├── Commands (PATH) ├── Toggle: second launch closes window
|
||||
│ ├── Calculator (math) └── dmenu mode (self-contained, no daemon)
|
||||
│ ├── Converter (units/currency)
|
||||
│ ├── System (power/session)
|
||||
│ └── Config editor (settings)
|
||||
├── Plugin loader
|
||||
│ ├── /usr/lib/owlry/plugins/*.so
|
||||
│ ├── /usr/lib/owlry/runtimes/
|
||||
│ └── ~/.config/owlry/plugins/
|
||||
├── Frecency tracking
|
||||
|
||||
@@ -1,13 +1,14 @@
|
||||
pkgbase = owlry-core
|
||||
pkgdesc = Core daemon for the Owlry application launcher — manages plugins, providers, and search
|
||||
pkgver = 1.2.1
|
||||
pkgver = 1.3.2
|
||||
pkgrel = 1
|
||||
url = https://somegit.dev/Owlibou/owlry
|
||||
arch = x86_64
|
||||
license = GPL-3.0-or-later
|
||||
makedepends = cargo
|
||||
depends = gcc-libs
|
||||
source = owlry-core-1.2.1.tar.gz::https://somegit.dev/Owlibou/owlry/archive/owlry-core-v1.2.1.tar.gz
|
||||
b2sums = 8967562bda33820b282350eaad17e8194699926b721eabe978fb0b70af2a75e399866c6bfa7abb449141701bad618df56079c7e81358708b1852b1070b0b7c05
|
||||
depends = openssl
|
||||
source = owlry-core-1.3.2.tar.gz::https://somegit.dev/Owlibou/owlry/archive/owlry-core-v1.3.2.tar.gz
|
||||
b2sums = 36a1e31cadcfdbe70c0a10c13eddbcea7ae21b7dcfb0aa10a75f44a82a377d6598c4237228457c13260ca4b4b88f12d416541ad7698cf28076124b1a4d3dbbc6
|
||||
|
||||
pkgname = owlry-core
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
# Maintainer: vikingowl <christian@nachtigall.dev>
|
||||
pkgname=owlry-core
|
||||
pkgver=1.2.1
|
||||
pkgver=1.3.2
|
||||
pkgrel=1
|
||||
pkgdesc='Core daemon for the Owlry application launcher — manages plugins, providers, and search'
|
||||
arch=('x86_64')
|
||||
url='https://somegit.dev/Owlibou/owlry'
|
||||
license=('GPL-3.0-or-later')
|
||||
depends=('gcc-libs')
|
||||
depends=('gcc-libs' 'openssl')
|
||||
makedepends=('cargo')
|
||||
source=("$pkgname-$pkgver.tar.gz::https://somegit.dev/Owlibou/owlry/archive/owlry-core-v$pkgver.tar.gz")
|
||||
b2sums=('8967562bda33820b282350eaad17e8194699926b721eabe978fb0b70af2a75e399866c6bfa7abb449141701bad618df56079c7e81358708b1852b1070b0b7c05')
|
||||
b2sums=('36a1e31cadcfdbe70c0a10c13eddbcea7ae21b7dcfb0aa10a75f44a82a377d6598c4237228457c13260ca4b4b88f12d416541ad7698cf28076124b1a4d3dbbc6')
|
||||
|
||||
prepare() {
|
||||
cd "owlry"
|
||||
|
||||
@@ -1,13 +1,14 @@
|
||||
pkgbase = owlry-lua
|
||||
pkgdesc = Lua scripting runtime for Owlry — enables user-created Lua plugins
|
||||
pkgver = 1.1.0
|
||||
pkgver = 1.1.2
|
||||
pkgrel = 1
|
||||
url = https://somegit.dev/Owlibou/owlry
|
||||
arch = x86_64
|
||||
license = GPL-3.0-or-later
|
||||
makedepends = cargo
|
||||
depends = owlry-core
|
||||
source = owlry-lua-1.1.0.tar.gz::https://somegit.dev/Owlibou/owlry/archive/owlry-lua-v1.1.0.tar.gz
|
||||
b2sums = d4b200446a31301b1240fd8eede6e10764d7bbc551f2e5549bfdbdcc0fa4a717677c3c2c69778d2dfa336711ac5b74d4987e46082ea589fed961c9d2ff95af76
|
||||
depends = openssl
|
||||
source = owlry-lua-1.1.2.tar.gz::https://somegit.dev/Owlibou/owlry/archive/owlry-lua-v1.1.2.tar.gz
|
||||
b2sums = 42e6221e6e07c629ece1493e7f5feb1b2cb2e77632d1d7779dfbe544bd89a17d77d1839d63e50d71d4f0e0322ca8a1cc39b872101039019bdf08d9bcaeda7603
|
||||
|
||||
pkgname = owlry-lua
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
# Maintainer: vikingowl <christian@nachtigall.dev>
|
||||
pkgname=owlry-lua
|
||||
pkgver=1.1.0
|
||||
pkgver=1.1.2
|
||||
pkgrel=1
|
||||
pkgdesc="Lua scripting runtime for Owlry — enables user-created Lua plugins"
|
||||
arch=('x86_64')
|
||||
url="https://somegit.dev/Owlibou/owlry"
|
||||
license=('GPL-3.0-or-later')
|
||||
depends=('owlry-core')
|
||||
depends=('owlry-core' 'openssl')
|
||||
makedepends=('cargo')
|
||||
source=("$pkgname-$pkgver.tar.gz::https://somegit.dev/Owlibou/owlry/archive/owlry-lua-v$pkgver.tar.gz")
|
||||
b2sums=('d4b200446a31301b1240fd8eede6e10764d7bbc551f2e5549bfdbdcc0fa4a717677c3c2c69778d2dfa336711ac5b74d4987e46082ea589fed961c9d2ff95af76')
|
||||
b2sums=('42e6221e6e07c629ece1493e7f5feb1b2cb2e77632d1d7779dfbe544bd89a17d77d1839d63e50d71d4f0e0322ca8a1cc39b872101039019bdf08d9bcaeda7603')
|
||||
|
||||
_cratename=owlry-lua
|
||||
|
||||
@@ -30,7 +30,7 @@ check() {
|
||||
cd "owlry"
|
||||
export RUSTUP_TOOLCHAIN=stable
|
||||
export CARGO_TARGET_DIR=target
|
||||
cargo test -p $_cratename --frozen --release
|
||||
cargo test -p $_cratename --frozen --lib
|
||||
}
|
||||
|
||||
package() {
|
||||
|
||||
1
aur/owlry-meta-essentials
Submodule
1
aur/owlry-meta-essentials
Submodule
Submodule aur/owlry-meta-essentials added at 4a09cfb73c
1
aur/owlry-meta-full
Submodule
1
aur/owlry-meta-full
Submodule
Submodule aur/owlry-meta-full added at 8f85087731
1
aur/owlry-meta-tools
Submodule
1
aur/owlry-meta-tools
Submodule
Submodule aur/owlry-meta-tools added at 28c78b7953
1
aur/owlry-meta-widgets
Submodule
1
aur/owlry-meta-widgets
Submodule
Submodule aur/owlry-meta-widgets added at aa4c2cd217
@@ -1,13 +1,14 @@
|
||||
pkgbase = owlry-rune
|
||||
pkgdesc = Rune scripting runtime for Owlry — enables user-created Rune plugins
|
||||
pkgver = 1.1.0
|
||||
pkgver = 1.1.3
|
||||
pkgrel = 1
|
||||
url = https://somegit.dev/Owlibou/owlry
|
||||
arch = x86_64
|
||||
license = GPL-3.0-or-later
|
||||
makedepends = cargo
|
||||
depends = owlry-core
|
||||
source = owlry-rune-1.1.0.tar.gz::https://somegit.dev/Owlibou/owlry/archive/owlry-rune-v1.1.0.tar.gz
|
||||
b2sums = d4b200446a31301b1240fd8eede6e10764d7bbc551f2e5549bfdbdcc0fa4a717677c3c2c69778d2dfa336711ac5b74d4987e46082ea589fed961c9d2ff95af76
|
||||
depends = openssl
|
||||
source = owlry-rune-1.1.3.tar.gz::https://somegit.dev/Owlibou/owlry/archive/owlry-rune-v1.1.3.tar.gz
|
||||
b2sums = 3dd1db5783b0e0c814f8e6064fd5d8cb736da5bd4759d648f48ea69a476451f64d27ecd0894378f3e41e7cc85557b7d9dcb0adf80114c32e561d4688aae6bb53
|
||||
|
||||
pkgname = owlry-rune
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
# Maintainer: vikingowl <christian@nachtigall.dev>
|
||||
pkgname=owlry-rune
|
||||
pkgver=1.1.0
|
||||
pkgver=1.1.3
|
||||
pkgrel=1
|
||||
pkgdesc="Rune scripting runtime for Owlry — enables user-created Rune plugins"
|
||||
arch=('x86_64')
|
||||
url="https://somegit.dev/Owlibou/owlry"
|
||||
license=('GPL-3.0-or-later')
|
||||
depends=('owlry-core')
|
||||
depends=('owlry-core' 'openssl')
|
||||
makedepends=('cargo')
|
||||
source=("$pkgname-$pkgver.tar.gz::https://somegit.dev/Owlibou/owlry/archive/owlry-rune-v$pkgver.tar.gz")
|
||||
b2sums=('d4b200446a31301b1240fd8eede6e10764d7bbc551f2e5549bfdbdcc0fa4a717677c3c2c69778d2dfa336711ac5b74d4987e46082ea589fed961c9d2ff95af76')
|
||||
b2sums=('3dd1db5783b0e0c814f8e6064fd5d8cb736da5bd4759d648f48ea69a476451f64d27ecd0894378f3e41e7cc85557b7d9dcb0adf80114c32e561d4688aae6bb53')
|
||||
|
||||
_cratename=owlry-rune
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "owlry-core"
|
||||
version = "1.3.0"
|
||||
version = "1.3.3"
|
||||
edition.workspace = true
|
||||
rust-version.workspace = true
|
||||
license.workspace = true
|
||||
@@ -30,6 +30,7 @@ semver = "1"
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
serde_json = "1"
|
||||
toml = "0.8"
|
||||
toml_edit = "0.22"
|
||||
chrono = { version = "0.4", features = ["serde"] }
|
||||
dirs = "5"
|
||||
|
||||
@@ -50,7 +51,7 @@ notify-rust = "4"
|
||||
|
||||
# Built-in providers
|
||||
meval = "0.2"
|
||||
reqwest = { version = "0.13", default-features = false, features = ["rustls", "json", "blocking"] }
|
||||
reqwest = { version = "0.13", default-features = false, features = ["native-tls", "json", "blocking"] }
|
||||
|
||||
# Optional: embedded Lua runtime
|
||||
mlua = { version = "0.11", features = ["lua54", "vendored", "send", "serialize"], optional = true }
|
||||
|
||||
@@ -2,6 +2,7 @@ use log::{debug, info, warn};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use std::collections::HashMap;
|
||||
use std::path::PathBuf;
|
||||
use toml_edit::{DocumentMut, Item};
|
||||
|
||||
use crate::paths;
|
||||
|
||||
@@ -157,82 +158,26 @@ pub struct ProvidersConfig {
|
||||
pub applications: bool,
|
||||
#[serde(default = "default_true")]
|
||||
pub commands: bool,
|
||||
#[serde(default = "default_true")]
|
||||
pub uuctl: bool,
|
||||
/// Enable calculator provider (= expression or calc expression)
|
||||
/// Enable built-in calculator provider (= or calc trigger)
|
||||
#[serde(default = "default_true")]
|
||||
pub calculator: bool,
|
||||
/// Enable converter provider (> expression or auto-detect)
|
||||
/// Enable built-in unit/currency converter (> trigger)
|
||||
#[serde(default = "default_true")]
|
||||
pub converter: bool,
|
||||
/// Enable built-in system actions (shutdown, reboot, lock, etc.)
|
||||
#[serde(default = "default_true")]
|
||||
pub system: bool,
|
||||
/// Enable frecency-based result ranking
|
||||
#[serde(default = "default_true")]
|
||||
pub frecency: bool,
|
||||
/// Weight for frecency boost (0.0 = disabled, 1.0 = strong boost)
|
||||
#[serde(default = "default_frecency_weight")]
|
||||
pub frecency_weight: f64,
|
||||
/// Enable web search provider (? query or web query)
|
||||
#[serde(default = "default_true")]
|
||||
pub websearch: bool,
|
||||
/// Search engine for web search
|
||||
/// Search engine for web search (used by owlry-plugin-websearch)
|
||||
/// Options: google, duckduckgo, bing, startpage, searxng, brave, ecosia
|
||||
/// Or custom URL with {query} placeholder
|
||||
/// Or a custom URL with a {query} placeholder
|
||||
#[serde(default = "default_search_engine")]
|
||||
pub search_engine: String,
|
||||
/// Enable system commands (shutdown, reboot, etc.)
|
||||
#[serde(default = "default_true")]
|
||||
pub system: bool,
|
||||
/// Enable SSH connections from ~/.ssh/config
|
||||
#[serde(default = "default_true")]
|
||||
pub ssh: bool,
|
||||
/// Enable clipboard history (requires cliphist)
|
||||
#[serde(default = "default_true")]
|
||||
pub clipboard: bool,
|
||||
/// Enable browser bookmarks
|
||||
#[serde(default = "default_true")]
|
||||
pub bookmarks: bool,
|
||||
/// Enable emoji picker
|
||||
#[serde(default = "default_true")]
|
||||
pub emoji: bool,
|
||||
/// Enable custom scripts from ~/.config/owlry/scripts/
|
||||
#[serde(default = "default_true")]
|
||||
pub scripts: bool,
|
||||
/// Enable file search (requires fd or locate)
|
||||
#[serde(default = "default_true")]
|
||||
pub files: bool,
|
||||
|
||||
// ─── Widget Providers ───────────────────────────────────────────────
|
||||
/// Enable MPRIS media player widget
|
||||
#[serde(default = "default_true")]
|
||||
pub media: bool,
|
||||
|
||||
/// Enable weather widget
|
||||
#[serde(default)]
|
||||
pub weather: bool,
|
||||
|
||||
/// Weather provider: wttr.in (default), openweathermap, open-meteo
|
||||
#[serde(default = "default_weather_provider")]
|
||||
pub weather_provider: String,
|
||||
|
||||
/// API key for weather services that require it (e.g., OpenWeatherMap)
|
||||
#[serde(default)]
|
||||
pub weather_api_key: Option<String>,
|
||||
|
||||
/// Location for weather (city name or coordinates)
|
||||
#[serde(default)]
|
||||
pub weather_location: Option<String>,
|
||||
|
||||
/// Enable pomodoro timer widget
|
||||
#[serde(default)]
|
||||
pub pomodoro: bool,
|
||||
|
||||
/// Pomodoro work duration in minutes
|
||||
#[serde(default = "default_pomodoro_work")]
|
||||
pub pomodoro_work_mins: u32,
|
||||
|
||||
/// Pomodoro break duration in minutes
|
||||
#[serde(default = "default_pomodoro_break")]
|
||||
pub pomodoro_break_mins: u32,
|
||||
}
|
||||
|
||||
impl Default for ProvidersConfig {
|
||||
@@ -240,28 +185,12 @@ impl Default for ProvidersConfig {
|
||||
Self {
|
||||
applications: true,
|
||||
commands: true,
|
||||
uuctl: true,
|
||||
calculator: true,
|
||||
converter: true,
|
||||
system: true,
|
||||
frecency: true,
|
||||
frecency_weight: 0.3,
|
||||
websearch: true,
|
||||
search_engine: "duckduckgo".to_string(),
|
||||
system: true,
|
||||
ssh: true,
|
||||
clipboard: true,
|
||||
bookmarks: true,
|
||||
emoji: true,
|
||||
scripts: true,
|
||||
files: true,
|
||||
media: true,
|
||||
weather: false,
|
||||
weather_provider: "wttr.in".to_string(),
|
||||
weather_api_key: None,
|
||||
weather_location: Some("Berlin".to_string()),
|
||||
pomodoro: false,
|
||||
pomodoro_work_mins: 25,
|
||||
pomodoro_break_mins: 5,
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -399,18 +328,6 @@ fn default_frecency_weight() -> f64 {
|
||||
0.3
|
||||
}
|
||||
|
||||
fn default_weather_provider() -> String {
|
||||
"wttr.in".to_string()
|
||||
}
|
||||
|
||||
fn default_pomodoro_work() -> u32 {
|
||||
25
|
||||
}
|
||||
|
||||
fn default_pomodoro_break() -> u32 {
|
||||
5
|
||||
}
|
||||
|
||||
/// Detect the best available terminal emulator
|
||||
/// Fallback chain:
|
||||
/// 1. $TERMINAL env var (user's explicit preference)
|
||||
@@ -539,6 +456,38 @@ fn command_exists(cmd: &str) -> bool {
|
||||
|
||||
// Note: Config derives Default via #[derive(Default)] - all sub-structs have impl Default
|
||||
|
||||
/// Merge `new` into `existing`, updating values while preserving comments and unknown keys.
|
||||
///
|
||||
/// Tables are recursed into so that section-level comments survive. For leaf values
|
||||
/// (scalars, arrays) the item is replaced but the surrounding table structure — and
|
||||
/// any keys in `existing` that are absent from `new` — are left untouched.
|
||||
fn merge_toml_doc(existing: &mut DocumentMut, new: &DocumentMut) {
|
||||
for (key, new_item) in new.iter() {
|
||||
match existing.get_mut(key) {
|
||||
Some(existing_item) => merge_item(existing_item, new_item),
|
||||
None => {
|
||||
existing.insert(key, new_item.clone());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn merge_item(existing: &mut Item, new: &Item) {
|
||||
match (existing.as_table_mut(), new.as_table()) {
|
||||
(Some(e), Some(n)) => {
|
||||
for (key, new_child) in n.iter() {
|
||||
match e.get_mut(key) {
|
||||
Some(existing_child) => merge_item(existing_child, new_child),
|
||||
None => {
|
||||
e.insert(key, new_child.clone());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
_ => *existing = new.clone(),
|
||||
}
|
||||
}
|
||||
|
||||
impl Config {
|
||||
pub fn config_path() -> Option<PathBuf> {
|
||||
paths::config_file()
|
||||
@@ -585,13 +534,34 @@ impl Config {
|
||||
Ok(config)
|
||||
}
|
||||
|
||||
#[allow(dead_code)]
|
||||
pub fn save(&self) -> Result<(), Box<dyn std::error::Error>> {
|
||||
let path = Self::config_path().ok_or("Could not determine config path")?;
|
||||
|
||||
paths::ensure_parent_dir(&path)?;
|
||||
|
||||
let content = toml::to_string_pretty(self)?;
|
||||
let new_content = toml::to_string_pretty(self)?;
|
||||
|
||||
// If a config file already exists, merge into it to preserve comments and
|
||||
// any keys the user has added that are not part of the Config struct.
|
||||
let content = if path.exists() {
|
||||
let existing = std::fs::read_to_string(&path)?;
|
||||
match existing.parse::<toml_edit::DocumentMut>() {
|
||||
Ok(mut doc) => {
|
||||
if let Ok(new_doc) = new_content.parse::<toml_edit::DocumentMut>() {
|
||||
merge_toml_doc(&mut doc, &new_doc);
|
||||
}
|
||||
doc.to_string()
|
||||
}
|
||||
Err(_) => {
|
||||
// Existing file is malformed — fall back to full rewrite.
|
||||
warn!("Existing config is malformed; overwriting with current settings");
|
||||
new_content
|
||||
}
|
||||
}
|
||||
} else {
|
||||
new_content
|
||||
};
|
||||
|
||||
std::fs::write(&path, content)?;
|
||||
info!("Saved config to {:?}", path);
|
||||
Ok(())
|
||||
|
||||
@@ -115,11 +115,6 @@ impl FrecencyStore {
|
||||
"Recorded launch for '{}': count={}, last={}",
|
||||
item_id, entry.launch_count, entry.last_launch
|
||||
);
|
||||
|
||||
// Auto-save after recording
|
||||
if let Err(e) = self.save() {
|
||||
warn!("Failed to save frecency data: {}", e);
|
||||
}
|
||||
}
|
||||
|
||||
/// Calculate frecency score for an item
|
||||
@@ -255,4 +250,18 @@ mod tests {
|
||||
assert!(score_many > score_few);
|
||||
assert!((score_many / score_few - 10.0).abs() < 0.1); // Should be ~10x
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn record_launch_sets_dirty_without_saving() {
|
||||
let mut store = FrecencyStore {
|
||||
data: FrecencyData::default(),
|
||||
path: PathBuf::from("/dev/null"),
|
||||
dirty: false,
|
||||
};
|
||||
|
||||
store.record_launch("test-item");
|
||||
|
||||
assert!(store.dirty, "record_launch should set dirty flag");
|
||||
assert_eq!(store.data.entries["test-item"].launch_count, 1);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -26,11 +26,17 @@ pub struct ParsedQuery {
|
||||
}
|
||||
|
||||
impl ProviderFilter {
|
||||
/// Create filter from CLI args and config
|
||||
/// Create filter from CLI args and config.
|
||||
///
|
||||
/// `tabs` is `general.tabs` from config and drives which provider tabs are
|
||||
/// shown in the UI when no explicit CLI mode is active. It has no effect on
|
||||
/// query routing: when no CLI mode is set, `accept_all=true` causes
|
||||
/// `is_active()` to return `true` for every provider regardless.
|
||||
pub fn new(
|
||||
cli_mode: Option<ProviderType>,
|
||||
cli_providers: Option<Vec<ProviderType>>,
|
||||
config_providers: &ProvidersConfig,
|
||||
tabs: &[String],
|
||||
) -> Self {
|
||||
let accept_all = cli_mode.is_none() && cli_providers.is_none();
|
||||
|
||||
@@ -41,50 +47,23 @@ impl ProviderFilter {
|
||||
// --providers overrides config
|
||||
providers.into_iter().collect()
|
||||
} else {
|
||||
// Use config file settings, default to apps only
|
||||
let mut set = HashSet::new();
|
||||
// Core providers
|
||||
if config_providers.applications {
|
||||
set.insert(ProviderType::Application);
|
||||
}
|
||||
if config_providers.commands {
|
||||
set.insert(ProviderType::Command);
|
||||
}
|
||||
// Plugin providers - use Plugin(type_id) for all
|
||||
if config_providers.uuctl {
|
||||
set.insert(ProviderType::Plugin("uuctl".to_string()));
|
||||
}
|
||||
if config_providers.system {
|
||||
set.insert(ProviderType::Plugin("system".to_string()));
|
||||
}
|
||||
if config_providers.ssh {
|
||||
set.insert(ProviderType::Plugin("ssh".to_string()));
|
||||
}
|
||||
if config_providers.clipboard {
|
||||
set.insert(ProviderType::Plugin("clipboard".to_string()));
|
||||
}
|
||||
if config_providers.bookmarks {
|
||||
set.insert(ProviderType::Plugin("bookmarks".to_string()));
|
||||
}
|
||||
if config_providers.emoji {
|
||||
set.insert(ProviderType::Plugin("emoji".to_string()));
|
||||
}
|
||||
if config_providers.scripts {
|
||||
set.insert(ProviderType::Plugin("scripts".to_string()));
|
||||
}
|
||||
// Dynamic providers
|
||||
if config_providers.files {
|
||||
set.insert(ProviderType::Plugin("filesearch".to_string()));
|
||||
}
|
||||
if config_providers.calculator {
|
||||
set.insert(ProviderType::Plugin("calc".to_string()));
|
||||
}
|
||||
if config_providers.websearch {
|
||||
set.insert(ProviderType::Plugin("websearch".to_string()));
|
||||
}
|
||||
// Default to apps if nothing enabled
|
||||
// No CLI restriction: accept_all=true, so is_active() returns true for
|
||||
// everything. Build the enabled set only for UI tab display, driven by
|
||||
// general.tabs. Falls back to Application + Command if tabs is empty.
|
||||
let mut set: HashSet<ProviderType> = tabs
|
||||
.iter()
|
||||
.map(|s| Self::mode_string_to_provider_type(s))
|
||||
.collect();
|
||||
if set.is_empty() {
|
||||
set.insert(ProviderType::Application);
|
||||
if config_providers.applications {
|
||||
set.insert(ProviderType::Application);
|
||||
}
|
||||
if config_providers.commands {
|
||||
set.insert(ProviderType::Command);
|
||||
}
|
||||
if set.is_empty() {
|
||||
set.insert(ProviderType::Application);
|
||||
}
|
||||
}
|
||||
set
|
||||
};
|
||||
@@ -114,7 +93,8 @@ impl ProviderFilter {
|
||||
}
|
||||
}
|
||||
|
||||
/// Toggle a provider on/off
|
||||
/// Toggle a provider on/off. Clears accept_all so the enabled set is
|
||||
/// actually used for routing — use restore_all_mode() to go back to All.
|
||||
pub fn toggle(&mut self, provider: ProviderType) {
|
||||
if self.enabled.contains(&provider) {
|
||||
self.enabled.remove(&provider);
|
||||
@@ -137,6 +117,7 @@ impl ProviderFilter {
|
||||
provider_debug, self.enabled
|
||||
);
|
||||
}
|
||||
self.accept_all = false;
|
||||
}
|
||||
|
||||
/// Enable a specific provider
|
||||
@@ -156,6 +137,12 @@ impl ProviderFilter {
|
||||
pub fn set_single_mode(&mut self, provider: ProviderType) {
|
||||
self.enabled.clear();
|
||||
self.enabled.insert(provider);
|
||||
self.accept_all = false;
|
||||
}
|
||||
|
||||
/// Restore accept-all mode (used when cycling back to the "All" tab).
|
||||
pub fn restore_all_mode(&mut self) {
|
||||
self.accept_all = true;
|
||||
}
|
||||
|
||||
/// Set prefix mode (from :app, :cmd, etc.)
|
||||
@@ -229,43 +216,48 @@ impl ProviderFilter {
|
||||
}
|
||||
}
|
||||
|
||||
// Core provider prefixes
|
||||
// Core prefixes — each entry is tried as ":name " (full) and ":name" (partial)
|
||||
let core_prefixes: &[(&str, ProviderType)] = &[
|
||||
(":app ", ProviderType::Application),
|
||||
(":apps ", ProviderType::Application),
|
||||
(":cmd ", ProviderType::Command),
|
||||
(":command ", ProviderType::Command),
|
||||
("app", ProviderType::Application),
|
||||
("apps", ProviderType::Application),
|
||||
("cmd", ProviderType::Command),
|
||||
("command", ProviderType::Command),
|
||||
];
|
||||
|
||||
// Plugin provider prefixes - mapped to Plugin(type_id)
|
||||
// Plugin prefixes — each entry maps to a plugin type_id
|
||||
let plugin_prefixes: &[(&str, &str)] = &[
|
||||
(":bm ", "bookmarks"),
|
||||
(":bookmark ", "bookmarks"),
|
||||
(":bookmarks ", "bookmarks"),
|
||||
(":calc ", "calc"),
|
||||
(":calculator ", "calc"),
|
||||
(":clip ", "clipboard"),
|
||||
(":clipboard ", "clipboard"),
|
||||
(":emoji ", "emoji"),
|
||||
(":emojis ", "emoji"),
|
||||
(":file ", "filesearch"),
|
||||
(":files ", "filesearch"),
|
||||
(":find ", "filesearch"),
|
||||
(":script ", "scripts"),
|
||||
(":scripts ", "scripts"),
|
||||
(":ssh ", "ssh"),
|
||||
(":sys ", "system"),
|
||||
(":system ", "system"),
|
||||
(":power ", "system"),
|
||||
(":uuctl ", "uuctl"),
|
||||
(":systemd ", "uuctl"),
|
||||
(":web ", "websearch"),
|
||||
(":search ", "websearch"),
|
||||
("bm", "bookmarks"),
|
||||
("bookmark", "bookmarks"),
|
||||
("bookmarks", "bookmarks"),
|
||||
("calc", "calc"),
|
||||
("calculator", "calc"),
|
||||
("clip", "clipboard"),
|
||||
("clipboard", "clipboard"),
|
||||
("emoji", "emoji"),
|
||||
("emojis", "emoji"),
|
||||
("file", "filesearch"),
|
||||
("files", "filesearch"),
|
||||
("find", "filesearch"),
|
||||
("script", "scripts"),
|
||||
("scripts", "scripts"),
|
||||
("ssh", "ssh"),
|
||||
("sys", "system"),
|
||||
("system", "system"),
|
||||
("power", "system"),
|
||||
("uuctl", "uuctl"),
|
||||
("systemd", "uuctl"),
|
||||
("web", "websearch"),
|
||||
("search", "websearch"),
|
||||
("config", "config"),
|
||||
("settings", "config"),
|
||||
("conv", "conv"),
|
||||
("converter", "conv"),
|
||||
];
|
||||
|
||||
// Check core prefixes
|
||||
for (prefix_str, provider) in core_prefixes {
|
||||
if let Some(rest) = trimmed.strip_prefix(prefix_str) {
|
||||
// Single-pass: try each core prefix as both full (":name query") and partial (":name")
|
||||
for (name, provider) in core_prefixes {
|
||||
let with_space = format!(":{} ", name);
|
||||
if let Some(rest) = trimmed.strip_prefix(with_space.as_str()) {
|
||||
#[cfg(feature = "dev-logging")]
|
||||
debug!(
|
||||
"[Filter] parse_query({:?}) -> prefix={:?}, query={:?}",
|
||||
@@ -277,60 +269,8 @@ impl ProviderFilter {
|
||||
query: rest.to_string(),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// Check plugin prefixes
|
||||
for (prefix_str, type_id) in plugin_prefixes {
|
||||
if let Some(rest) = trimmed.strip_prefix(prefix_str) {
|
||||
let provider = ProviderType::Plugin(type_id.to_string());
|
||||
#[cfg(feature = "dev-logging")]
|
||||
debug!(
|
||||
"[Filter] parse_query({:?}) -> prefix={:?}, query={:?}",
|
||||
query, provider, rest
|
||||
);
|
||||
return ParsedQuery {
|
||||
prefix: Some(provider),
|
||||
tag_filter: None,
|
||||
query: rest.to_string(),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// Handle partial prefixes (still typing)
|
||||
let partial_core: &[(&str, ProviderType)] = &[
|
||||
(":app", ProviderType::Application),
|
||||
(":apps", ProviderType::Application),
|
||||
(":cmd", ProviderType::Command),
|
||||
(":command", ProviderType::Command),
|
||||
];
|
||||
|
||||
let partial_plugin: &[(&str, &str)] = &[
|
||||
(":bm", "bookmarks"),
|
||||
(":bookmark", "bookmarks"),
|
||||
(":bookmarks", "bookmarks"),
|
||||
(":calc", "calc"),
|
||||
(":calculator", "calc"),
|
||||
(":clip", "clipboard"),
|
||||
(":clipboard", "clipboard"),
|
||||
(":emoji", "emoji"),
|
||||
(":emojis", "emoji"),
|
||||
(":file", "filesearch"),
|
||||
(":files", "filesearch"),
|
||||
(":find", "filesearch"),
|
||||
(":script", "scripts"),
|
||||
(":scripts", "scripts"),
|
||||
(":ssh", "ssh"),
|
||||
(":sys", "system"),
|
||||
(":system", "system"),
|
||||
(":power", "system"),
|
||||
(":uuctl", "uuctl"),
|
||||
(":systemd", "uuctl"),
|
||||
(":web", "websearch"),
|
||||
(":search", "websearch"),
|
||||
];
|
||||
|
||||
for (prefix_str, provider) in partial_core {
|
||||
if trimmed == *prefix_str {
|
||||
let exact = format!(":{}", name);
|
||||
if trimmed == exact {
|
||||
#[cfg(feature = "dev-logging")]
|
||||
debug!(
|
||||
"[Filter] parse_query({:?}) -> partial prefix {:?}",
|
||||
@@ -344,8 +284,24 @@ impl ProviderFilter {
|
||||
}
|
||||
}
|
||||
|
||||
for (prefix_str, type_id) in partial_plugin {
|
||||
if trimmed == *prefix_str {
|
||||
// Single-pass: try each plugin prefix as both full and partial
|
||||
for (name, type_id) in plugin_prefixes {
|
||||
let with_space = format!(":{} ", name);
|
||||
if let Some(rest) = trimmed.strip_prefix(with_space.as_str()) {
|
||||
let provider = ProviderType::Plugin(type_id.to_string());
|
||||
#[cfg(feature = "dev-logging")]
|
||||
debug!(
|
||||
"[Filter] parse_query({:?}) -> prefix={:?}, query={:?}",
|
||||
query, provider, rest
|
||||
);
|
||||
return ParsedQuery {
|
||||
prefix: Some(provider),
|
||||
tag_filter: None,
|
||||
query: rest.to_string(),
|
||||
};
|
||||
}
|
||||
let exact = format!(":{}", name);
|
||||
if trimmed == exact {
|
||||
let provider = ProviderType::Plugin(type_id.to_string());
|
||||
#[cfg(feature = "dev-logging")]
|
||||
debug!(
|
||||
|
||||
@@ -58,9 +58,19 @@ fn clean_desktop_exec_field(cmd: &str) -> String {
|
||||
}
|
||||
|
||||
// Clean up any double spaces that may have resulted from removing field codes
|
||||
let mut cleaned = result.trim().to_string();
|
||||
while cleaned.contains(" ") {
|
||||
cleaned = cleaned.replace(" ", " ");
|
||||
let trimmed = result.trim();
|
||||
let mut cleaned = String::with_capacity(trimmed.len());
|
||||
let mut prev_space = false;
|
||||
for c in trimmed.chars() {
|
||||
if c == ' ' {
|
||||
if !prev_space {
|
||||
cleaned.push(' ');
|
||||
}
|
||||
prev_space = true;
|
||||
} else {
|
||||
cleaned.push(c);
|
||||
prev_space = false;
|
||||
}
|
||||
}
|
||||
|
||||
cleaned
|
||||
@@ -271,4 +281,11 @@ mod tests {
|
||||
"env FOO=bar BAZ=qux myapp"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_clean_desktop_exec_collapses_spaces() {
|
||||
assert_eq!(clean_desktop_exec_field("app --flag arg"), "app --flag arg");
|
||||
let input = format!("app{}arg", " ".repeat(100));
|
||||
assert_eq!(clean_desktop_exec_field(&input), "app arg");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -23,24 +23,15 @@ const SEARCH_ENGINES: &[&str] = &[
|
||||
const BUILTIN_THEMES: &[&str] = &["owl"];
|
||||
|
||||
/// Boolean provider fields that can be toggled via CONFIG:toggle:providers.*.
|
||||
/// Only built-in providers are listed here; plugins are enabled/disabled via
|
||||
/// [plugins] disabled_plugins in config.toml or `owlry plugin enable/disable`.
|
||||
const PROVIDER_TOGGLES: &[(&str, &str)] = &[
|
||||
("applications", "Applications"),
|
||||
("commands", "Commands"),
|
||||
("uuctl", "Systemd Units"),
|
||||
("calculator", "Calculator"),
|
||||
("converter", "Unit Converter"),
|
||||
("frecency", "Frecency Ranking"),
|
||||
("websearch", "Web Search"),
|
||||
("system", "System Actions"),
|
||||
("ssh", "SSH Connections"),
|
||||
("clipboard", "Clipboard History"),
|
||||
("bookmarks", "Bookmarks"),
|
||||
("emoji", "Emoji Picker"),
|
||||
("scripts", "Scripts"),
|
||||
("files", "File Search"),
|
||||
("media", "Media Widget"),
|
||||
("weather", "Weather Widget"),
|
||||
("pomodoro", "Pomodoro Widget"),
|
||||
("frecency", "Frecency Ranking"),
|
||||
];
|
||||
|
||||
/// Built-in config editor provider. Interprets query text as a navigation path
|
||||
@@ -70,12 +61,8 @@ impl ConfigProvider {
|
||||
false
|
||||
};
|
||||
|
||||
if result {
|
||||
if let Ok(cfg) = self.config.read() {
|
||||
if let Err(e) = cfg.save() {
|
||||
warn!("Failed to save config: {}", e);
|
||||
}
|
||||
}
|
||||
if result && let Ok(cfg) = self.config.read() && let Err(e) = cfg.save() {
|
||||
warn!("Failed to save config: {}", e);
|
||||
}
|
||||
|
||||
result
|
||||
@@ -98,10 +85,6 @@ impl ConfigProvider {
|
||||
cfg.providers.commands = !cfg.providers.commands;
|
||||
true
|
||||
}
|
||||
"providers.uuctl" => {
|
||||
cfg.providers.uuctl = !cfg.providers.uuctl;
|
||||
true
|
||||
}
|
||||
"providers.calculator" => {
|
||||
cfg.providers.calculator = !cfg.providers.calculator;
|
||||
true
|
||||
@@ -110,52 +93,12 @@ impl ConfigProvider {
|
||||
cfg.providers.converter = !cfg.providers.converter;
|
||||
true
|
||||
}
|
||||
"providers.frecency" => {
|
||||
cfg.providers.frecency = !cfg.providers.frecency;
|
||||
true
|
||||
}
|
||||
"providers.websearch" => {
|
||||
cfg.providers.websearch = !cfg.providers.websearch;
|
||||
true
|
||||
}
|
||||
"providers.system" => {
|
||||
cfg.providers.system = !cfg.providers.system;
|
||||
true
|
||||
}
|
||||
"providers.ssh" => {
|
||||
cfg.providers.ssh = !cfg.providers.ssh;
|
||||
true
|
||||
}
|
||||
"providers.clipboard" => {
|
||||
cfg.providers.clipboard = !cfg.providers.clipboard;
|
||||
true
|
||||
}
|
||||
"providers.bookmarks" => {
|
||||
cfg.providers.bookmarks = !cfg.providers.bookmarks;
|
||||
true
|
||||
}
|
||||
"providers.emoji" => {
|
||||
cfg.providers.emoji = !cfg.providers.emoji;
|
||||
true
|
||||
}
|
||||
"providers.scripts" => {
|
||||
cfg.providers.scripts = !cfg.providers.scripts;
|
||||
true
|
||||
}
|
||||
"providers.files" => {
|
||||
cfg.providers.files = !cfg.providers.files;
|
||||
true
|
||||
}
|
||||
"providers.media" => {
|
||||
cfg.providers.media = !cfg.providers.media;
|
||||
true
|
||||
}
|
||||
"providers.weather" => {
|
||||
cfg.providers.weather = !cfg.providers.weather;
|
||||
true
|
||||
}
|
||||
"providers.pomodoro" => {
|
||||
cfg.providers.pomodoro = !cfg.providers.pomodoro;
|
||||
"providers.frecency" => {
|
||||
cfg.providers.frecency = !cfg.providers.frecency;
|
||||
true
|
||||
}
|
||||
"general.show_icons" => {
|
||||
@@ -762,21 +705,10 @@ fn get_provider_bool(cfg: &Config, field: &str) -> bool {
|
||||
match field {
|
||||
"applications" => cfg.providers.applications,
|
||||
"commands" => cfg.providers.commands,
|
||||
"uuctl" => cfg.providers.uuctl,
|
||||
"calculator" => cfg.providers.calculator,
|
||||
"converter" => cfg.providers.converter,
|
||||
"frecency" => cfg.providers.frecency,
|
||||
"websearch" => cfg.providers.websearch,
|
||||
"system" => cfg.providers.system,
|
||||
"ssh" => cfg.providers.ssh,
|
||||
"clipboard" => cfg.providers.clipboard,
|
||||
"bookmarks" => cfg.providers.bookmarks,
|
||||
"emoji" => cfg.providers.emoji,
|
||||
"scripts" => cfg.providers.scripts,
|
||||
"files" => cfg.providers.files,
|
||||
"media" => cfg.providers.media,
|
||||
"weather" => cfg.providers.weather,
|
||||
"pomodoro" => cfg.providers.pomodoro,
|
||||
"frecency" => cfg.providers.frecency,
|
||||
_ => false,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -202,25 +202,6 @@ impl ProviderManager {
|
||||
manager
|
||||
}
|
||||
|
||||
/// Get type IDs of built-in providers (for conflict detection with native plugins)
|
||||
fn builtin_type_ids(&self) -> std::collections::HashSet<String> {
|
||||
let mut ids: std::collections::HashSet<String> = self
|
||||
.builtin_dynamic
|
||||
.iter()
|
||||
.filter_map(|p| match p.provider_type() {
|
||||
ProviderType::Plugin(id) => Some(id),
|
||||
_ => None,
|
||||
})
|
||||
.collect();
|
||||
// Also include built-in static providers that use Plugin type
|
||||
for p in &self.providers {
|
||||
if let ProviderType::Plugin(id) = p.provider_type() {
|
||||
ids.insert(id);
|
||||
}
|
||||
}
|
||||
ids
|
||||
}
|
||||
|
||||
/// Create a self-contained ProviderManager from config.
|
||||
///
|
||||
/// Loads native plugins, creates core providers (Application + Command),
|
||||
@@ -756,22 +737,17 @@ impl ProviderManager {
|
||||
|
||||
// Empty query (after checking special providers) - return frecency-sorted items
|
||||
if query.is_empty() {
|
||||
// Collect items from core providers
|
||||
let core_items = self
|
||||
let mut scored_refs: Vec<(&LaunchItem, i64)> = self
|
||||
.providers
|
||||
.iter()
|
||||
.filter(|p| filter.is_active(p.provider_type()))
|
||||
.flat_map(|p| p.items().iter().cloned());
|
||||
|
||||
// Collect items from static native providers
|
||||
let native_items = self
|
||||
.static_native_providers
|
||||
.iter()
|
||||
.filter(|p| filter.is_active(p.provider_type()))
|
||||
.flat_map(|p| p.items().iter().cloned());
|
||||
|
||||
let items: Vec<(LaunchItem, i64)> = core_items
|
||||
.chain(native_items)
|
||||
.flat_map(|p| p.items().iter())
|
||||
.chain(
|
||||
self.static_native_providers
|
||||
.iter()
|
||||
.filter(|p| filter.is_active(p.provider_type()))
|
||||
.flat_map(|p| p.items().iter()),
|
||||
)
|
||||
.filter(|item| {
|
||||
// Apply tag filter if present
|
||||
if let Some(tag) = tag_filter {
|
||||
@@ -787,8 +763,15 @@ impl ProviderManager {
|
||||
})
|
||||
.collect();
|
||||
|
||||
// Combine widgets (already in results) with frecency items
|
||||
results.extend(items);
|
||||
// Partial sort: O(n) average to find top max_results, then O(k log k) to order them
|
||||
if scored_refs.len() > max_results {
|
||||
scored_refs.select_nth_unstable_by(max_results, |a, b| b.1.cmp(&a.1));
|
||||
scored_refs.truncate(max_results);
|
||||
}
|
||||
scored_refs.sort_by(|a, b| b.1.cmp(&a.1));
|
||||
|
||||
// Clone only the survivors
|
||||
results.extend(scored_refs.into_iter().map(|(item, score)| (item.clone(), score)));
|
||||
results.sort_by(|a, b| b.1.cmp(&a.1));
|
||||
results.truncate(max_results);
|
||||
return results;
|
||||
@@ -796,7 +779,7 @@ impl ProviderManager {
|
||||
|
||||
// Regular search with frecency boost and tag matching
|
||||
// Helper closure for scoring items
|
||||
let score_item = |item: &LaunchItem| -> Option<(LaunchItem, i64)> {
|
||||
let score_item = |item: &LaunchItem| -> Option<i64> {
|
||||
// Apply tag filter if present
|
||||
if let Some(tag) = tag_filter
|
||||
&& !item.tags.iter().any(|t| t.to_lowercase().contains(tag))
|
||||
@@ -843,33 +826,46 @@ impl ProviderManager {
|
||||
0
|
||||
};
|
||||
|
||||
(item.clone(), s + frecency_boost + exact_match_boost)
|
||||
s + frecency_boost + exact_match_boost
|
||||
})
|
||||
};
|
||||
|
||||
// Search core providers
|
||||
// Score static items by reference (no cloning)
|
||||
let mut scored_refs: Vec<(&LaunchItem, i64)> = Vec::new();
|
||||
|
||||
for provider in &self.providers {
|
||||
if !filter.is_active(provider.provider_type()) {
|
||||
continue;
|
||||
}
|
||||
for item in provider.items() {
|
||||
if let Some(scored) = score_item(item) {
|
||||
results.push(scored);
|
||||
if let Some(score) = score_item(item) {
|
||||
scored_refs.push((item, score));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Search static native providers
|
||||
for provider in &self.static_native_providers {
|
||||
if !filter.is_active(provider.provider_type()) {
|
||||
continue;
|
||||
}
|
||||
for item in provider.items() {
|
||||
if let Some(scored) = score_item(item) {
|
||||
results.push(scored);
|
||||
if let Some(score) = score_item(item) {
|
||||
scored_refs.push((item, score));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Partial sort: O(n) average to find top max_results, then O(k log k) to order them
|
||||
if scored_refs.len() > max_results {
|
||||
scored_refs.select_nth_unstable_by(max_results, |a, b| b.1.cmp(&a.1));
|
||||
scored_refs.truncate(max_results);
|
||||
}
|
||||
scored_refs.sort_by(|a, b| b.1.cmp(&a.1));
|
||||
|
||||
// Clone only the survivors
|
||||
results.extend(scored_refs.into_iter().map(|(item, score)| (item.clone(), score)));
|
||||
|
||||
// Final sort merges dynamic results (already in `results`) with static top-N
|
||||
results.sort_by(|a, b| b.1.cmp(&a.1));
|
||||
results.truncate(max_results);
|
||||
|
||||
@@ -1236,23 +1232,4 @@ mod tests {
|
||||
assert_eq!(results[0].0.name, "Firefox");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_builtin_type_ids_includes_dynamic_and_static() {
|
||||
use super::calculator::CalculatorProvider;
|
||||
use super::converter::ConverterProvider;
|
||||
use super::system::SystemProvider;
|
||||
|
||||
let mut pm = ProviderManager::new(
|
||||
vec![Box::new(SystemProvider::new())],
|
||||
vec![],
|
||||
);
|
||||
pm.builtin_dynamic = vec![
|
||||
Box::new(CalculatorProvider),
|
||||
Box::new(ConverterProvider::new()),
|
||||
];
|
||||
let ids = pm.builtin_type_ids();
|
||||
assert!(ids.contains("calc"));
|
||||
assert!(ids.contains("conv"));
|
||||
assert!(ids.contains("sys"));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
//! Native plugins are loaded from `/usr/lib/owlry/plugins/` as `.so` files
|
||||
//! and provide search providers via an ABI-stable interface.
|
||||
|
||||
use std::sync::{Arc, RwLock};
|
||||
use std::sync::Arc;
|
||||
|
||||
use log::debug;
|
||||
use owlry_plugin_api::{
|
||||
@@ -28,7 +28,7 @@ pub struct NativeProvider {
|
||||
/// Handle to the provider state in the plugin
|
||||
handle: ProviderHandle,
|
||||
/// Cached items (for static providers)
|
||||
items: RwLock<Vec<LaunchItem>>,
|
||||
items: Vec<LaunchItem>,
|
||||
}
|
||||
|
||||
impl NativeProvider {
|
||||
@@ -40,7 +40,7 @@ impl NativeProvider {
|
||||
plugin,
|
||||
info,
|
||||
handle,
|
||||
items: RwLock::new(Vec::new()),
|
||||
items: Vec::new(),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -74,7 +74,7 @@ impl NativeProvider {
|
||||
let is_special_query = query.starts_with("?SUBMENU:") || query.starts_with("!");
|
||||
|
||||
if self.info.provider_type != ProviderKind::Dynamic && !is_special_query {
|
||||
return self.items.read().unwrap().clone();
|
||||
return self.items.clone();
|
||||
}
|
||||
|
||||
let api_items = self.plugin.query_provider(self.handle, query);
|
||||
@@ -171,22 +171,11 @@ impl Provider for NativeProvider {
|
||||
items.len()
|
||||
);
|
||||
|
||||
*self.items.write().unwrap() = items;
|
||||
self.items = items;
|
||||
}
|
||||
|
||||
fn items(&self) -> &[LaunchItem] {
|
||||
// This is tricky with RwLock - we need to return a reference but can't
|
||||
// hold the lock across the return. We use a raw pointer approach.
|
||||
//
|
||||
// SAFETY: The items Vec is only modified during refresh() which takes
|
||||
// &mut self, so no concurrent modification can occur while this
|
||||
// reference is live.
|
||||
unsafe {
|
||||
let guard = self.items.read().unwrap();
|
||||
let ptr = guard.as_ptr();
|
||||
let len = guard.len();
|
||||
std::slice::from_raw_parts(ptr, len)
|
||||
}
|
||||
&self.items
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "owlry-lua"
|
||||
version = "1.1.0"
|
||||
version = "1.1.2"
|
||||
edition.workspace = true
|
||||
rust-version.workspace = true
|
||||
license.workspace = true
|
||||
@@ -31,7 +31,7 @@ serde_json = "1.0"
|
||||
semver = "1"
|
||||
|
||||
# HTTP client for plugins
|
||||
reqwest = { version = "0.13", features = ["blocking", "json"] }
|
||||
reqwest = { version = "0.13", default-features = false, features = ["native-tls", "blocking", "json"] }
|
||||
|
||||
# Math expression evaluation
|
||||
meval = "0.2"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "owlry-rune"
|
||||
version = "1.1.0"
|
||||
version = "1.1.3"
|
||||
edition = "2024"
|
||||
rust-version = "1.90"
|
||||
description = "Rune scripting runtime for owlry plugins"
|
||||
@@ -15,14 +15,13 @@ owlry-plugin-api = { path = "../owlry-plugin-api" }
|
||||
|
||||
# Rune scripting language
|
||||
rune = "0.14"
|
||||
rune-modules = { version = "0.14", features = ["full"] }
|
||||
|
||||
# Logging
|
||||
log = "0.4"
|
||||
env_logger = "0.11"
|
||||
|
||||
# HTTP client for network API
|
||||
reqwest = { version = "0.13", default-features = false, features = ["rustls", "json", "blocking"] }
|
||||
reqwest = { version = "0.13", default-features = false, features = ["native-tls", "json", "blocking"] }
|
||||
|
||||
# Serialization
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "owlry"
|
||||
version = "1.0.6"
|
||||
version = "1.0.7"
|
||||
edition = "2024"
|
||||
rust-version = "1.90"
|
||||
description = "A lightweight, owl-themed application launcher for Wayland"
|
||||
|
||||
@@ -1,12 +1,11 @@
|
||||
fn main() {
|
||||
// Compile GResource bundle for icons
|
||||
// Compile GResource bundle for plugin-specific icons (weather, media, pomodoro)
|
||||
glib_build_tools::compile_resources(
|
||||
&["src/resources/icons"],
|
||||
"src/resources/icons.gresource.xml",
|
||||
"icons.gresource",
|
||||
);
|
||||
|
||||
// Rerun if icon files change
|
||||
println!("cargo:rerun-if-changed=src/resources/icons.gresource.xml");
|
||||
println!("cargo:rerun-if-changed=src/resources/icons/");
|
||||
}
|
||||
|
||||
@@ -91,17 +91,20 @@ impl OwlryApp {
|
||||
.iter()
|
||||
.map(|s| ProviderFilter::mode_string_to_provider_type(s))
|
||||
.collect();
|
||||
let tabs = &config.borrow().general.tabs.clone();
|
||||
if provider_types.len() == 1 {
|
||||
ProviderFilter::new(
|
||||
Some(provider_types[0].clone()),
|
||||
None,
|
||||
&config.borrow().providers,
|
||||
tabs,
|
||||
)
|
||||
} else {
|
||||
ProviderFilter::new(None, Some(provider_types), &config.borrow().providers)
|
||||
ProviderFilter::new(None, Some(provider_types), &config.borrow().providers, tabs)
|
||||
}
|
||||
} else {
|
||||
ProviderFilter::new(None, None, &config.borrow().providers)
|
||||
let tabs = config.borrow().general.tabs.clone();
|
||||
ProviderFilter::new(None, None, &config.borrow().providers, &tabs)
|
||||
};
|
||||
let filter = Rc::new(RefCell::new(filter));
|
||||
|
||||
|
||||
@@ -394,7 +394,9 @@ impl MainWindow {
|
||||
format!("Search {}...", active.join(", "))
|
||||
}
|
||||
|
||||
/// Build dynamic hints based on enabled providers
|
||||
/// Build hints string for the status bar based on enabled built-in providers.
|
||||
/// Plugin trigger hints (? web, / files, etc.) are not included here since
|
||||
/// plugin availability is not tracked in ProvidersConfig.
|
||||
fn build_hints(config: &owlry_core::config::ProvidersConfig) -> String {
|
||||
let mut parts: Vec<String> = vec![
|
||||
"Tab: cycle".to_string(),
|
||||
@@ -403,38 +405,14 @@ impl MainWindow {
|
||||
"Esc: close".to_string(),
|
||||
];
|
||||
|
||||
// Add trigger hints for enabled dynamic providers
|
||||
if config.calculator {
|
||||
parts.push("= calc".to_string());
|
||||
}
|
||||
if config.websearch {
|
||||
parts.push("? web".to_string());
|
||||
if config.converter {
|
||||
parts.push("> conv".to_string());
|
||||
}
|
||||
if config.files {
|
||||
parts.push("/ files".to_string());
|
||||
}
|
||||
|
||||
// Add prefix hints for static providers
|
||||
let mut prefixes = Vec::new();
|
||||
if config.system {
|
||||
prefixes.push(":sys");
|
||||
}
|
||||
if config.emoji {
|
||||
prefixes.push(":emoji");
|
||||
}
|
||||
if config.ssh {
|
||||
prefixes.push(":ssh");
|
||||
}
|
||||
if config.clipboard {
|
||||
prefixes.push(":clip");
|
||||
}
|
||||
if config.bookmarks {
|
||||
prefixes.push(":bm");
|
||||
}
|
||||
|
||||
// Only show first few prefixes to avoid overflow
|
||||
if !prefixes.is_empty() {
|
||||
parts.push(prefixes[..prefixes.len().min(4)].join(" "));
|
||||
parts.push(":sys".to_string());
|
||||
}
|
||||
|
||||
parts.join(" ")
|
||||
@@ -507,9 +485,7 @@ impl MainWindow {
|
||||
search_entry.set_placeholder_text(Some(&format!("Filter {} actions...", display_name)));
|
||||
|
||||
// Display actions
|
||||
while let Some(child) = results_list.first_child() {
|
||||
results_list.remove(&child);
|
||||
}
|
||||
results_list.remove_all();
|
||||
|
||||
for item in &actions {
|
||||
let row = ResultRow::new(item, "");
|
||||
@@ -589,9 +565,7 @@ impl MainWindow {
|
||||
.collect();
|
||||
|
||||
// Clear and repopulate
|
||||
while let Some(child) = results_list.first_child() {
|
||||
results_list.remove(&child);
|
||||
}
|
||||
results_list.remove_all();
|
||||
|
||||
for item in &filtered {
|
||||
let row = ResultRow::new(item, "");
|
||||
@@ -702,9 +676,7 @@ impl MainWindow {
|
||||
if search_entry_for_stale.text().as_str() != raw_text_at_dispatch {
|
||||
return;
|
||||
}
|
||||
while let Some(child) = results_list_cb.first_child() {
|
||||
results_list_cb.remove(&child);
|
||||
}
|
||||
results_list_cb.remove_all();
|
||||
|
||||
let items = result.items;
|
||||
let initial_count =
|
||||
@@ -739,9 +711,7 @@ impl MainWindow {
|
||||
tag.as_deref(),
|
||||
);
|
||||
|
||||
while let Some(child) = results_list.first_child() {
|
||||
results_list.remove(&child);
|
||||
}
|
||||
results_list.remove_all();
|
||||
|
||||
let initial_count = INITIAL_RESULTS.min(results.len());
|
||||
|
||||
@@ -1167,6 +1137,7 @@ impl MainWindow {
|
||||
for provider in tab_order {
|
||||
f.enable(provider.clone());
|
||||
}
|
||||
f.restore_all_mode();
|
||||
}
|
||||
for (_, button) in buttons.borrow().iter() {
|
||||
button.set_active(true);
|
||||
@@ -1247,9 +1218,7 @@ impl MainWindow {
|
||||
);
|
||||
|
||||
// Clear existing results
|
||||
while let Some(child) = results_list.first_child() {
|
||||
results_list.remove(&child);
|
||||
}
|
||||
results_list.remove_all();
|
||||
|
||||
let initial_count = INITIAL_RESULTS.min(results.len());
|
||||
|
||||
|
||||
@@ -59,8 +59,10 @@ max_results = 100
|
||||
# Requires: uwsm to be installed
|
||||
# use_uwsm = true
|
||||
|
||||
# Header tabs - providers shown as toggle buttons (Ctrl+1, Ctrl+2, etc.)
|
||||
# Values: app, cmd, uuctl, bookmark, calc, clip, dmenu, emoji, file, script, ssh, sys, web
|
||||
# Header tabs — provider tabs shown in the UI bar (Ctrl+1..9 to toggle)
|
||||
# Core values: app, cmd, dmenu
|
||||
# Plugin values: uuctl, calc, clip, emoji, file, script, ssh, sys, web, bm
|
||||
# Any installed plugin's type_id is valid (e.g. "weather", "media")
|
||||
tabs = ["app", "cmd", "uuctl"]
|
||||
|
||||
# ═══════════════════════════════════════════════════════════════════════
|
||||
@@ -140,55 +142,25 @@ disabled_plugins = []
|
||||
# PROVIDERS
|
||||
# ═══════════════════════════════════════════════════════════════════════
|
||||
#
|
||||
# Enable/disable providers and configure their settings.
|
||||
# Core providers (applications, commands) are built into the binary.
|
||||
# Plugin providers require their .so to be installed.
|
||||
# Controls built-in providers only. Plugins are enabled/disabled via
|
||||
# [plugins] disabled_plugins or `owlry plugin enable/disable <name>`.
|
||||
|
||||
[providers]
|
||||
# Core providers (always available)
|
||||
# Core providers
|
||||
applications = true # .desktop applications from XDG dirs
|
||||
commands = true # Executables from $PATH
|
||||
|
||||
# Frecency - boost frequently/recently used items
|
||||
# Built-in providers (compiled into owlry-core)
|
||||
calculator = true # Math expressions (= or calc trigger)
|
||||
converter = true # Unit/currency conversion (> trigger)
|
||||
system = true # System actions: shutdown, reboot, lock, etc.
|
||||
|
||||
# Frecency — boost frequently/recently used items
|
||||
# Data stored in: ~/.local/share/owlry/frecency.json
|
||||
frecency = true
|
||||
frecency_weight = 0.3 # 0.0 = disabled, 1.0 = strong boost
|
||||
|
||||
# ─────────────────────────────────────────────────────────────────────────
|
||||
# Plugin provider toggles (require corresponding plugin installed)
|
||||
# ─────────────────────────────────────────────────────────────────────────
|
||||
uuctl = true # systemd user units
|
||||
system = true # System commands (shutdown, reboot, etc.)
|
||||
ssh = true # SSH hosts from ~/.ssh/config
|
||||
clipboard = true # Clipboard history (requires cliphist)
|
||||
bookmarks = true # Browser bookmarks
|
||||
emoji = true # Emoji picker
|
||||
scripts = true # Custom scripts from ~/.local/share/owlry/scripts/
|
||||
files = true # File search (requires fd or mlocate)
|
||||
calculator = true # Calculator (= expression)
|
||||
websearch = true # Web search (? query)
|
||||
|
||||
# ─────────────────────────────────────────────────────────────────────────
|
||||
# Widget providers (displayed at top of results)
|
||||
# ─────────────────────────────────────────────────────────────────────────
|
||||
media = true # MPRIS media player controls
|
||||
weather = false # Weather widget (disabled by default)
|
||||
pomodoro = false # Pomodoro timer (disabled by default)
|
||||
|
||||
# ─────────────────────────────────────────────────────────────────────────
|
||||
# Provider settings
|
||||
# ─────────────────────────────────────────────────────────────────────────
|
||||
|
||||
# Web search engine
|
||||
# Web search engine (used by owlry-plugin-websearch)
|
||||
# Options: google, duckduckgo, bing, startpage, searxng, brave, ecosia
|
||||
# Or custom URL: "https://search.example.com/?q={query}"
|
||||
# Or a custom URL: "https://search.example.com/?q={query}"
|
||||
search_engine = "duckduckgo"
|
||||
|
||||
# Weather settings (when weather = true)
|
||||
# weather_provider = "wttr.in" # Options: wttr.in, openweathermap, open-meteo
|
||||
# weather_location = "Berlin" # City name or coordinates
|
||||
# weather_api_key = "" # Required for openweathermap
|
||||
|
||||
# Pomodoro settings (when pomodoro = true)
|
||||
# pomodoro_work_mins = 25 # Work session duration
|
||||
# pomodoro_break_mins = 5 # Break duration
|
||||
|
||||
967
docs/superpowers/plans/2026-03-26-codebase-hardening.md
Normal file
967
docs/superpowers/plans/2026-03-26-codebase-hardening.md
Normal file
@@ -0,0 +1,967 @@
|
||||
# Codebase Hardening Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Fix 15 soundness, security, robustness, and quality issues across owlry core and owlry-plugins repos.
|
||||
|
||||
**Architecture:** Point fixes organized into 5 severity tiers. Each tier is one commit. Core repo (owlry) tiers 1-3 first, then plugins repo (owlry-plugins) tiers 4-5. No new features, no refactoring beyond what each fix requires.
|
||||
|
||||
**Tech Stack:** Rust 1.90+, abi_stable 0.11, toml 0.8, dirs 5.0
|
||||
|
||||
**Repos:**
|
||||
- Core: `/home/cnachtigall/ssd/git/archive/owlibou/owlry`
|
||||
- Plugins: `/home/cnachtigall/ssd/git/archive/owlibou/owlry-plugins`
|
||||
|
||||
---
|
||||
|
||||
## Task 1: Tier 1 — Critical / Soundness (owlry core)
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-plugin-api/src/lib.rs:297-320`
|
||||
- Modify: `crates/owlry-core/src/server.rs:1-6,91-123,127-215`
|
||||
|
||||
### 1a. Replace `static mut HOST_API` with `OnceLock`
|
||||
|
||||
- [ ] **Step 1: Replace the static mut and init function**
|
||||
|
||||
In `crates/owlry-plugin-api/src/lib.rs`, replace lines 297-320:
|
||||
|
||||
```rust
|
||||
// Old:
|
||||
// static mut HOST_API: Option<&'static HostAPI> = None;
|
||||
//
|
||||
// pub unsafe fn init_host_api(api: &'static HostAPI) {
|
||||
// unsafe {
|
||||
// HOST_API = Some(api);
|
||||
// }
|
||||
// }
|
||||
//
|
||||
// pub fn host_api() -> Option<&'static HostAPI> {
|
||||
// unsafe { HOST_API }
|
||||
// }
|
||||
|
||||
// New:
|
||||
use std::sync::OnceLock;
|
||||
|
||||
static HOST_API: OnceLock<&'static HostAPI> = OnceLock::new();
|
||||
|
||||
/// Initialize the host API (called by the host)
|
||||
///
|
||||
/// # Safety
|
||||
/// Must only be called once by the host before any plugins use the API
|
||||
pub unsafe fn init_host_api(api: &'static HostAPI) {
|
||||
let _ = HOST_API.set(api);
|
||||
}
|
||||
|
||||
/// Get the host API
|
||||
///
|
||||
/// Returns None if the host hasn't initialized the API yet
|
||||
pub fn host_api() -> Option<&'static HostAPI> {
|
||||
HOST_API.get().copied()
|
||||
}
|
||||
```
|
||||
|
||||
Note: `init_host_api` keeps its `unsafe` signature for API compatibility even though `OnceLock::set` is safe. The `unsafe` documents the caller contract.
|
||||
|
||||
- [ ] **Step 2: Verify the plugin-api crate compiles**
|
||||
|
||||
Run: `cargo check -p owlry-plugin-api`
|
||||
Expected: success, no warnings about `static mut`
|
||||
|
||||
### 1b. Add IPC message size limit
|
||||
|
||||
- [ ] **Step 3: Add size-limited read loop in server.rs**
|
||||
|
||||
In `crates/owlry-core/src/server.rs`, add the constant near the top of the file (after the imports):
|
||||
|
||||
```rust
|
||||
/// Maximum size of a single IPC request line (1 MB)
|
||||
const MAX_REQUEST_SIZE: usize = 1_048_576;
|
||||
```
|
||||
|
||||
Replace the `handle_client` method (lines 91-123). Change the `for line in reader.lines()` loop to a manual `read_line` loop with size checking:
|
||||
|
||||
```rust
|
||||
fn handle_client(
|
||||
stream: UnixStream,
|
||||
pm: Arc<Mutex<ProviderManager>>,
|
||||
frecency: Arc<Mutex<FrecencyStore>>,
|
||||
config: Arc<Config>,
|
||||
) -> io::Result<()> {
|
||||
let reader = BufReader::new(stream.try_clone()?);
|
||||
let mut writer = stream;
|
||||
let mut reader = reader;
|
||||
let mut line = String::new();
|
||||
|
||||
loop {
|
||||
line.clear();
|
||||
let bytes_read = reader.read_line(&mut line)?;
|
||||
if bytes_read == 0 {
|
||||
break; // EOF
|
||||
}
|
||||
|
||||
if line.len() > MAX_REQUEST_SIZE {
|
||||
let resp = Response::Error {
|
||||
message: "request too large".to_string(),
|
||||
};
|
||||
write_response(&mut writer, &resp)?;
|
||||
break; // Drop connection
|
||||
}
|
||||
|
||||
let trimmed = line.trim();
|
||||
if trimmed.is_empty() {
|
||||
continue;
|
||||
}
|
||||
|
||||
let request: Request = match serde_json::from_str(trimmed) {
|
||||
Ok(req) => req,
|
||||
Err(e) => {
|
||||
let resp = Response::Error {
|
||||
message: format!("invalid request JSON: {}", e),
|
||||
};
|
||||
write_response(&mut writer, &resp)?;
|
||||
continue;
|
||||
}
|
||||
};
|
||||
|
||||
let response = Self::handle_request(&request, &pm, &frecency, &config);
|
||||
write_response(&mut writer, &response)?;
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
```
|
||||
|
||||
### 1c. Handle mutex poisoning gracefully
|
||||
|
||||
- [ ] **Step 4: Replace all lock().unwrap() in handle_request**
|
||||
|
||||
In `crates/owlry-core/src/server.rs`, in the `handle_request` method, replace every occurrence of `.lock().unwrap()` with `.lock().unwrap_or_else(|e| e.into_inner())`. There are instances in the `Query`, `Launch`, `Providers`, `Refresh`, `Submenu`, and `PluginAction` arms.
|
||||
|
||||
For example, the Query arm changes from:
|
||||
```rust
|
||||
let pm_guard = pm.lock().unwrap();
|
||||
let frecency_guard = frecency.lock().unwrap();
|
||||
```
|
||||
to:
|
||||
```rust
|
||||
let pm_guard = pm.lock().unwrap_or_else(|e| e.into_inner());
|
||||
let frecency_guard = frecency.lock().unwrap_or_else(|e| e.into_inner());
|
||||
```
|
||||
|
||||
Apply this pattern to all `.lock().unwrap()` calls in `handle_request`.
|
||||
|
||||
- [ ] **Step 5: Build and test the core crate**
|
||||
|
||||
Run: `cargo check -p owlry-core && cargo test -p owlry-core`
|
||||
Expected: all checks pass, all existing tests pass
|
||||
|
||||
- [ ] **Step 6: Commit Tier 1**
|
||||
|
||||
```bash
|
||||
cd /home/cnachtigall/ssd/git/archive/owlibou/owlry
|
||||
git add crates/owlry-plugin-api/src/lib.rs crates/owlry-core/src/server.rs
|
||||
git commit -m "fix: soundness — OnceLock for HOST_API, IPC size limits, mutex poisoning recovery"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 2: Tier 2 — Security (owlry core)
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-core/src/server.rs:1-6,29-36,91-123`
|
||||
- Modify: `crates/owlry-core/src/main.rs:26-32`
|
||||
|
||||
### 2a. Set socket permissions after bind
|
||||
|
||||
- [ ] **Step 1: Add permission setting in Server::bind**
|
||||
|
||||
In `crates/owlry-core/src/server.rs`, add the import at the top:
|
||||
|
||||
```rust
|
||||
use std::os::unix::fs::PermissionsExt;
|
||||
```
|
||||
|
||||
In `Server::bind()`, after the `UnixListener::bind(socket_path)?;` line, add:
|
||||
|
||||
```rust
|
||||
std::fs::set_permissions(socket_path, std::fs::Permissions::from_mode(0o600))?;
|
||||
```
|
||||
|
||||
### 2b. Log signal handler failure
|
||||
|
||||
- [ ] **Step 2: Replace .ok() with warning log in main.rs**
|
||||
|
||||
In `crates/owlry-core/src/main.rs`, add `use log::warn;` to the imports, then replace lines 26-32:
|
||||
|
||||
```rust
|
||||
// Old:
|
||||
// ctrlc::set_handler(move || {
|
||||
// let _ = std::fs::remove_file(&sock_cleanup);
|
||||
// std::process::exit(0);
|
||||
// })
|
||||
// .ok();
|
||||
|
||||
// New:
|
||||
if let Err(e) = ctrlc::set_handler(move || {
|
||||
let _ = std::fs::remove_file(&sock_cleanup);
|
||||
std::process::exit(0);
|
||||
}) {
|
||||
warn!("Failed to set signal handler: {}", e);
|
||||
}
|
||||
```
|
||||
|
||||
### 2c. Add client read timeout
|
||||
|
||||
- [ ] **Step 3: Set read timeout on accepted connections**
|
||||
|
||||
In `crates/owlry-core/src/server.rs`, add `use std::time::Duration;` to the imports.
|
||||
|
||||
In the `handle_client` method, at the very top (before the `BufReader` creation), add:
|
||||
|
||||
```rust
|
||||
stream.set_read_timeout(Some(Duration::from_secs(30)))?;
|
||||
```
|
||||
|
||||
This means the `stream` passed to `handle_client` needs to be mutable, or we set it on the clone. Since `set_read_timeout` takes `&self` (not `&mut self`), we can call it directly:
|
||||
|
||||
```rust
|
||||
fn handle_client(
|
||||
stream: UnixStream,
|
||||
pm: Arc<...>,
|
||||
frecency: Arc<...>,
|
||||
config: Arc<Config>,
|
||||
) -> io::Result<()> {
|
||||
stream.set_read_timeout(Some(Duration::from_secs(30)))?;
|
||||
let reader = BufReader::new(stream.try_clone()?);
|
||||
// ... rest unchanged
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Build and test**
|
||||
|
||||
Run: `cargo check -p owlry-core && cargo test -p owlry-core`
|
||||
Expected: all checks pass, all existing tests pass
|
||||
|
||||
- [ ] **Step 5: Commit Tier 2**
|
||||
|
||||
```bash
|
||||
cd /home/cnachtigall/ssd/git/archive/owlibou/owlry
|
||||
git add crates/owlry-core/src/server.rs crates/owlry-core/src/main.rs
|
||||
git commit -m "fix: security — socket perms 0600, signal handler logging, client read timeout"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 3: Tier 3 — Robustness / Quality (owlry core)
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-core/src/server.rs:1-6,17-23,53-73,91-215`
|
||||
|
||||
### 3a. Log malformed JSON requests
|
||||
|
||||
- [ ] **Step 1: Add warn! for JSON parse errors**
|
||||
|
||||
In `crates/owlry-core/src/server.rs`, in the `handle_client` method, in the JSON parse error arm, add a warning log before the error response:
|
||||
|
||||
```rust
|
||||
Err(e) => {
|
||||
warn!("Malformed request from client: {}", e);
|
||||
let resp = Response::Error {
|
||||
message: format!("invalid request JSON: {}", e),
|
||||
};
|
||||
write_response(&mut writer, &resp)?;
|
||||
continue;
|
||||
}
|
||||
```
|
||||
|
||||
### 3b. Replace Mutex with RwLock
|
||||
|
||||
- [ ] **Step 2: Change Server struct and imports**
|
||||
|
||||
In `crates/owlry-core/src/server.rs`, change the import from `Mutex` to `RwLock`:
|
||||
|
||||
```rust
|
||||
use std::sync::{Arc, RwLock};
|
||||
```
|
||||
|
||||
Change the `Server` struct fields:
|
||||
|
||||
```rust
|
||||
pub struct Server {
|
||||
listener: UnixListener,
|
||||
socket_path: PathBuf,
|
||||
provider_manager: Arc<RwLock<ProviderManager>>,
|
||||
frecency: Arc<RwLock<FrecencyStore>>,
|
||||
config: Arc<Config>,
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Update Server::bind**
|
||||
|
||||
In `Server::bind()`, change `Arc::new(Mutex::new(...))` to `Arc::new(RwLock::new(...))`:
|
||||
|
||||
```rust
|
||||
Ok(Self {
|
||||
listener,
|
||||
socket_path: socket_path.to_path_buf(),
|
||||
provider_manager: Arc::new(RwLock::new(provider_manager)),
|
||||
frecency: Arc::new(RwLock::new(frecency)),
|
||||
config: Arc::new(config),
|
||||
})
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Update handle_client and handle_request signatures**
|
||||
|
||||
Change `handle_client` parameter types:
|
||||
|
||||
```rust
|
||||
fn handle_client(
|
||||
stream: UnixStream,
|
||||
pm: Arc<RwLock<ProviderManager>>,
|
||||
frecency: Arc<RwLock<FrecencyStore>>,
|
||||
config: Arc<Config>,
|
||||
) -> io::Result<()> {
|
||||
```
|
||||
|
||||
Change `handle_request` parameter types:
|
||||
|
||||
```rust
|
||||
fn handle_request(
|
||||
request: &Request,
|
||||
pm: &Arc<RwLock<ProviderManager>>,
|
||||
frecency: &Arc<RwLock<FrecencyStore>>,
|
||||
config: &Arc<Config>,
|
||||
) -> Response {
|
||||
```
|
||||
|
||||
Also update `handle_one_for_testing` if it passes these types through.
|
||||
|
||||
- [ ] **Step 5: Update lock calls per request type**
|
||||
|
||||
In `handle_request`, change each lock call according to the read/write mapping:
|
||||
|
||||
**Query** (read PM, read frecency):
|
||||
```rust
|
||||
Request::Query { text, modes } => {
|
||||
let filter = match modes {
|
||||
Some(m) => ProviderFilter::from_mode_strings(m),
|
||||
None => ProviderFilter::all(),
|
||||
};
|
||||
let max = config.general.max_results;
|
||||
let weight = config.providers.frecency_weight;
|
||||
|
||||
let pm_guard = pm.read().unwrap_or_else(|e| e.into_inner());
|
||||
let frecency_guard = frecency.read().unwrap_or_else(|e| e.into_inner());
|
||||
let results = pm_guard.search_with_frecency(
|
||||
text, max, &filter, &frecency_guard, weight, None,
|
||||
);
|
||||
|
||||
Response::Results {
|
||||
items: results
|
||||
.into_iter()
|
||||
.map(|(item, score)| launch_item_to_result(item, score))
|
||||
.collect(),
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Launch** (write frecency):
|
||||
```rust
|
||||
Request::Launch { item_id, provider: _ } => {
|
||||
let mut frecency_guard = frecency.write().unwrap_or_else(|e| e.into_inner());
|
||||
frecency_guard.record_launch(item_id);
|
||||
Response::Ack
|
||||
}
|
||||
```
|
||||
|
||||
**Providers** (read PM):
|
||||
```rust
|
||||
Request::Providers => {
|
||||
let pm_guard = pm.read().unwrap_or_else(|e| e.into_inner());
|
||||
let descs = pm_guard.available_providers();
|
||||
Response::Providers {
|
||||
list: descs.into_iter().map(descriptor_to_desc).collect(),
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Refresh** (write PM):
|
||||
```rust
|
||||
Request::Refresh { provider } => {
|
||||
let mut pm_guard = pm.write().unwrap_or_else(|e| e.into_inner());
|
||||
pm_guard.refresh_provider(provider);
|
||||
Response::Ack
|
||||
}
|
||||
```
|
||||
|
||||
**Toggle** (no locks):
|
||||
```rust
|
||||
Request::Toggle => Response::Ack,
|
||||
```
|
||||
|
||||
**Submenu** (read PM):
|
||||
```rust
|
||||
Request::Submenu { plugin_id, data } => {
|
||||
let pm_guard = pm.read().unwrap_or_else(|e| e.into_inner());
|
||||
match pm_guard.query_submenu_actions(plugin_id, data, plugin_id) {
|
||||
Some((_name, actions)) => Response::SubmenuItems {
|
||||
items: actions
|
||||
.into_iter()
|
||||
.map(|item| launch_item_to_result(item, 0))
|
||||
.collect(),
|
||||
},
|
||||
None => Response::Error {
|
||||
message: format!("no submenu actions for plugin '{}'", plugin_id),
|
||||
},
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**PluginAction** (read PM):
|
||||
```rust
|
||||
Request::PluginAction { command } => {
|
||||
let pm_guard = pm.read().unwrap_or_else(|e| e.into_inner());
|
||||
if pm_guard.execute_plugin_action(command) {
|
||||
Response::Ack
|
||||
} else {
|
||||
Response::Error {
|
||||
message: format!("no plugin handled action '{}'", command),
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 6: Build and test**
|
||||
|
||||
Run: `cargo check -p owlry-core && cargo test -p owlry-core`
|
||||
Expected: all checks pass, all existing tests pass
|
||||
|
||||
- [ ] **Step 7: Commit Tier 3**
|
||||
|
||||
```bash
|
||||
cd /home/cnachtigall/ssd/git/archive/owlibou/owlry
|
||||
git add crates/owlry-core/src/server.rs
|
||||
git commit -m "fix: robustness — RwLock for concurrent reads, log malformed JSON requests"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 4: Tier 4 — Critical fixes (owlry-plugins)
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-plugin-converter/src/currency.rs:88-113,244-265`
|
||||
- Modify: `crates/owlry-plugin-converter/src/units.rs:90-101,160-213`
|
||||
- Modify: `crates/owlry-plugin-bookmarks/src/lib.rs:40-45,228-260,317-353`
|
||||
|
||||
All paths relative to `/home/cnachtigall/ssd/git/archive/owlibou/owlry-plugins`.
|
||||
|
||||
### 4a. Fix Box::leak memory leak in converter
|
||||
|
||||
- [ ] **Step 1: Change resolve_currency_code return type**
|
||||
|
||||
In `crates/owlry-plugin-converter/src/currency.rs`, change the `resolve_currency_code` function (line 88) from returning `Option<String>` to `Option<&'static str>`:
|
||||
|
||||
```rust
|
||||
pub fn resolve_currency_code(alias: &str) -> Option<&'static str> {
|
||||
let lower = alias.to_lowercase();
|
||||
|
||||
// Check aliases
|
||||
for ca in CURRENCY_ALIASES {
|
||||
if ca.aliases.contains(&lower.as_str()) {
|
||||
return Some(ca.code);
|
||||
}
|
||||
}
|
||||
|
||||
// Check if it's a raw 3-letter ISO code we know about
|
||||
let upper = alias.to_uppercase();
|
||||
if upper.len() == 3 {
|
||||
if upper == "EUR" {
|
||||
return Some("EUR");
|
||||
}
|
||||
// Check if we have rates for it — return the matching alias code
|
||||
if let Some(rates) = get_rates()
|
||||
&& rates.rates.contains_key(&upper)
|
||||
{
|
||||
// Find a matching CURRENCY_ALIASES entry for this code
|
||||
for ca in CURRENCY_ALIASES {
|
||||
if ca.code == upper {
|
||||
return Some(ca.code);
|
||||
}
|
||||
}
|
||||
// Not in our aliases but valid in ECB rates — we can't return
|
||||
// a &'static str for an arbitrary code, so skip
|
||||
}
|
||||
}
|
||||
|
||||
None
|
||||
}
|
||||
```
|
||||
|
||||
Note: For ISO codes that are in ECB rates but NOT in `CURRENCY_ALIASES`, we lose the ability to resolve them. This is acceptable because:
|
||||
1. `CURRENCY_ALIASES` already covers the 15 most common currencies
|
||||
2. The alternative (Box::leak) was leaking memory on every keystroke
|
||||
|
||||
- [ ] **Step 2: Update is_currency_alias**
|
||||
|
||||
No change needed — it already just calls `resolve_currency_code(alias).is_some()`.
|
||||
|
||||
- [ ] **Step 3: Update find_unit in units.rs**
|
||||
|
||||
In `crates/owlry-plugin-converter/src/units.rs`, replace lines 90-101:
|
||||
|
||||
```rust
|
||||
pub fn find_unit(alias: &str) -> Option<&'static str> {
|
||||
let lower = alias.to_lowercase();
|
||||
if let Some(&i) = ALIAS_MAP.get(&lower) {
|
||||
return Some(UNITS[i].symbol);
|
||||
}
|
||||
// Check currency — resolve_currency_code now returns &'static str directly
|
||||
currency::resolve_currency_code(&lower)
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Update convert_currency in units.rs**
|
||||
|
||||
In `crates/owlry-plugin-converter/src/units.rs`, update `convert_currency` (line 160). The `from_code` and `to_code` are now `&'static str`. HashMap lookups with `rates.rates.get(code)` work because `HashMap<String, f64>::get` accepts `&str` via `Borrow`:
|
||||
|
||||
```rust
|
||||
fn convert_currency(value: f64, from: &str, to: &str) -> Option<ConversionResult> {
|
||||
let rates = currency::get_rates()?;
|
||||
let from_code = currency::resolve_currency_code(from)?;
|
||||
let to_code = currency::resolve_currency_code(to)?;
|
||||
|
||||
let from_rate = if from_code == "EUR" {
|
||||
1.0
|
||||
} else {
|
||||
*rates.rates.get(from_code)?
|
||||
};
|
||||
let to_rate = if to_code == "EUR" {
|
||||
1.0
|
||||
} else {
|
||||
*rates.rates.get(to_code)?
|
||||
};
|
||||
|
||||
let result = value / from_rate * to_rate;
|
||||
Some(format_currency_result(result, to_code))
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Update convert_currency_common in units.rs**
|
||||
|
||||
In `crates/owlry-plugin-converter/src/units.rs`, update `convert_currency_common` (line 180). Change `from_code` handling:
|
||||
|
||||
```rust
|
||||
fn convert_currency_common(value: f64, from: &str) -> Vec<ConversionResult> {
|
||||
let rates = match currency::get_rates() {
|
||||
Some(r) => r,
|
||||
None => return vec![],
|
||||
};
|
||||
let from_code = match currency::resolve_currency_code(from) {
|
||||
Some(c) => c,
|
||||
None => return vec![],
|
||||
};
|
||||
|
||||
let targets = COMMON_TARGETS.get(&Category::Currency).unwrap();
|
||||
let from_rate = if from_code == "EUR" {
|
||||
1.0
|
||||
} else {
|
||||
match rates.rates.get(from_code) {
|
||||
Some(&r) => r,
|
||||
None => return vec![],
|
||||
}
|
||||
};
|
||||
|
||||
targets
|
||||
.iter()
|
||||
.filter(|&&sym| sym != from_code)
|
||||
.filter_map(|&sym| {
|
||||
let to_rate = if sym == "EUR" {
|
||||
1.0
|
||||
} else {
|
||||
*rates.rates.get(sym)?
|
||||
};
|
||||
let result = value / from_rate * to_rate;
|
||||
Some(format_currency_result(result, sym))
|
||||
})
|
||||
.take(5)
|
||||
.collect()
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 6: Update currency tests**
|
||||
|
||||
In `crates/owlry-plugin-converter/src/currency.rs`, update test assertions to use `&str` instead of `String`:
|
||||
|
||||
```rust
|
||||
#[test]
|
||||
fn test_resolve_currency_code_iso() {
|
||||
assert_eq!(resolve_currency_code("usd"), Some("USD"));
|
||||
assert_eq!(resolve_currency_code("EUR"), Some("EUR"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_resolve_currency_code_name() {
|
||||
assert_eq!(resolve_currency_code("dollar"), Some("USD"));
|
||||
assert_eq!(resolve_currency_code("euro"), Some("EUR"));
|
||||
assert_eq!(resolve_currency_code("pounds"), Some("GBP"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_resolve_currency_code_symbol() {
|
||||
assert_eq!(resolve_currency_code("$"), Some("USD"));
|
||||
assert_eq!(resolve_currency_code("€"), Some("EUR"));
|
||||
assert_eq!(resolve_currency_code("£"), Some("GBP"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_resolve_currency_unknown() {
|
||||
assert_eq!(resolve_currency_code("xyz"), None);
|
||||
}
|
||||
```
|
||||
|
||||
### 4b. Fix bookmarks temp file race condition
|
||||
|
||||
- [ ] **Step 7: Use PID-based temp filenames**
|
||||
|
||||
In `crates/owlry-plugin-bookmarks/src/lib.rs`, replace the `read_firefox_bookmarks` method. Change lines 318-319 and the corresponding favicons temp path:
|
||||
|
||||
```rust
|
||||
fn read_firefox_bookmarks(places_path: &PathBuf, items: &mut Vec<PluginItem>) {
|
||||
let temp_dir = std::env::temp_dir();
|
||||
let pid = std::process::id();
|
||||
let temp_db = temp_dir.join(format!("owlry_places_{}.sqlite", pid));
|
||||
|
||||
// Copy database to temp location to avoid locking issues
|
||||
if fs::copy(places_path, &temp_db).is_err() {
|
||||
return;
|
||||
}
|
||||
|
||||
// Also copy WAL file if it exists
|
||||
let wal_path = places_path.with_extension("sqlite-wal");
|
||||
if wal_path.exists() {
|
||||
let temp_wal = temp_db.with_extension("sqlite-wal");
|
||||
let _ = fs::copy(&wal_path, &temp_wal);
|
||||
}
|
||||
|
||||
// Copy favicons database if available
|
||||
let favicons_path = Self::firefox_favicons_path(places_path);
|
||||
let temp_favicons = temp_dir.join(format!("owlry_favicons_{}.sqlite", pid));
|
||||
if let Some(ref fp) = favicons_path {
|
||||
let _ = fs::copy(fp, &temp_favicons);
|
||||
let fav_wal = fp.with_extension("sqlite-wal");
|
||||
if fav_wal.exists() {
|
||||
let _ = fs::copy(&fav_wal, temp_favicons.with_extension("sqlite-wal"));
|
||||
}
|
||||
}
|
||||
|
||||
let cache_dir = Self::ensure_favicon_cache_dir();
|
||||
|
||||
// Read bookmarks from places.sqlite
|
||||
let bookmarks = Self::fetch_firefox_bookmarks(&temp_db, &temp_favicons, cache_dir.as_ref());
|
||||
|
||||
// Clean up temp files
|
||||
let _ = fs::remove_file(&temp_db);
|
||||
let _ = fs::remove_file(temp_db.with_extension("sqlite-wal"));
|
||||
let _ = fs::remove_file(&temp_favicons);
|
||||
let _ = fs::remove_file(temp_favicons.with_extension("sqlite-wal"));
|
||||
|
||||
// ... rest of method unchanged (the for loop adding items)
|
||||
```
|
||||
|
||||
### 4c. Fix bookmarks background refresh never updating state
|
||||
|
||||
- [ ] **Step 8: Change BookmarksState to use Arc<Mutex<Vec<PluginItem>>>**
|
||||
|
||||
In `crates/owlry-plugin-bookmarks/src/lib.rs`, add `use std::sync::Mutex;` to imports (it's already importing `Arc` and `AtomicBool`).
|
||||
|
||||
Change the struct:
|
||||
|
||||
```rust
|
||||
struct BookmarksState {
|
||||
/// Cached bookmark items (shared with background thread)
|
||||
items: Arc<Mutex<Vec<PluginItem>>>,
|
||||
/// Flag to prevent concurrent background loads
|
||||
loading: Arc<AtomicBool>,
|
||||
}
|
||||
|
||||
impl BookmarksState {
|
||||
fn new() -> Self {
|
||||
Self {
|
||||
items: Arc::new(Mutex::new(Vec::new())),
|
||||
loading: Arc::new(AtomicBool::new(false)),
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 9: Update load_bookmarks to write through Arc<Mutex>**
|
||||
|
||||
Update the `load_bookmarks` method:
|
||||
|
||||
```rust
|
||||
fn load_bookmarks(&self) {
|
||||
// Fast path: load from cache immediately if items are empty
|
||||
{
|
||||
let mut items = self.items.lock().unwrap_or_else(|e| e.into_inner());
|
||||
if items.is_empty() {
|
||||
*items = Self::load_cached_bookmarks();
|
||||
}
|
||||
}
|
||||
|
||||
// Don't start another background load if one is already running
|
||||
if self.loading.swap(true, Ordering::SeqCst) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Spawn background thread to refresh bookmarks
|
||||
let loading = self.loading.clone();
|
||||
let items_ref = self.items.clone();
|
||||
thread::spawn(move || {
|
||||
let mut new_items = Vec::new();
|
||||
|
||||
// Load Chrome/Chromium bookmarks (fast - just JSON parsing)
|
||||
for path in Self::chromium_bookmark_paths() {
|
||||
if path.exists() {
|
||||
Self::read_chrome_bookmarks_static(&path, &mut new_items);
|
||||
}
|
||||
}
|
||||
|
||||
// Load Firefox bookmarks with favicons (synchronous with rusqlite)
|
||||
for path in Self::firefox_places_paths() {
|
||||
Self::read_firefox_bookmarks(&path, &mut new_items);
|
||||
}
|
||||
|
||||
// Save to cache for next startup
|
||||
Self::save_cached_bookmarks(&new_items);
|
||||
|
||||
// Update shared state so next refresh returns fresh data
|
||||
if let Ok(mut items) = items_ref.lock() {
|
||||
*items = new_items;
|
||||
}
|
||||
|
||||
loading.store(false, Ordering::SeqCst);
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
Note: `load_bookmarks` now takes `&self` instead of `&mut self`.
|
||||
|
||||
- [ ] **Step 10: Update provider_refresh to read from Arc<Mutex>**
|
||||
|
||||
Update the `provider_refresh` function:
|
||||
|
||||
```rust
|
||||
extern "C" fn provider_refresh(handle: ProviderHandle) -> RVec<PluginItem> {
|
||||
if handle.ptr.is_null() {
|
||||
return RVec::new();
|
||||
}
|
||||
|
||||
// SAFETY: We created this handle from Box<BookmarksState>
|
||||
let state = unsafe { &*(handle.ptr as *const BookmarksState) };
|
||||
|
||||
// Load bookmarks
|
||||
state.load_bookmarks();
|
||||
|
||||
// Return items
|
||||
let items = state.items.lock().unwrap_or_else(|e| e.into_inner());
|
||||
items.to_vec().into()
|
||||
}
|
||||
```
|
||||
|
||||
Note: Uses `&*` (shared ref) instead of `&mut *` since `load_bookmarks` now takes `&self`.
|
||||
|
||||
- [ ] **Step 11: Build and test plugins**
|
||||
|
||||
Run: `cd /home/cnachtigall/ssd/git/archive/owlibou/owlry-plugins && cargo check && cargo test`
|
||||
Expected: all checks pass, all existing tests pass
|
||||
|
||||
- [ ] **Step 12: Commit Tier 4**
|
||||
|
||||
```bash
|
||||
cd /home/cnachtigall/ssd/git/archive/owlibou/owlry-plugins
|
||||
git add crates/owlry-plugin-converter/src/currency.rs crates/owlry-plugin-converter/src/units.rs crates/owlry-plugin-bookmarks/src/lib.rs
|
||||
git commit -m "fix: critical — eliminate Box::leak in converter, secure temp files, fix background refresh"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 5: Tier 5 — Quality fixes (owlry-plugins)
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-plugin-ssh/Cargo.toml`
|
||||
- Modify: `crates/owlry-plugin-ssh/src/lib.rs:17-48`
|
||||
- Modify: `crates/owlry-plugin-websearch/Cargo.toml`
|
||||
- Modify: `crates/owlry-plugin-websearch/src/lib.rs:46-76,174-177`
|
||||
- Modify: `crates/owlry-plugin-emoji/src/lib.rs:34-37,463-481`
|
||||
- Modify: `crates/owlry-plugin-calculator/src/lib.rs:139`
|
||||
- Modify: `crates/owlry-plugin-converter/src/lib.rs:95`
|
||||
|
||||
All paths relative to `/home/cnachtigall/ssd/git/archive/owlibou/owlry-plugins`.
|
||||
|
||||
### 5a. SSH plugin: read terminal from config
|
||||
|
||||
- [ ] **Step 1: Add toml dependency to SSH plugin**
|
||||
|
||||
In `crates/owlry-plugin-ssh/Cargo.toml`, add:
|
||||
|
||||
```toml
|
||||
# TOML config parsing
|
||||
toml = "0.8"
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Add config loading and update SshState::new**
|
||||
|
||||
In `crates/owlry-plugin-ssh/src/lib.rs`, add `use std::fs;` to imports, remove the `DEFAULT_TERMINAL` constant, and update `SshState::new`:
|
||||
|
||||
```rust
|
||||
impl SshState {
|
||||
fn new() -> Self {
|
||||
let terminal = Self::load_terminal_from_config();
|
||||
|
||||
Self {
|
||||
items: Vec::new(),
|
||||
terminal_command: terminal,
|
||||
}
|
||||
}
|
||||
|
||||
fn load_terminal_from_config() -> String {
|
||||
// Try [plugins.ssh] in config.toml
|
||||
let config_path = dirs::config_dir().map(|d| d.join("owlry").join("config.toml"));
|
||||
if let Some(content) = config_path.and_then(|p| fs::read_to_string(p).ok())
|
||||
&& let Ok(toml) = content.parse::<toml::Table>()
|
||||
{
|
||||
if let Some(plugins) = toml.get("plugins").and_then(|v| v.as_table())
|
||||
&& let Some(ssh) = plugins.get("ssh").and_then(|v| v.as_table())
|
||||
&& let Some(terminal) = ssh.get("terminal").and_then(|v| v.as_str())
|
||||
{
|
||||
return terminal.to_string();
|
||||
}
|
||||
}
|
||||
|
||||
// Fall back to $TERMINAL env var
|
||||
if let Ok(terminal) = std::env::var("TERMINAL") {
|
||||
return terminal;
|
||||
}
|
||||
|
||||
// Last resort
|
||||
"xdg-terminal-exec".to_string()
|
||||
}
|
||||
```
|
||||
|
||||
### 5b. WebSearch plugin: read engine from config
|
||||
|
||||
- [ ] **Step 3: Add dependencies to websearch plugin**
|
||||
|
||||
In `crates/owlry-plugin-websearch/Cargo.toml`, add:
|
||||
|
||||
```toml
|
||||
# TOML config parsing
|
||||
toml = "0.8"
|
||||
|
||||
# XDG directories for config
|
||||
dirs = "5.0"
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Add config loading and update provider_init**
|
||||
|
||||
In `crates/owlry-plugin-websearch/src/lib.rs`, add `use std::fs;` to imports. Add a config loading function and update `provider_init`:
|
||||
|
||||
```rust
|
||||
fn load_engine_from_config() -> String {
|
||||
let config_path = dirs::config_dir().map(|d| d.join("owlry").join("config.toml"));
|
||||
if let Some(content) = config_path.and_then(|p| fs::read_to_string(p).ok())
|
||||
&& let Ok(toml) = content.parse::<toml::Table>()
|
||||
{
|
||||
if let Some(plugins) = toml.get("plugins").and_then(|v| v.as_table())
|
||||
&& let Some(websearch) = plugins.get("websearch").and_then(|v| v.as_table())
|
||||
&& let Some(engine) = websearch.get("engine").and_then(|v| v.as_str())
|
||||
{
|
||||
return engine.to_string();
|
||||
}
|
||||
}
|
||||
DEFAULT_ENGINE.to_string()
|
||||
}
|
||||
|
||||
extern "C" fn provider_init(_provider_id: RStr<'_>) -> ProviderHandle {
|
||||
let engine = load_engine_from_config();
|
||||
let state = Box::new(WebSearchState::with_engine(&engine));
|
||||
ProviderHandle::from_box(state)
|
||||
}
|
||||
```
|
||||
|
||||
Remove the TODO comment from the old `provider_init`.
|
||||
|
||||
### 5c. Emoji plugin: build items once at init
|
||||
|
||||
- [ ] **Step 5: Move load_emojis to constructor**
|
||||
|
||||
In `crates/owlry-plugin-emoji/src/lib.rs`, change `EmojiState::new` to call `load_emojis`:
|
||||
|
||||
```rust
|
||||
impl EmojiState {
|
||||
fn new() -> Self {
|
||||
let mut state = Self { items: Vec::new() };
|
||||
state.load_emojis();
|
||||
state
|
||||
}
|
||||
```
|
||||
|
||||
Update `provider_refresh` to just return the cached items without reloading:
|
||||
|
||||
```rust
|
||||
extern "C" fn provider_refresh(handle: ProviderHandle) -> RVec<PluginItem> {
|
||||
if handle.ptr.is_null() {
|
||||
return RVec::new();
|
||||
}
|
||||
|
||||
// SAFETY: We created this handle from Box<EmojiState>
|
||||
let state = unsafe { &*(handle.ptr as *const EmojiState) };
|
||||
|
||||
// Return cached items (loaded once at init)
|
||||
state.items.to_vec().into()
|
||||
}
|
||||
```
|
||||
|
||||
Note: Uses `&*` (shared ref) since we're only reading.
|
||||
|
||||
### 5d. Calculator/Converter: safer shell commands
|
||||
|
||||
- [ ] **Step 6: Fix calculator command**
|
||||
|
||||
In `crates/owlry-plugin-calculator/src/lib.rs`, in `evaluate_expression` (around line 139), replace:
|
||||
|
||||
```rust
|
||||
// Old:
|
||||
format!("sh -c 'echo -n \"{}\" | wl-copy'", result_str)
|
||||
|
||||
// New:
|
||||
format!("printf '%s' '{}' | wl-copy", result_str.replace('\'', "'\\''"))
|
||||
```
|
||||
|
||||
- [ ] **Step 7: Fix converter command**
|
||||
|
||||
In `crates/owlry-plugin-converter/src/lib.rs`, in `provider_query` (around line 95), replace:
|
||||
|
||||
```rust
|
||||
// Old:
|
||||
format!("sh -c 'echo -n \"{}\" | wl-copy'", r.raw_value)
|
||||
|
||||
// New:
|
||||
format!("printf '%s' '{}' | wl-copy", r.raw_value.replace('\'', "'\\''"))
|
||||
```
|
||||
|
||||
- [ ] **Step 8: Build and test all plugins**
|
||||
|
||||
Run: `cd /home/cnachtigall/ssd/git/archive/owlibou/owlry-plugins && cargo check && cargo test`
|
||||
Expected: all checks pass, all existing tests pass
|
||||
|
||||
- [ ] **Step 9: Commit Tier 5**
|
||||
|
||||
```bash
|
||||
cd /home/cnachtigall/ssd/git/archive/owlibou/owlry-plugins
|
||||
git add crates/owlry-plugin-ssh/Cargo.toml crates/owlry-plugin-ssh/src/lib.rs \
|
||||
crates/owlry-plugin-websearch/Cargo.toml crates/owlry-plugin-websearch/src/lib.rs \
|
||||
crates/owlry-plugin-emoji/src/lib.rs \
|
||||
crates/owlry-plugin-calculator/src/lib.rs \
|
||||
crates/owlry-plugin-converter/src/lib.rs
|
||||
git commit -m "fix: quality — config-based terminal/engine, emoji init perf, safer shell commands"
|
||||
```
|
||||
810
docs/superpowers/plans/2026-03-26-runtime-integration.md
Normal file
810
docs/superpowers/plans/2026-03-26-runtime-integration.md
Normal file
@@ -0,0 +1,810 @@
|
||||
# Script Runtime Integration Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Enable the owlry-core daemon to discover and load Lua/Rune user plugins from `~/.config/owlry/plugins/`, with automatic hot-reload on file changes.
|
||||
|
||||
**Architecture:** Fix ABI mismatches between core and runtimes, wire `LoadedRuntime` into `ProviderManager::new_with_config()`, add filesystem watcher for automatic plugin reload. Runtimes are external `.so` libraries loaded from `/usr/lib/owlry/runtimes/`.
|
||||
|
||||
**Tech Stack:** Rust 1.90+, notify 7, notify-debouncer-mini 0.5, libloading 0.8
|
||||
|
||||
**Repos:**
|
||||
- Core: `/home/cnachtigall/ssd/git/archive/owlibou/owlry`
|
||||
- Plugins (docs only): `/home/cnachtigall/ssd/git/archive/owlibou/owlry-plugins`
|
||||
|
||||
---
|
||||
|
||||
## Task 1: Fix Lua RuntimeInfo ABI and vtable init signature
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-lua/src/lib.rs:42-74,260-279,322-336`
|
||||
- Modify: `crates/owlry-rune/src/lib.rs:42-46,73-84,90-95,97-146,215-229`
|
||||
- Modify: `crates/owlry-core/src/plugins/runtime_loader.rs:55-68,84-146,267-277`
|
||||
|
||||
### 1a. Shrink Lua RuntimeInfo to 2 fields
|
||||
|
||||
- [ ] **Step 1: Update RuntimeInfo struct and runtime_info() in owlry-lua**
|
||||
|
||||
In `crates/owlry-lua/src/lib.rs`:
|
||||
|
||||
Remove the `LUA_RUNTIME_API_VERSION` constant (line 43).
|
||||
|
||||
Replace the `RuntimeInfo` struct (lines 67-74):
|
||||
|
||||
```rust
|
||||
/// Runtime info returned by the runtime
|
||||
#[repr(C)]
|
||||
pub struct RuntimeInfo {
|
||||
pub name: RString,
|
||||
pub version: RString,
|
||||
}
|
||||
```
|
||||
|
||||
Replace `runtime_info()` (lines 260-268):
|
||||
|
||||
```rust
|
||||
extern "C" fn runtime_info() -> RuntimeInfo {
|
||||
RuntimeInfo {
|
||||
name: RString::from("Lua"),
|
||||
version: RString::from(env!("CARGO_PKG_VERSION")),
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Remove unused constants `RUNTIME_ID` and `RUNTIME_DESCRIPTION` (lines 37, 40) if no longer referenced.
|
||||
|
||||
### 1b. Add owlry_version parameter to vtable init
|
||||
|
||||
- [ ] **Step 2: Update ScriptRuntimeVTable in core**
|
||||
|
||||
In `crates/owlry-core/src/plugins/runtime_loader.rs`, change the `init` field (line 59):
|
||||
|
||||
```rust
|
||||
pub struct ScriptRuntimeVTable {
|
||||
pub info: extern "C" fn() -> RuntimeInfo,
|
||||
pub init: extern "C" fn(plugins_dir: RStr<'_>, owlry_version: RStr<'_>) -> RuntimeHandle,
|
||||
pub providers: extern "C" fn(handle: RuntimeHandle) -> RVec<ScriptProviderInfo>,
|
||||
pub refresh: extern "C" fn(handle: RuntimeHandle, provider_id: RStr<'_>) -> RVec<PluginItem>,
|
||||
pub query: extern "C" fn(
|
||||
handle: RuntimeHandle,
|
||||
provider_id: RStr<'_>,
|
||||
query: RStr<'_>,
|
||||
) -> RVec<PluginItem>,
|
||||
pub drop: extern "C" fn(handle: RuntimeHandle),
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Update LoadedRuntime to pass version**
|
||||
|
||||
In `crates/owlry-core/src/plugins/runtime_loader.rs`, update `load_lua`, `load_rune`, and `load_from_path` to accept and pass the version:
|
||||
|
||||
```rust
|
||||
impl LoadedRuntime {
|
||||
pub fn load_lua(plugins_dir: &Path, owlry_version: &str) -> PluginResult<Self> {
|
||||
Self::load_from_path(
|
||||
"Lua",
|
||||
&PathBuf::from(SYSTEM_RUNTIMES_DIR).join("liblua.so"),
|
||||
b"owlry_lua_runtime_vtable",
|
||||
plugins_dir,
|
||||
owlry_version,
|
||||
)
|
||||
}
|
||||
|
||||
fn load_from_path(
|
||||
name: &'static str,
|
||||
library_path: &Path,
|
||||
vtable_symbol: &[u8],
|
||||
plugins_dir: &Path,
|
||||
owlry_version: &str,
|
||||
) -> PluginResult<Self> {
|
||||
// ... existing library loading code ...
|
||||
|
||||
// Initialize the runtime with version
|
||||
let plugins_dir_str = plugins_dir.to_string_lossy();
|
||||
let handle = (vtable.init)(
|
||||
RStr::from_str(&plugins_dir_str),
|
||||
RStr::from_str(owlry_version),
|
||||
);
|
||||
|
||||
// ... rest unchanged ...
|
||||
}
|
||||
}
|
||||
|
||||
impl LoadedRuntime {
|
||||
pub fn load_rune(plugins_dir: &Path, owlry_version: &str) -> PluginResult<Self> {
|
||||
Self::load_from_path(
|
||||
"Rune",
|
||||
&PathBuf::from(SYSTEM_RUNTIMES_DIR).join("librune.so"),
|
||||
b"owlry_rune_runtime_vtable",
|
||||
plugins_dir,
|
||||
owlry_version,
|
||||
)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Update Lua runtime_init to accept version**
|
||||
|
||||
In `crates/owlry-lua/src/lib.rs`, update `runtime_init` (line 270) and the vtable:
|
||||
|
||||
```rust
|
||||
extern "C" fn runtime_init(plugins_dir: RStr<'_>, owlry_version: RStr<'_>) -> RuntimeHandle {
|
||||
let plugins_dir = PathBuf::from(plugins_dir.as_str());
|
||||
let mut state = Box::new(LuaRuntimeState::new(plugins_dir));
|
||||
|
||||
state.discover_and_load(owlry_version.as_str());
|
||||
|
||||
RuntimeHandle::from_box(state)
|
||||
}
|
||||
```
|
||||
|
||||
Update the `LuaRuntimeVTable` struct `init` field to match:
|
||||
```rust
|
||||
pub init: extern "C" fn(plugins_dir: RStr<'_>, owlry_version: RStr<'_>) -> RuntimeHandle,
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Update Rune runtime_init to accept version**
|
||||
|
||||
In `crates/owlry-rune/src/lib.rs`, update `runtime_init` (line 97) and the vtable:
|
||||
|
||||
```rust
|
||||
extern "C" fn runtime_init(plugins_dir: RStr<'_>, owlry_version: RStr<'_>) -> RuntimeHandle {
|
||||
let _ = env_logger::try_init();
|
||||
|
||||
let plugins_dir = PathBuf::from(plugins_dir.as_str());
|
||||
let _version = owlry_version.as_str();
|
||||
log::info!(
|
||||
"Initializing Rune runtime with plugins from: {}",
|
||||
plugins_dir.display()
|
||||
);
|
||||
|
||||
// ... rest unchanged — Rune doesn't currently do version checking ...
|
||||
```
|
||||
|
||||
Update the `RuneRuntimeVTable` struct `init` field:
|
||||
```rust
|
||||
pub init: extern "C" fn(plugins_dir: RStr<'_>, owlry_version: RStr<'_>) -> RuntimeHandle,
|
||||
```
|
||||
|
||||
- [ ] **Step 6: Build all three crates**
|
||||
|
||||
Run: `cargo check -p owlry-core && cargo check -p owlry-lua && cargo check -p owlry-rune`
|
||||
Expected: all pass
|
||||
|
||||
- [ ] **Step 7: Run tests**
|
||||
|
||||
Run: `cargo test -p owlry-core && cargo test -p owlry-lua && cargo test -p owlry-rune`
|
||||
Expected: all pass
|
||||
|
||||
- [ ] **Step 8: Commit**
|
||||
|
||||
```bash
|
||||
git add crates/owlry-core/src/plugins/runtime_loader.rs \
|
||||
crates/owlry-lua/src/lib.rs \
|
||||
crates/owlry-rune/src/lib.rs
|
||||
git commit -m "fix: align runtime ABI — shrink Lua RuntimeInfo, pass owlry_version to init"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 2: Change default entry points to `main` and add alias
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-lua/src/manifest.rs:52-54`
|
||||
- Modify: `crates/owlry-rune/src/manifest.rs:36-38,29`
|
||||
|
||||
- [ ] **Step 1: Update Lua manifest default entry**
|
||||
|
||||
In `crates/owlry-lua/src/manifest.rs`, change `default_entry()` (line 52):
|
||||
|
||||
```rust
|
||||
fn default_entry() -> String {
|
||||
"main.lua".to_string()
|
||||
}
|
||||
```
|
||||
|
||||
Add `serde(alias)` to the `entry` field in `PluginInfo` (line 45):
|
||||
|
||||
```rust
|
||||
#[serde(default = "default_entry", alias = "entry_point")]
|
||||
pub entry: String,
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Update Rune manifest default entry**
|
||||
|
||||
In `crates/owlry-rune/src/manifest.rs`, change `default_entry()` (line 36):
|
||||
|
||||
```rust
|
||||
fn default_entry() -> String {
|
||||
"main.rn".to_string()
|
||||
}
|
||||
```
|
||||
|
||||
Add `serde(alias)` to the `entry` field in `PluginInfo` (line 29):
|
||||
|
||||
```rust
|
||||
#[serde(default = "default_entry", alias = "entry_point")]
|
||||
pub entry: String,
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Update tests that reference init.lua/init.rn**
|
||||
|
||||
In `crates/owlry-lua/src/manifest.rs` test `test_parse_minimal_manifest`:
|
||||
```rust
|
||||
assert_eq!(manifest.plugin.entry, "main.lua");
|
||||
```
|
||||
|
||||
In `crates/owlry-lua/src/loader.rs` test `create_test_plugin`:
|
||||
```rust
|
||||
fs::write(plugin_dir.join("main.lua"), "-- empty plugin").unwrap();
|
||||
```
|
||||
|
||||
In `crates/owlry-rune/src/manifest.rs` test `test_parse_minimal_manifest`:
|
||||
```rust
|
||||
assert_eq!(manifest.plugin.entry, "main.rn");
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Build and test**
|
||||
|
||||
Run: `cargo test -p owlry-lua && cargo test -p owlry-rune`
|
||||
Expected: all pass
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add crates/owlry-lua/src/manifest.rs crates/owlry-lua/src/loader.rs \
|
||||
crates/owlry-rune/src/manifest.rs
|
||||
git commit -m "feat: change default entry points to main.lua/main.rn, add entry_point alias"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 3: Wire runtime loading into ProviderManager
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-core/src/providers/mod.rs:106-119,173-224`
|
||||
- Modify: `crates/owlry-core/src/plugins/runtime_loader.rs:13` (remove allow dead_code)
|
||||
|
||||
- [ ] **Step 1: Add runtimes field to ProviderManager**
|
||||
|
||||
In `crates/owlry-core/src/providers/mod.rs`, add import and field:
|
||||
|
||||
```rust
|
||||
use crate::plugins::runtime_loader::LoadedRuntime;
|
||||
```
|
||||
|
||||
Add to the `ProviderManager` struct (after `matcher` field):
|
||||
|
||||
```rust
|
||||
pub struct ProviderManager {
|
||||
providers: Vec<Box<dyn Provider>>,
|
||||
static_native_providers: Vec<NativeProvider>,
|
||||
dynamic_providers: Vec<NativeProvider>,
|
||||
widget_providers: Vec<NativeProvider>,
|
||||
matcher: SkimMatcherV2,
|
||||
/// Loaded script runtimes (Lua, Rune) — must stay alive to keep Library handles
|
||||
runtimes: Vec<LoadedRuntime>,
|
||||
/// Type IDs of providers that came from script runtimes (for hot-reload removal)
|
||||
runtime_type_ids: std::collections::HashSet<String>,
|
||||
}
|
||||
```
|
||||
|
||||
Update `ProviderManager::new()` to initialize the new fields:
|
||||
|
||||
```rust
|
||||
let mut manager = Self {
|
||||
providers: core_providers,
|
||||
static_native_providers: Vec::new(),
|
||||
dynamic_providers: Vec::new(),
|
||||
widget_providers: Vec::new(),
|
||||
matcher: SkimMatcherV2::default(),
|
||||
runtimes: Vec::new(),
|
||||
runtime_type_ids: std::collections::HashSet::new(),
|
||||
};
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Add runtime loading to new_with_config**
|
||||
|
||||
In `ProviderManager::new_with_config()`, after the native plugin loading block (after line 221) and before `Self::new(core_providers, native_providers)` (line 223), add runtime loading:
|
||||
|
||||
```rust
|
||||
// Load script runtimes (Lua, Rune) for user plugins
|
||||
let mut runtime_providers: Vec<Box<dyn Provider>> = Vec::new();
|
||||
let mut runtimes: Vec<LoadedRuntime> = Vec::new();
|
||||
let mut runtime_type_ids = std::collections::HashSet::new();
|
||||
let owlry_version = env!("CARGO_PKG_VERSION");
|
||||
|
||||
if let Some(plugins_dir) = crate::paths::plugins_dir() {
|
||||
// Try Lua runtime
|
||||
match LoadedRuntime::load_lua(&plugins_dir, owlry_version) {
|
||||
Ok(rt) => {
|
||||
info!("Loaded Lua runtime with {} provider(s)", rt.providers().len());
|
||||
for provider in rt.create_providers() {
|
||||
let type_id = format!("{}", provider.provider_type());
|
||||
runtime_type_ids.insert(type_id);
|
||||
runtime_providers.push(provider);
|
||||
}
|
||||
runtimes.push(rt);
|
||||
}
|
||||
Err(e) => {
|
||||
info!("Lua runtime not available: {}", e);
|
||||
}
|
||||
}
|
||||
|
||||
// Try Rune runtime
|
||||
match LoadedRuntime::load_rune(&plugins_dir, owlry_version) {
|
||||
Ok(rt) => {
|
||||
info!("Loaded Rune runtime with {} provider(s)", rt.providers().len());
|
||||
for provider in rt.create_providers() {
|
||||
let type_id = format!("{}", provider.provider_type());
|
||||
runtime_type_ids.insert(type_id);
|
||||
runtime_providers.push(provider);
|
||||
}
|
||||
runtimes.push(rt);
|
||||
}
|
||||
Err(e) => {
|
||||
info!("Rune runtime not available: {}", e);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
let mut manager = Self::new(core_providers, native_providers);
|
||||
manager.runtimes = runtimes;
|
||||
manager.runtime_type_ids = runtime_type_ids;
|
||||
|
||||
// Add runtime providers to the core providers list
|
||||
for provider in runtime_providers {
|
||||
info!("Registered runtime provider: {}", provider.name());
|
||||
manager.providers.push(provider);
|
||||
}
|
||||
|
||||
// Refresh runtime providers
|
||||
for provider in &mut manager.providers {
|
||||
// Only refresh the ones we just added (runtime providers)
|
||||
// They need an initial refresh to populate items
|
||||
}
|
||||
manager.refresh_all();
|
||||
|
||||
manager
|
||||
```
|
||||
|
||||
Note: This replaces the current `Self::new(core_providers, native_providers)` return. The `refresh_all()` at the end of `new()` will be called, plus we call it again — but that's fine since refresh is idempotent. Actually, `new()` already calls `refresh_all()`, so we should remove the duplicate. Let me adjust:
|
||||
|
||||
The cleaner approach is to construct the manager via `Self::new()` which calls `refresh_all()`, then set the runtime fields and add providers, then call `refresh_all()` once more for the newly added runtime providers. Or better — add runtime providers to `core_providers` before calling `new()`:
|
||||
|
||||
```rust
|
||||
// Merge runtime providers into core providers
|
||||
let mut all_core_providers = core_providers;
|
||||
for provider in runtime_providers {
|
||||
info!("Registered runtime provider: {}", provider.name());
|
||||
all_core_providers.push(provider);
|
||||
}
|
||||
|
||||
let mut manager = Self::new(all_core_providers, native_providers);
|
||||
manager.runtimes = runtimes;
|
||||
manager.runtime_type_ids = runtime_type_ids;
|
||||
manager
|
||||
```
|
||||
|
||||
This way `new()` handles the single `refresh_all()` call.
|
||||
|
||||
- [ ] **Step 3: Remove allow(dead_code) from runtime_loader**
|
||||
|
||||
In `crates/owlry-core/src/plugins/runtime_loader.rs`, remove `#![allow(dead_code)]` (line 13).
|
||||
|
||||
Fix any resulting dead code warnings by removing unused `#[allow(dead_code)]` attributes on individual items that are now actually used, or adding targeted `#[allow(dead_code)]` only on truly unused items.
|
||||
|
||||
- [ ] **Step 4: Build and test**
|
||||
|
||||
Run: `cargo check -p owlry-core && cargo test -p owlry-core`
|
||||
Expected: all pass. May see info logs about runtimes loading (if installed on the build machine).
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add crates/owlry-core/src/providers/mod.rs \
|
||||
crates/owlry-core/src/plugins/runtime_loader.rs
|
||||
git commit -m "feat: wire script runtime loading into daemon ProviderManager"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 4: Filesystem watcher for hot-reload
|
||||
|
||||
**Files:**
|
||||
- Create: `crates/owlry-core/src/plugins/watcher.rs`
|
||||
- Modify: `crates/owlry-core/src/plugins/mod.rs:23-28` (add module)
|
||||
- Modify: `crates/owlry-core/src/providers/mod.rs` (add reload method)
|
||||
- Modify: `crates/owlry-core/src/server.rs:59-78` (start watcher)
|
||||
- Modify: `crates/owlry-core/Cargo.toml` (add deps)
|
||||
|
||||
- [ ] **Step 1: Add dependencies**
|
||||
|
||||
In `crates/owlry-core/Cargo.toml`, add to `[dependencies]`:
|
||||
|
||||
```toml
|
||||
# Filesystem watching for plugin hot-reload
|
||||
notify = "7"
|
||||
notify-debouncer-mini = "0.5"
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Add reload_runtimes method to ProviderManager**
|
||||
|
||||
In `crates/owlry-core/src/providers/mod.rs`, add a method:
|
||||
|
||||
```rust
|
||||
/// Reload all script runtime providers (called by filesystem watcher)
|
||||
pub fn reload_runtimes(&mut self) {
|
||||
// Remove old runtime providers from the core providers list
|
||||
self.providers.retain(|p| {
|
||||
let type_str = format!("{}", p.provider_type());
|
||||
!self.runtime_type_ids.contains(&type_str)
|
||||
});
|
||||
|
||||
// Drop old runtimes
|
||||
self.runtimes.clear();
|
||||
self.runtime_type_ids.clear();
|
||||
|
||||
let owlry_version = env!("CARGO_PKG_VERSION");
|
||||
let plugins_dir = match crate::paths::plugins_dir() {
|
||||
Some(d) => d,
|
||||
None => return,
|
||||
};
|
||||
|
||||
// Reload Lua runtime
|
||||
match LoadedRuntime::load_lua(&plugins_dir, owlry_version) {
|
||||
Ok(rt) => {
|
||||
info!("Reloaded Lua runtime with {} provider(s)", rt.providers().len());
|
||||
for provider in rt.create_providers() {
|
||||
let type_id = format!("{}", provider.provider_type());
|
||||
self.runtime_type_ids.insert(type_id);
|
||||
self.providers.push(provider);
|
||||
}
|
||||
self.runtimes.push(rt);
|
||||
}
|
||||
Err(e) => {
|
||||
info!("Lua runtime not available on reload: {}", e);
|
||||
}
|
||||
}
|
||||
|
||||
// Reload Rune runtime
|
||||
match LoadedRuntime::load_rune(&plugins_dir, owlry_version) {
|
||||
Ok(rt) => {
|
||||
info!("Reloaded Rune runtime with {} provider(s)", rt.providers().len());
|
||||
for provider in rt.create_providers() {
|
||||
let type_id = format!("{}", provider.provider_type());
|
||||
self.runtime_type_ids.insert(type_id);
|
||||
self.providers.push(provider);
|
||||
}
|
||||
self.runtimes.push(rt);
|
||||
}
|
||||
Err(e) => {
|
||||
info!("Rune runtime not available on reload: {}", e);
|
||||
}
|
||||
}
|
||||
|
||||
// Refresh the newly added providers
|
||||
for provider in &mut self.providers {
|
||||
provider.refresh();
|
||||
}
|
||||
|
||||
info!("Runtime reload complete");
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Create the watcher module**
|
||||
|
||||
Create `crates/owlry-core/src/plugins/watcher.rs`:
|
||||
|
||||
```rust
|
||||
//! Filesystem watcher for user plugin hot-reload
|
||||
//!
|
||||
//! Watches `~/.config/owlry/plugins/` for changes and triggers
|
||||
//! runtime reload when plugin files are modified.
|
||||
|
||||
use std::path::PathBuf;
|
||||
use std::sync::{Arc, RwLock};
|
||||
use std::thread;
|
||||
use std::time::Duration;
|
||||
|
||||
use log::{info, warn};
|
||||
use notify_debouncer_mini::{DebouncedEventKind, new_debouncer};
|
||||
|
||||
use crate::providers::ProviderManager;
|
||||
|
||||
/// Start watching the user plugins directory for changes.
|
||||
///
|
||||
/// Spawns a background thread that monitors the directory and triggers
|
||||
/// a full runtime reload on any file change. Returns immediately.
|
||||
///
|
||||
/// If the plugins directory doesn't exist or the watcher fails to start,
|
||||
/// logs a warning and returns without spawning a thread.
|
||||
pub fn start_watching(pm: Arc<RwLock<ProviderManager>>) {
|
||||
let plugins_dir = match crate::paths::plugins_dir() {
|
||||
Some(d) => d,
|
||||
None => {
|
||||
info!("No plugins directory configured, skipping file watcher");
|
||||
return;
|
||||
}
|
||||
};
|
||||
|
||||
if !plugins_dir.exists() {
|
||||
// Create the directory so the watcher has something to watch
|
||||
if std::fs::create_dir_all(&plugins_dir).is_err() {
|
||||
warn!("Failed to create plugins directory: {}", plugins_dir.display());
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
thread::spawn(move || {
|
||||
if let Err(e) = watch_loop(&plugins_dir, &pm) {
|
||||
warn!("Plugin watcher stopped: {}", e);
|
||||
}
|
||||
});
|
||||
|
||||
info!("Plugin file watcher started for {}", plugins_dir.display());
|
||||
}
|
||||
|
||||
fn watch_loop(
|
||||
plugins_dir: &PathBuf,
|
||||
pm: &Arc<RwLock<ProviderManager>>,
|
||||
) -> Result<(), Box<dyn std::error::Error>> {
|
||||
let (tx, rx) = std::sync::mpsc::channel();
|
||||
|
||||
let mut debouncer = new_debouncer(Duration::from_millis(500), tx)?;
|
||||
|
||||
debouncer
|
||||
.watcher()
|
||||
.watch(plugins_dir.as_ref(), notify::RecursiveMode::Recursive)?;
|
||||
|
||||
info!("Watching {} for plugin changes", plugins_dir.display());
|
||||
|
||||
loop {
|
||||
match rx.recv() {
|
||||
Ok(Ok(events)) => {
|
||||
// Check if any event is relevant (not just access/metadata)
|
||||
let has_relevant_change = events.iter().any(|e| {
|
||||
matches!(e.kind, DebouncedEventKind::Any | DebouncedEventKind::AnyContinuous)
|
||||
});
|
||||
|
||||
if has_relevant_change {
|
||||
info!("Plugin file change detected, reloading runtimes...");
|
||||
let mut pm_guard = pm.write().unwrap_or_else(|e| e.into_inner());
|
||||
pm_guard.reload_runtimes();
|
||||
}
|
||||
}
|
||||
Ok(Err(errors)) => {
|
||||
for e in errors {
|
||||
warn!("File watcher error: {}", e);
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
// Channel closed — watcher was dropped
|
||||
return Err(Box::new(e));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Register the watcher module**
|
||||
|
||||
In `crates/owlry-core/src/plugins/mod.rs`, add after line 28 (`pub mod runtime_loader;`):
|
||||
|
||||
```rust
|
||||
pub mod watcher;
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Start watcher in Server::run**
|
||||
|
||||
In `crates/owlry-core/src/server.rs`, in the `run()` method, before the accept loop, add:
|
||||
|
||||
```rust
|
||||
pub fn run(&self) -> io::Result<()> {
|
||||
// Start filesystem watcher for user plugin hot-reload
|
||||
crate::plugins::watcher::start_watching(Arc::clone(&self.provider_manager));
|
||||
|
||||
info!("Server entering accept loop");
|
||||
for stream in self.listener.incoming() {
|
||||
```
|
||||
|
||||
- [ ] **Step 6: Build and test**
|
||||
|
||||
Run: `cargo check -p owlry-core && cargo test -p owlry-core`
|
||||
Expected: all pass
|
||||
|
||||
- [ ] **Step 7: Manual smoke test**
|
||||
|
||||
```bash
|
||||
# Start the daemon
|
||||
RUST_LOG=info cargo run -p owlry-core
|
||||
|
||||
# In another terminal, create a test plugin
|
||||
mkdir -p ~/.config/owlry/plugins/hotreload-test
|
||||
cat > ~/.config/owlry/plugins/hotreload-test/plugin.toml << 'EOF'
|
||||
[plugin]
|
||||
id = "hotreload-test"
|
||||
name = "Hot Reload Test"
|
||||
version = "0.1.0"
|
||||
EOF
|
||||
cat > ~/.config/owlry/plugins/hotreload-test/main.lua << 'EOF'
|
||||
owlry.provider.register({
|
||||
name = "hotreload-test",
|
||||
refresh = function()
|
||||
return {{ id = "hr1", name = "Hot Reload Works!", command = "echo yes" }}
|
||||
end,
|
||||
})
|
||||
EOF
|
||||
|
||||
# Watch daemon logs — should see "Plugin file change detected, reloading runtimes..."
|
||||
# Clean up after testing
|
||||
rm -rf ~/.config/owlry/plugins/hotreload-test
|
||||
```
|
||||
|
||||
- [ ] **Step 8: Commit**
|
||||
|
||||
```bash
|
||||
git add crates/owlry-core/Cargo.toml \
|
||||
crates/owlry-core/src/plugins/watcher.rs \
|
||||
crates/owlry-core/src/plugins/mod.rs \
|
||||
crates/owlry-core/src/providers/mod.rs \
|
||||
crates/owlry-core/src/server.rs
|
||||
git commit -m "feat: add filesystem watcher for automatic user plugin hot-reload"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 5: Update plugin development documentation
|
||||
|
||||
**Files:**
|
||||
- Modify: `/home/cnachtigall/ssd/git/archive/owlibou/owlry-plugins/docs/PLUGIN_DEVELOPMENT.md`
|
||||
|
||||
- [ ] **Step 1: Update Lua plugin section**
|
||||
|
||||
In `docs/PLUGIN_DEVELOPMENT.md`, update the Lua Quick Start section (around line 101):
|
||||
|
||||
Change `entry_point = "init.lua"` to `entry = "main.lua"` in the manifest example.
|
||||
|
||||
Replace the Lua code example with the `owlry.provider.register()` API:
|
||||
|
||||
```lua
|
||||
owlry.provider.register({
|
||||
name = "myluaprovider",
|
||||
display_name = "My Lua Provider",
|
||||
type_id = "mylua",
|
||||
default_icon = "application-x-executable",
|
||||
prefix = ":mylua",
|
||||
refresh = function()
|
||||
return {
|
||||
{ id = "item-1", name = "Hello from Lua", command = "echo 'Hello Lua!'" },
|
||||
}
|
||||
end,
|
||||
})
|
||||
```
|
||||
|
||||
Remove `local owlry = require("owlry")` — the `owlry` table is pre-registered globally.
|
||||
|
||||
- [ ] **Step 2: Update Rune plugin section**
|
||||
|
||||
Update the Rune manifest example to use `entry = "main.rn"` instead of `entry_point = "main.rn"`.
|
||||
|
||||
- [ ] **Step 3: Update manifest reference**
|
||||
|
||||
In the Lua Plugin API manifest section (around line 325), change `entry_point` to `entry` and add a note:
|
||||
|
||||
```toml
|
||||
[plugin]
|
||||
id = "my-plugin"
|
||||
name = "My Plugin"
|
||||
version = "1.0.0"
|
||||
description = "Plugin description"
|
||||
entry = "main.lua" # Default: main.lua (Lua) / main.rn (Rune)
|
||||
# Alias: entry_point also accepted
|
||||
owlry_version = ">=1.0.0" # Optional version constraint
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Add hot-reload documentation**
|
||||
|
||||
Add a new section after "Best Practices" (before "Publishing to AUR"):
|
||||
|
||||
```markdown
|
||||
## Hot Reload
|
||||
|
||||
User plugins in `~/.config/owlry/plugins/` are automatically reloaded when files change.
|
||||
The daemon watches the plugins directory and reloads all script runtimes when any file
|
||||
is created, modified, or deleted. No daemon restart is needed.
|
||||
|
||||
**What triggers a reload:**
|
||||
- Creating a new plugin directory with `plugin.toml`
|
||||
- Editing a plugin's script files (`main.lua`, `main.rn`, etc.)
|
||||
- Editing a plugin's `plugin.toml`
|
||||
- Deleting a plugin directory
|
||||
|
||||
**What does NOT trigger a reload:**
|
||||
- Changes to native plugins (`.so` files) — these require a daemon restart
|
||||
- Changes to runtime libraries in `/usr/lib/owlry/runtimes/` — daemon restart needed
|
||||
|
||||
**Reload behavior:**
|
||||
- All script runtimes (Lua, Rune) are fully reloaded
|
||||
- Existing search results may briefly show stale data during reload
|
||||
- Errors in plugins are logged but don't affect other plugins
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Update Lua provider functions section**
|
||||
|
||||
Replace the bare `refresh()`/`query()` examples (around line 390) with the register API:
|
||||
|
||||
```lua
|
||||
-- Static provider: called once at startup and on reload
|
||||
owlry.provider.register({
|
||||
name = "my-provider",
|
||||
display_name = "My Provider",
|
||||
prefix = ":my",
|
||||
refresh = function()
|
||||
return {
|
||||
{ id = "id1", name = "Item 1", command = "command1" },
|
||||
{ id = "id2", name = "Item 2", command = "command2" },
|
||||
}
|
||||
end,
|
||||
})
|
||||
|
||||
-- Dynamic provider: called on each keystroke
|
||||
owlry.provider.register({
|
||||
name = "my-search",
|
||||
display_name = "My Search",
|
||||
prefix = "?my",
|
||||
query = function(q)
|
||||
if q == "" then return {} end
|
||||
return {
|
||||
{ id = "result", name = "Result for: " .. q, command = "echo " .. q },
|
||||
}
|
||||
end,
|
||||
})
|
||||
```
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
cd /home/cnachtigall/ssd/git/archive/owlibou/owlry-plugins
|
||||
git add docs/PLUGIN_DEVELOPMENT.md
|
||||
git commit -m "docs: update plugin development guide for main.lua/rn defaults, register API, hot-reload"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Task 6: Update hello-test plugin and clean up
|
||||
|
||||
**Files:**
|
||||
- Modify: `~/.config/owlry/plugins/hello-test/plugin.toml`
|
||||
- Modify: `~/.config/owlry/plugins/hello-test/init.lua` → rename to `main.lua`
|
||||
|
||||
This is a local-only task, not committed to either repo.
|
||||
|
||||
- [ ] **Step 1: Update hello-test plugin**
|
||||
|
||||
```bash
|
||||
# Rename entry point
|
||||
mv ~/.config/owlry/plugins/hello-test/init.lua ~/.config/owlry/plugins/hello-test/main.lua
|
||||
|
||||
# Update manifest to use entry field
|
||||
cat > ~/.config/owlry/plugins/hello-test/plugin.toml << 'EOF'
|
||||
[plugin]
|
||||
id = "hello-test"
|
||||
name = "Hello Test"
|
||||
version = "0.1.0"
|
||||
description = "Minimal test plugin for verifying Lua runtime loading"
|
||||
EOF
|
||||
```
|
||||
|
||||
- [ ] **Step 2: End-to-end verification**
|
||||
|
||||
```bash
|
||||
# Rebuild and restart daemon
|
||||
cargo build -p owlry-core
|
||||
RUST_LOG=info cargo run -p owlry-core
|
||||
|
||||
# Expected log output should include:
|
||||
# - "Loaded Lua runtime with 1 provider(s)" (hello-test)
|
||||
# - "Loaded Rune runtime with 1 provider(s)" (hyprshutdown)
|
||||
# - "Plugin file watcher started for ..."
|
||||
```
|
||||
1051
docs/superpowers/plans/2026-03-28-performance-hardening.md
Normal file
1051
docs/superpowers/plans/2026-03-28-performance-hardening.md
Normal file
File diff suppressed because it is too large
Load Diff
922
docs/superpowers/plans/2026-03-29-performance-optimization.md
Normal file
922
docs/superpowers/plans/2026-03-29-performance-optimization.md
Normal file
@@ -0,0 +1,922 @@
|
||||
# Performance Optimization Implementation Plan
|
||||
|
||||
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||
|
||||
**Goal:** Fix an unsound `unsafe` block, eliminate per-keystroke clone avalanches in the search path, and apply targeted I/O and algorithmic optimizations across both the `owlry` and `owlry-plugins` repos.
|
||||
|
||||
**Architecture:** Nine tasks across two repos. Phase 1 removes unsound `unsafe` code. Phase 2 restructures the hot search path to score by reference and clone only the final top-N results, combined with partial-sort (`select_nth_unstable_by`) for O(n) selection. Phase 3 removes unnecessary blocking I/O and simplifies GTK list updates. Phase 4 applies minor algorithmic fixes. Phase 5 covers plugin-repo fixes (separate repo, separate branch).
|
||||
|
||||
**Tech Stack:** Rust 1.90+, GTK4 4.12+, owlry-core, owlry-plugins
|
||||
|
||||
---
|
||||
|
||||
## File Map
|
||||
|
||||
| File | Action | Responsibility |
|
||||
|------|--------|----------------|
|
||||
| `crates/owlry-core/src/providers/native_provider.rs` | Modify | Remove `RwLock<Vec<LaunchItem>>`, eliminate `unsafe` block |
|
||||
| `crates/owlry-core/src/providers/mod.rs` | Modify | Score-by-reference in `search_with_frecency`, partial sort, clone only top N |
|
||||
| `crates/owlry-core/src/data/frecency.rs` | Modify | Remove auto-save in `record_launch` |
|
||||
| `crates/owlry/src/ui/main_window.rs` | Modify | Replace child-removal loop with `remove_all()` |
|
||||
| `crates/owlry-core/src/providers/application.rs` | Modify | Single-pass double-space cleanup |
|
||||
| `crates/owlry-core/src/filter.rs` | Modify | Merge full and partial prefix arrays into single-pass lookup |
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: Safety & Correctness
|
||||
|
||||
### Task 1: Remove unsound `unsafe` in NativeProvider::items()
|
||||
|
||||
The `items()` implementation creates a raw pointer from an `RwLockReadGuard`, then drops the guard while returning a slice backed by that pointer. This is UB waiting to happen. The inner `RwLock` is unnecessary — `refresh()` takes `&mut self` (exclusive access guaranteed by the outer `Arc<RwLock<ProviderManager>>`), and `items()` takes `&self`. Replace the `RwLock<Vec<LaunchItem>>` with a plain `Vec<LaunchItem>`.
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-core/src/providers/native_provider.rs`
|
||||
- Test: `crates/owlry-core/src/providers/native_provider.rs` (existing tests)
|
||||
|
||||
- [ ] **Step 1: Run existing tests to establish baseline**
|
||||
|
||||
Run: `cargo test -p owlry-core`
|
||||
|
||||
Expected: All tests PASS.
|
||||
|
||||
- [ ] **Step 2: Replace `RwLock<Vec<LaunchItem>>` with `Vec<LaunchItem>` in the struct**
|
||||
|
||||
In `crates/owlry-core/src/providers/native_provider.rs`, change the struct definition:
|
||||
|
||||
```rust
|
||||
pub struct NativeProvider {
|
||||
plugin: Arc<NativePlugin>,
|
||||
info: ProviderInfo,
|
||||
handle: ProviderHandle,
|
||||
items: Vec<LaunchItem>,
|
||||
}
|
||||
```
|
||||
|
||||
Update `new()` to initialize without RwLock:
|
||||
|
||||
```rust
|
||||
Self {
|
||||
plugin,
|
||||
info,
|
||||
handle,
|
||||
items: Vec::new(),
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Remove the `unsafe` block from `items()` — return `&self.items` directly**
|
||||
|
||||
Replace the entire `Provider::items()` impl:
|
||||
|
||||
```rust
|
||||
fn items(&self) -> &[LaunchItem] {
|
||||
&self.items
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Update `refresh()` to write directly to `self.items`**
|
||||
|
||||
Replace the RwLock write in `refresh()`:
|
||||
|
||||
```rust
|
||||
// Was: *self.items.write().unwrap() = items;
|
||||
self.items = items;
|
||||
```
|
||||
|
||||
- [ ] **Step 5: Update `query()` to read from `self.items` directly**
|
||||
|
||||
In the `query()` method, replace the RwLock read:
|
||||
|
||||
```rust
|
||||
// Was: return self.items.read().unwrap().clone();
|
||||
return self.items.clone();
|
||||
```
|
||||
|
||||
- [ ] **Step 6: Remove `use std::sync::RwLock;` (no longer needed, `Arc` still used for plugin)**
|
||||
|
||||
Remove `RwLock` from the `use std::sync::{Arc, RwLock};` import:
|
||||
|
||||
```rust
|
||||
use std::sync::Arc;
|
||||
```
|
||||
|
||||
- [ ] **Step 7: Run tests and check**
|
||||
|
||||
Run: `cargo test -p owlry-core && cargo check -p owlry-core`
|
||||
|
||||
Expected: All tests PASS, no warnings about unused imports.
|
||||
|
||||
- [ ] **Step 8: Compile full workspace to verify no downstream breakage**
|
||||
|
||||
Run: `cargo check --workspace`
|
||||
|
||||
Expected: Clean compilation.
|
||||
|
||||
- [ ] **Step 9: Commit**
|
||||
|
||||
```bash
|
||||
git add crates/owlry-core/src/providers/native_provider.rs
|
||||
git commit -m "fix(native-provider): remove unsound unsafe in items()
|
||||
|
||||
Replace RwLock<Vec<LaunchItem>> with plain Vec. The inner RwLock
|
||||
was unnecessary — refresh() takes &mut self (exclusive access
|
||||
guaranteed by the outer Arc<RwLock<ProviderManager>>). The unsafe
|
||||
block in items() dropped the RwLockReadGuard while returning a
|
||||
slice backed by the raw pointer, creating a dangling reference."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Hot Path Optimization
|
||||
|
||||
### Task 2: Eliminate clone avalanche in search_with_frecency
|
||||
|
||||
Currently every matching `LaunchItem` (5 Strings + Vec) is cloned during scoring, then the Vec is sorted and truncated to ~15 results — discarding 95%+ of clones. Refactor to score items by reference, partial-sort the lightweight `(&LaunchItem, i64)` tuples with `select_nth_unstable_by` (O(n) average), and clone only the top-N survivors.
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-core/src/providers/mod.rs` — `search_with_frecency` method (~lines 652-875)
|
||||
- Test: existing tests in `crates/owlry-core/src/providers/mod.rs`
|
||||
|
||||
- [ ] **Step 1: Run existing search tests to establish baseline**
|
||||
|
||||
Run: `cargo test -p owlry-core search`
|
||||
|
||||
Expected: All search-related tests PASS.
|
||||
|
||||
- [ ] **Step 2: Refactor `score_item` closure to return `Option<i64>` instead of `Option<(LaunchItem, i64)>`**
|
||||
|
||||
In `search_with_frecency`, change the closure at ~line 780 from:
|
||||
|
||||
```rust
|
||||
let score_item = |item: &LaunchItem| -> Option<(LaunchItem, i64)> {
|
||||
```
|
||||
|
||||
To:
|
||||
|
||||
```rust
|
||||
let score_item = |item: &LaunchItem| -> Option<i64> {
|
||||
```
|
||||
|
||||
And change the return from:
|
||||
|
||||
```rust
|
||||
base_score.map(|s| {
|
||||
let frecency_score = frecency.get_score_at(&item.id, now);
|
||||
let frecency_boost = (frecency_score * frecency_weight * 10.0) as i64;
|
||||
let exact_match_boost = if item.name.eq_ignore_ascii_case(query) {
|
||||
match &item.provider {
|
||||
ProviderType::Application => 50_000,
|
||||
_ => 30_000,
|
||||
}
|
||||
} else {
|
||||
0
|
||||
};
|
||||
(item.clone(), s + frecency_boost + exact_match_boost)
|
||||
})
|
||||
```
|
||||
|
||||
To:
|
||||
|
||||
```rust
|
||||
base_score.map(|s| {
|
||||
let frecency_score = frecency.get_score_at(&item.id, now);
|
||||
let frecency_boost = (frecency_score * frecency_weight * 10.0) as i64;
|
||||
let exact_match_boost = if item.name.eq_ignore_ascii_case(query) {
|
||||
match &item.provider {
|
||||
ProviderType::Application => 50_000,
|
||||
_ => 30_000,
|
||||
}
|
||||
} else {
|
||||
0
|
||||
};
|
||||
s + frecency_boost + exact_match_boost
|
||||
})
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Replace the static-item scoring loops to collect references**
|
||||
|
||||
Replace the scoring loops at ~lines 831-853:
|
||||
|
||||
```rust
|
||||
// Was:
|
||||
// for provider in &self.providers { ... results.push(scored); }
|
||||
// for provider in &self.static_native_providers { ... results.push(scored); }
|
||||
|
||||
// Score static items by reference (no cloning)
|
||||
let mut scored_refs: Vec<(&LaunchItem, i64)> = Vec::new();
|
||||
|
||||
for provider in &self.providers {
|
||||
if !filter.is_active(provider.provider_type()) {
|
||||
continue;
|
||||
}
|
||||
for item in provider.items() {
|
||||
if let Some(score) = score_item(item) {
|
||||
scored_refs.push((item, score));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for provider in &self.static_native_providers {
|
||||
if !filter.is_active(provider.provider_type()) {
|
||||
continue;
|
||||
}
|
||||
for item in provider.items() {
|
||||
if let Some(score) = score_item(item) {
|
||||
scored_refs.push((item, score));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Partial sort: O(n) average to find top max_results, then O(k log k) to order them
|
||||
if scored_refs.len() > max_results {
|
||||
scored_refs.select_nth_unstable_by(max_results, |a, b| b.1.cmp(&a.1));
|
||||
scored_refs.truncate(max_results);
|
||||
}
|
||||
scored_refs.sort_by(|a, b| b.1.cmp(&a.1));
|
||||
|
||||
// Clone only the survivors
|
||||
results.extend(scored_refs.into_iter().map(|(item, score)| (item.clone(), score)));
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Add final merge-sort for dynamic + static results**
|
||||
|
||||
After extending results, add the final sort (dynamic results from earlier in the function + the newly added static results need unified ordering):
|
||||
|
||||
```rust
|
||||
// Final sort merges dynamic results with static top-N
|
||||
results.sort_by(|a, b| b.1.cmp(&a.1));
|
||||
results.truncate(max_results);
|
||||
```
|
||||
|
||||
This replaces the existing `results.sort_by(...)` and `results.truncate(...)` lines at ~854-855 — the logic is the same, just confirming it's still present after the refactor.
|
||||
|
||||
- [ ] **Step 5: Optimize the empty-query path to score by reference too**
|
||||
|
||||
Replace the empty-query block at ~lines 739-776. Change:
|
||||
|
||||
```rust
|
||||
let core_items = self
|
||||
.providers
|
||||
.iter()
|
||||
.filter(|p| filter.is_active(p.provider_type()))
|
||||
.flat_map(|p| p.items().iter().cloned());
|
||||
|
||||
let native_items = self
|
||||
.static_native_providers
|
||||
.iter()
|
||||
.filter(|p| filter.is_active(p.provider_type()))
|
||||
.flat_map(|p| p.items().iter().cloned());
|
||||
|
||||
let items: Vec<(LaunchItem, i64)> = core_items
|
||||
.chain(native_items)
|
||||
.filter(|item| {
|
||||
if let Some(tag) = tag_filter {
|
||||
item.tags.iter().any(|t| t.to_lowercase().contains(tag))
|
||||
} else {
|
||||
true
|
||||
}
|
||||
})
|
||||
.map(|item| {
|
||||
let frecency_score = frecency.get_score_at(&item.id, now);
|
||||
let boosted = (frecency_score * frecency_weight * 100.0) as i64;
|
||||
(item, boosted)
|
||||
})
|
||||
.collect();
|
||||
|
||||
results.extend(items);
|
||||
results.sort_by(|a, b| b.1.cmp(&a.1));
|
||||
results.truncate(max_results);
|
||||
return results;
|
||||
```
|
||||
|
||||
With:
|
||||
|
||||
```rust
|
||||
let mut scored_refs: Vec<(&LaunchItem, i64)> = self
|
||||
.providers
|
||||
.iter()
|
||||
.filter(|p| filter.is_active(p.provider_type()))
|
||||
.flat_map(|p| p.items().iter())
|
||||
.chain(
|
||||
self.static_native_providers
|
||||
.iter()
|
||||
.filter(|p| filter.is_active(p.provider_type()))
|
||||
.flat_map(|p| p.items().iter()),
|
||||
)
|
||||
.filter(|item| {
|
||||
if let Some(tag) = tag_filter {
|
||||
item.tags.iter().any(|t| t.to_lowercase().contains(tag))
|
||||
} else {
|
||||
true
|
||||
}
|
||||
})
|
||||
.map(|item| {
|
||||
let frecency_score = frecency.get_score_at(&item.id, now);
|
||||
let boosted = (frecency_score * frecency_weight * 100.0) as i64;
|
||||
(item, boosted)
|
||||
})
|
||||
.collect();
|
||||
|
||||
if scored_refs.len() > max_results {
|
||||
scored_refs.select_nth_unstable_by(max_results, |a, b| b.1.cmp(&a.1));
|
||||
scored_refs.truncate(max_results);
|
||||
}
|
||||
scored_refs.sort_by(|a, b| b.1.cmp(&a.1));
|
||||
|
||||
results.extend(scored_refs.into_iter().map(|(item, score)| (item.clone(), score)));
|
||||
results.sort_by(|a, b| b.1.cmp(&a.1));
|
||||
results.truncate(max_results);
|
||||
return results;
|
||||
```
|
||||
|
||||
- [ ] **Step 6: Run tests**
|
||||
|
||||
Run: `cargo test -p owlry-core`
|
||||
|
||||
Expected: All tests PASS. Search results are identical (same items, same ordering).
|
||||
|
||||
- [ ] **Step 7: Compile full workspace**
|
||||
|
||||
Run: `cargo check --workspace`
|
||||
|
||||
Expected: Clean compilation.
|
||||
|
||||
- [ ] **Step 8: Commit**
|
||||
|
||||
```bash
|
||||
git add crates/owlry-core/src/providers/mod.rs
|
||||
git commit -m "perf(search): score by reference, clone only top-N results
|
||||
|
||||
Refactor search_with_frecency to score static provider items by
|
||||
reference (&LaunchItem, i64) instead of cloning every match.
|
||||
Use select_nth_unstable_by for O(n) partial sort, then clone
|
||||
only the max_results survivors. Reduces clones from O(total_matches)
|
||||
to O(max_results) — typically from hundreds to ~15."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: I/O Optimization
|
||||
|
||||
### Task 3: Remove frecency auto-save on every launch
|
||||
|
||||
`record_launch` calls `self.save()` synchronously — serializing JSON and writing to disk on every item launch. The `Drop` impl already saves on shutdown. Mark dirty and let the caller (or shutdown) handle persistence.
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-core/src/data/frecency.rs:98-123`
|
||||
- Test: `crates/owlry-core/src/data/frecency.rs` (existing + new)
|
||||
|
||||
- [ ] **Step 1: Write test verifying record_launch sets dirty without saving**
|
||||
|
||||
Add to the `#[cfg(test)]` block in `frecency.rs`:
|
||||
|
||||
```rust
|
||||
#[test]
|
||||
fn record_launch_sets_dirty_without_saving() {
|
||||
let mut store = FrecencyStore {
|
||||
data: FrecencyData::default(),
|
||||
path: PathBuf::from("/dev/null"),
|
||||
dirty: false,
|
||||
};
|
||||
|
||||
store.record_launch("test-item");
|
||||
|
||||
assert!(store.dirty, "record_launch should set dirty flag");
|
||||
assert_eq!(store.data.entries["test-item"].launch_count, 1);
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run test to verify it fails (current code auto-saves, clearing dirty)**
|
||||
|
||||
Run: `cargo test -p owlry-core record_launch_sets_dirty`
|
||||
|
||||
Expected: FAIL — `store.dirty` is `false` because `save()` clears it.
|
||||
|
||||
- [ ] **Step 3: Remove the auto-save from `record_launch`**
|
||||
|
||||
In `crates/owlry-core/src/data/frecency.rs`, remove lines 119-122 from `record_launch`:
|
||||
|
||||
```rust
|
||||
// Remove this block:
|
||||
// Auto-save after recording
|
||||
if let Err(e) = self.save() {
|
||||
warn!("Failed to save frecency data: {}", e);
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Run test to verify it passes**
|
||||
|
||||
Run: `cargo test -p owlry-core record_launch_sets_dirty`
|
||||
|
||||
Expected: PASS.
|
||||
|
||||
- [ ] **Step 5: Run all frecency tests**
|
||||
|
||||
Run: `cargo test -p owlry-core frecency`
|
||||
|
||||
Expected: All PASS.
|
||||
|
||||
- [ ] **Step 6: Commit**
|
||||
|
||||
```bash
|
||||
git add crates/owlry-core/src/data/frecency.rs
|
||||
git commit -m "perf(frecency): remove blocking auto-save on every launch
|
||||
|
||||
record_launch no longer calls save() synchronously. The dirty flag
|
||||
is set and the Drop impl flushes on shutdown. Removes a JSON
|
||||
serialize + fs::write from the hot launch path."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 4: GTK ListBox — replace child-removal loop with `remove_all()`
|
||||
|
||||
The current code removes children one-by-one in a `while` loop, triggering layout invalidation per removal. GTK 4.12 provides `remove_all()` which batches the operation.
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry/src/ui/main_window.rs` — two locations (~lines 705-707 and ~742-744)
|
||||
|
||||
- [ ] **Step 1: Replace daemon-mode child removal loop**
|
||||
|
||||
In the `spawn_future_local` async block (~line 705), replace:
|
||||
|
||||
```rust
|
||||
while let Some(child) = results_list_cb.first_child() {
|
||||
results_list_cb.remove(&child);
|
||||
}
|
||||
```
|
||||
|
||||
With:
|
||||
|
||||
```rust
|
||||
results_list_cb.remove_all();
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Replace local-mode (dmenu) child removal loop**
|
||||
|
||||
In the synchronous (local/dmenu) branch (~line 742), replace:
|
||||
|
||||
```rust
|
||||
while let Some(child) = results_list.first_child() {
|
||||
results_list.remove(&child);
|
||||
}
|
||||
```
|
||||
|
||||
With:
|
||||
|
||||
```rust
|
||||
results_list.remove_all();
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Verify compilation**
|
||||
|
||||
Run: `cargo check -p owlry`
|
||||
|
||||
Expected: Clean compilation. `remove_all()` is available in gtk4 4.12+.
|
||||
|
||||
- [ ] **Step 4: Commit**
|
||||
|
||||
```bash
|
||||
git add crates/owlry/src/ui/main_window.rs
|
||||
git commit -m "perf(ui): use ListBox::remove_all() instead of per-child loop
|
||||
|
||||
Replaces two while-loop child removal patterns with the batched
|
||||
remove_all() method available since GTK 4.12. Avoids per-removal
|
||||
layout invalidation."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: Minor Optimizations
|
||||
|
||||
### Task 5: Single-pass double-space cleanup in application.rs
|
||||
|
||||
The `clean_desktop_exec_field` function uses a `while contains(" ") { replace(" ", " ") }` loop — O(n²) on pathological input with repeated allocations. Replace with a single-pass char iterator.
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-core/src/providers/application.rs:60-64`
|
||||
- Test: existing tests in `crates/owlry-core/src/providers/application.rs`
|
||||
|
||||
- [ ] **Step 1: Add test for pathological input**
|
||||
|
||||
Add to the existing `#[cfg(test)]` block:
|
||||
|
||||
```rust
|
||||
#[test]
|
||||
fn test_clean_desktop_exec_collapses_spaces() {
|
||||
assert_eq!(clean_desktop_exec_field("app --flag arg"), "app --flag arg");
|
||||
// Pathological: many consecutive spaces
|
||||
let input = format!("app{}arg", " ".repeat(100));
|
||||
assert_eq!(clean_desktop_exec_field(&input), "app arg");
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Run test to verify it passes with current implementation**
|
||||
|
||||
Run: `cargo test -p owlry-core clean_desktop_exec`
|
||||
|
||||
Expected: All PASS (current implementation works, just inefficiently).
|
||||
|
||||
- [ ] **Step 3: Replace the while-loop with a single-pass approach**
|
||||
|
||||
Replace lines 60-64 of `application.rs`:
|
||||
|
||||
```rust
|
||||
// Was:
|
||||
// let mut cleaned = result.trim().to_string();
|
||||
// while cleaned.contains(" ") {
|
||||
// cleaned = cleaned.replace(" ", " ");
|
||||
// }
|
||||
// cleaned
|
||||
|
||||
let trimmed = result.trim();
|
||||
let mut cleaned = String::with_capacity(trimmed.len());
|
||||
let mut prev_space = false;
|
||||
for c in trimmed.chars() {
|
||||
if c == ' ' {
|
||||
if !prev_space {
|
||||
cleaned.push(' ');
|
||||
}
|
||||
prev_space = true;
|
||||
} else {
|
||||
cleaned.push(c);
|
||||
prev_space = false;
|
||||
}
|
||||
}
|
||||
cleaned
|
||||
```
|
||||
|
||||
- [ ] **Step 4: Run all application tests**
|
||||
|
||||
Run: `cargo test -p owlry-core clean_desktop_exec`
|
||||
|
||||
Expected: All PASS including the new pathological test.
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add crates/owlry-core/src/providers/application.rs
|
||||
git commit -m "perf(application): single-pass double-space collapse
|
||||
|
||||
Replace while-contains-replace loop with a single-pass char
|
||||
iterator. Eliminates O(n²) behavior and repeated allocations
|
||||
on pathological desktop file Exec values."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 6: Consolidate parse_query prefix matching into single pass
|
||||
|
||||
`parse_query` maintains four separate arrays (core_prefixes, plugin_prefixes, partial_core, partial_plugin) with duplicated prefix strings, iterating them in sequence. Merge full and partial matching into a single array and a single loop per category.
|
||||
|
||||
**Files:**
|
||||
- Modify: `crates/owlry-core/src/filter.rs:202-406`
|
||||
- Test: existing tests in `crates/owlry-core/src/filter.rs`
|
||||
|
||||
- [ ] **Step 1: Run existing filter tests to establish baseline**
|
||||
|
||||
Run: `cargo test -p owlry-core filter`
|
||||
|
||||
Expected: All PASS.
|
||||
|
||||
- [ ] **Step 2: Define a unified prefix entry struct and static arrays**
|
||||
|
||||
At the top of `parse_query`, replace the four separate arrays with two unified arrays:
|
||||
|
||||
```rust
|
||||
pub fn parse_query(query: &str) -> ParsedQuery {
|
||||
let trimmed = query.trim_start();
|
||||
|
||||
// Tag filter: ":tag:XXX query" — check first (unchanged)
|
||||
if let Some(rest) = trimmed.strip_prefix(":tag:") {
|
||||
if let Some(space_idx) = rest.find(' ') {
|
||||
let tag = rest[..space_idx].to_lowercase();
|
||||
let query_part = rest[space_idx + 1..].to_string();
|
||||
#[cfg(feature = "dev-logging")]
|
||||
debug!(
|
||||
"[Filter] parse_query({:?}) -> tag={:?}, query={:?}",
|
||||
query, tag, query_part
|
||||
);
|
||||
return ParsedQuery {
|
||||
prefix: None,
|
||||
tag_filter: Some(tag),
|
||||
query: query_part,
|
||||
};
|
||||
} else {
|
||||
let tag = rest.to_lowercase();
|
||||
return ParsedQuery {
|
||||
prefix: None,
|
||||
tag_filter: Some(tag),
|
||||
query: String::new(),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// Core prefixes — each entry is tried as ":prefix " (full) and ":prefix" (partial)
|
||||
const CORE_PREFIXES: &[(&str, fn() -> ProviderType)] = &[
|
||||
("app", || ProviderType::Application),
|
||||
("apps", || ProviderType::Application),
|
||||
("cmd", || ProviderType::Command),
|
||||
("command", || ProviderType::Command),
|
||||
];
|
||||
|
||||
// Plugin prefixes — each entry maps to a plugin type_id
|
||||
const PLUGIN_PREFIXES: &[(&str, &str)] = &[
|
||||
("bm", "bookmarks"),
|
||||
("bookmark", "bookmarks"),
|
||||
("bookmarks", "bookmarks"),
|
||||
("calc", "calc"),
|
||||
("calculator", "calc"),
|
||||
("clip", "clipboard"),
|
||||
("clipboard", "clipboard"),
|
||||
("emoji", "emoji"),
|
||||
("emojis", "emoji"),
|
||||
("file", "filesearch"),
|
||||
("files", "filesearch"),
|
||||
("find", "filesearch"),
|
||||
("script", "scripts"),
|
||||
("scripts", "scripts"),
|
||||
("ssh", "ssh"),
|
||||
("sys", "system"),
|
||||
("system", "system"),
|
||||
("power", "system"),
|
||||
("uuctl", "uuctl"),
|
||||
("systemd", "uuctl"),
|
||||
("web", "websearch"),
|
||||
("search", "websearch"),
|
||||
("config", "config"),
|
||||
("settings", "config"),
|
||||
("conv", "conv"),
|
||||
("converter", "conv"),
|
||||
];
|
||||
|
||||
// Single-pass: try each core prefix as both full (":prefix query") and partial (":prefix")
|
||||
for (name, make_provider) in CORE_PREFIXES {
|
||||
let with_space = format!(":{} ", name);
|
||||
if let Some(rest) = trimmed.strip_prefix(with_space.as_str()) {
|
||||
let provider = make_provider();
|
||||
#[cfg(feature = "dev-logging")]
|
||||
debug!(
|
||||
"[Filter] parse_query({:?}) -> prefix={:?}, query={:?}",
|
||||
query, provider, rest
|
||||
);
|
||||
return ParsedQuery {
|
||||
prefix: Some(provider),
|
||||
tag_filter: None,
|
||||
query: rest.to_string(),
|
||||
};
|
||||
}
|
||||
let exact = format!(":{}", name);
|
||||
if trimmed == exact {
|
||||
let provider = make_provider();
|
||||
#[cfg(feature = "dev-logging")]
|
||||
debug!(
|
||||
"[Filter] parse_query({:?}) -> partial prefix {:?}",
|
||||
query, provider
|
||||
);
|
||||
return ParsedQuery {
|
||||
prefix: Some(provider),
|
||||
tag_filter: None,
|
||||
query: String::new(),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// Single-pass: try each plugin prefix as both full and partial
|
||||
for (name, type_id) in PLUGIN_PREFIXES {
|
||||
let with_space = format!(":{} ", name);
|
||||
if let Some(rest) = trimmed.strip_prefix(with_space.as_str()) {
|
||||
let provider = ProviderType::Plugin(type_id.to_string());
|
||||
#[cfg(feature = "dev-logging")]
|
||||
debug!(
|
||||
"[Filter] parse_query({:?}) -> prefix={:?}, query={:?}",
|
||||
query, provider, rest
|
||||
);
|
||||
return ParsedQuery {
|
||||
prefix: Some(provider),
|
||||
tag_filter: None,
|
||||
query: rest.to_string(),
|
||||
};
|
||||
}
|
||||
let exact = format!(":{}", name);
|
||||
if trimmed == exact {
|
||||
let provider = ProviderType::Plugin(type_id.to_string());
|
||||
#[cfg(feature = "dev-logging")]
|
||||
debug!(
|
||||
"[Filter] parse_query({:?}) -> partial prefix {:?}",
|
||||
query, provider
|
||||
);
|
||||
return ParsedQuery {
|
||||
prefix: Some(provider),
|
||||
tag_filter: None,
|
||||
query: String::new(),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
// Dynamic plugin prefix fallback (unchanged)
|
||||
if let Some(rest) = trimmed.strip_prefix(':') {
|
||||
if let Some(space_idx) = rest.find(' ') {
|
||||
let prefix_word = &rest[..space_idx];
|
||||
if !prefix_word.is_empty()
|
||||
&& prefix_word
|
||||
.chars()
|
||||
.all(|c| c.is_alphanumeric() || c == '-' || c == '_')
|
||||
{
|
||||
return ParsedQuery {
|
||||
prefix: Some(ProviderType::Plugin(prefix_word.to_string())),
|
||||
tag_filter: None,
|
||||
query: rest[space_idx + 1..].to_string(),
|
||||
};
|
||||
}
|
||||
} else if !rest.is_empty()
|
||||
&& rest
|
||||
.chars()
|
||||
.all(|c| c.is_alphanumeric() || c == '-' || c == '_')
|
||||
{
|
||||
return ParsedQuery {
|
||||
prefix: Some(ProviderType::Plugin(rest.to_string())),
|
||||
tag_filter: None,
|
||||
query: String::new(),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
let result = ParsedQuery {
|
||||
prefix: None,
|
||||
tag_filter: None,
|
||||
query: query.to_string(),
|
||||
};
|
||||
|
||||
#[cfg(feature = "dev-logging")]
|
||||
debug!(
|
||||
"[Filter] parse_query({:?}) -> prefix={:?}, tag={:?}, query={:?}",
|
||||
query, result.prefix, result.tag_filter, result.query
|
||||
);
|
||||
|
||||
result
|
||||
}
|
||||
```
|
||||
|
||||
> **Note:** `CORE_PREFIXES` uses function pointers (`fn() -> ProviderType`) because `ProviderType::Application` and `ProviderType::Command` are fieldless variants that can be constructed in a const context via a trivial function. `PLUGIN_PREFIXES` stays as `(&str, &str)` because the `to_string()` allocation only happens once a prefix actually matches.
|
||||
|
||||
- [ ] **Step 3: Run all filter tests**
|
||||
|
||||
Run: `cargo test -p owlry-core filter`
|
||||
|
||||
Expected: All existing tests PASS (behavior unchanged).
|
||||
|
||||
- [ ] **Step 4: Run full check**
|
||||
|
||||
Run: `cargo check -p owlry-core`
|
||||
|
||||
Expected: Clean compilation.
|
||||
|
||||
- [ ] **Step 5: Commit**
|
||||
|
||||
```bash
|
||||
git add crates/owlry-core/src/filter.rs
|
||||
git commit -m "refactor(filter): consolidate parse_query prefix arrays
|
||||
|
||||
Merge four separate prefix arrays (core full, plugin full, core
|
||||
partial, plugin partial) into two arrays with a single loop each
|
||||
that checks both full and partial match. Halves the data and
|
||||
eliminates the duplicate iteration."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Phase 5: Plugin Repo Fixes
|
||||
|
||||
> **These tasks target `somegit.dev/Owlibou/owlry-plugins` — a separate repository.**
|
||||
> Clone and branch separately. They can be done independently of Phases 1-4.
|
||||
|
||||
### Task 7: Filesearch — add minimum query length threshold
|
||||
|
||||
The filesearch plugin spawns an `fd` subprocess on every keystroke (after debounce). For short queries this is wasteful and returns too many results. Add a 3-character minimum before spawning.
|
||||
|
||||
**Files:**
|
||||
- Modify: `owlry-plugin-filesearch/src/lib.rs` — `query()` method
|
||||
- Test: existing or new tests
|
||||
|
||||
- [ ] **Step 1: Add early return in the `query` method**
|
||||
|
||||
At the top of the `query` function (which receives the search text), add:
|
||||
|
||||
```rust
|
||||
fn query(&self, query: &str) -> Vec<PluginItem> {
|
||||
// Don't spawn fd for very short queries — too many results, too slow
|
||||
if query.len() < 3 {
|
||||
return Vec::new();
|
||||
}
|
||||
// ... existing code ...
|
||||
}
|
||||
```
|
||||
|
||||
Find the correct method — it may be the `ProviderVTable::provider_query` path or a helper like `search_with_fd`. The guard should be placed at the earliest point before `Command::new("fd")` is invoked.
|
||||
|
||||
- [ ] **Step 2: Verify compilation and test**
|
||||
|
||||
Run: `cargo check -p owlry-plugin-filesearch`
|
||||
|
||||
Expected: Clean compilation.
|
||||
|
||||
- [ ] **Step 3: Commit**
|
||||
|
||||
```bash
|
||||
git add owlry-plugin-filesearch/src/lib.rs
|
||||
git commit -m "perf(filesearch): skip fd subprocess for queries under 3 chars
|
||||
|
||||
Avoids spawning a subprocess per keystroke when the user has
|
||||
only typed 1-2 characters. Short queries return too many results
|
||||
from fd and block the daemon's read lock."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Task 8: Emoji plugin — avoid double clone on refresh
|
||||
|
||||
The emoji provider's `refresh()` returns `state.items.to_vec().into()` which clones all ~400 `PluginItem` structs. The core's `NativeProvider::refresh()` then converts each to `LaunchItem` (another set of allocations). If the plugin API supports transferring ownership instead of cloning, use that. Otherwise, this is an API-level limitation.
|
||||
|
||||
**Files:**
|
||||
- Modify: `owlry-plugin-emoji/src/lib.rs` — `provider_refresh` function
|
||||
|
||||
- [ ] **Step 1: Check if items can be drained instead of cloned**
|
||||
|
||||
If `state.items` is a `Vec<PluginItem>` that gets rebuilt on each refresh anyway, drain it:
|
||||
|
||||
```rust
|
||||
// Was: state.items.to_vec().into()
|
||||
// If items are rebuilt each refresh:
|
||||
std::mem::take(&mut state.items).into()
|
||||
```
|
||||
|
||||
If `state.items` must be preserved between refreshes (because refresh is called multiple times and the items don't change), then the clone is necessary and this task is a no-op. Check the `refresh()` implementation to determine which case applies.
|
||||
|
||||
- [ ] **Step 2: Verify and commit if applicable**
|
||||
|
||||
Run: `cargo check -p owlry-plugin-emoji`
|
||||
|
||||
---
|
||||
|
||||
### Task 9: Clipboard plugin — add caching for `cliphist list`
|
||||
|
||||
The clipboard provider calls `cliphist list` synchronously on every refresh. If the daemon's periodic refresh timer triggers this, it blocks the RwLock. Add a simple staleness check — only re-run `cliphist list` if more than N seconds have elapsed since the last successful fetch.
|
||||
|
||||
**Files:**
|
||||
- Modify: `owlry-plugin-clipboard/src/lib.rs`
|
||||
|
||||
- [ ] **Step 1: Add a `last_refresh` timestamp to the provider state**
|
||||
|
||||
```rust
|
||||
use std::time::Instant;
|
||||
|
||||
struct ClipboardState {
|
||||
items: Vec<PluginItem>,
|
||||
last_refresh: Option<Instant>,
|
||||
}
|
||||
```
|
||||
|
||||
- [ ] **Step 2: Guard the subprocess call with a staleness check**
|
||||
|
||||
In the `refresh()` path:
|
||||
|
||||
```rust
|
||||
const REFRESH_INTERVAL: Duration = Duration::from_secs(5);
|
||||
|
||||
if let Some(last) = state.last_refresh {
|
||||
if last.elapsed() < REFRESH_INTERVAL {
|
||||
return state.items.clone().into();
|
||||
}
|
||||
}
|
||||
|
||||
// ... existing cliphist list call ...
|
||||
|
||||
state.last_refresh = Some(Instant::now());
|
||||
```
|
||||
|
||||
- [ ] **Step 3: Verify and commit**
|
||||
|
||||
Run: `cargo check -p owlry-plugin-clipboard`
|
||||
|
||||
```bash
|
||||
git commit -m "perf(clipboard): cache cliphist results for 5 seconds
|
||||
|
||||
Avoids re-spawning cliphist list on every refresh cycle when the
|
||||
previous results are still fresh."
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
| Task | Impact | Repo | Risk |
|
||||
|------|--------|------|------|
|
||||
| 1. Remove unsafe in NativeProvider | CRITICAL (soundness) | owlry | Low — drops unnecessary RwLock |
|
||||
| 2. Score-by-ref + partial sort | HIGH (keystroke perf) | owlry | Medium — touches hot path, verify with tests |
|
||||
| 3. Remove frecency auto-save | MEDIUM (launch perf) | owlry | Low — Drop impl already saves |
|
||||
| 4. ListBox remove_all() | MEDIUM (UI smoothness) | owlry | Low — direct GTK API replacement |
|
||||
| 5. Single-pass space collapse | LOW (startup) | owlry | Low — purely algorithmic |
|
||||
| 6. Consolidate parse_query | LOW (keystroke) | owlry | Low — existing tests cover behavior |
|
||||
| 7. Filesearch min query length | HIGH (keystroke perf) | plugins | Low — early return guard |
|
||||
| 8. Emoji refresh optimization | MEDIUM (startup) | plugins | Low — depends on API check |
|
||||
| 9. Clipboard caching | MEDIUM (refresh perf) | plugins | Low — simple staleness check |
|
||||
142
docs/superpowers/specs/2026-03-26-codebase-hardening-design.md
Normal file
142
docs/superpowers/specs/2026-03-26-codebase-hardening-design.md
Normal file
@@ -0,0 +1,142 @@
|
||||
# Codebase Hardening: owlry + owlry-plugins
|
||||
|
||||
**Date:** 2026-03-26
|
||||
**Scope:** 15 fixes across 2 repositories, organized in 5 severity tiers
|
||||
**Approach:** Severity-ordered tiers, one commit per tier, core repo first
|
||||
|
||||
---
|
||||
|
||||
## Tier 1: Critical / Soundness (owlry core)
|
||||
|
||||
### 1a. Replace `static mut HOST_API` with `OnceLock`
|
||||
|
||||
**File:** `crates/owlry-plugin-api/src/lib.rs`
|
||||
**Problem:** `static mut` is unsound — concurrent reads during initialization are UB.
|
||||
**Fix:** Replace with `std::sync::OnceLock<&'static HostAPI>`. `init_host_api()` calls `HOST_API.set(api)`, `host_api()` calls `HOST_API.get().copied()`. No public API changes — convenience wrappers (`notify()`, `log_info()`, etc.) keep working. No ABI impact since `HOST_API` is internal.
|
||||
|
||||
### 1b. Add IPC message size limit
|
||||
|
||||
**File:** `crates/owlry-core/src/server.rs`
|
||||
**Problem:** `BufReader::lines()` reads unbounded lines. A malicious/buggy client can OOM the daemon.
|
||||
**Fix:** Replace the `lines()` iterator with a manual `read_line()` loop enforcing a 1 MB max. Lines exceeding the limit get an error response and the connection is dropped. Constant: `const MAX_REQUEST_SIZE: usize = 1_048_576`.
|
||||
|
||||
### 1c. Handle mutex poisoning gracefully
|
||||
|
||||
**File:** `crates/owlry-core/src/server.rs`
|
||||
**Problem:** All `lock().unwrap()` calls panic on poisoned mutex, crashing handler threads.
|
||||
**Fix:** Replace with `lock().unwrap_or_else(|e| e.into_inner())`. The ProviderManager and FrecencyStore don't have invariants that require abort-on-poison.
|
||||
|
||||
---
|
||||
|
||||
## Tier 2: Security (owlry core)
|
||||
|
||||
### 2a. Set socket permissions after bind
|
||||
|
||||
**File:** `crates/owlry-core/src/server.rs`
|
||||
**Problem:** Socket inherits process umask, may be readable by other local users.
|
||||
**Fix:** After `UnixListener::bind()`, call `std::fs::set_permissions(socket_path, Permissions::from_mode(0o600))`. Uses `std::os::unix::fs::PermissionsExt`.
|
||||
|
||||
### 2b. Log signal handler failure
|
||||
|
||||
**File:** `crates/owlry-core/src/main.rs`
|
||||
**Problem:** `ctrlc::set_handler(...).ok()` silently swallows errors. Failed handler means no socket cleanup on SIGINT.
|
||||
**Fix:** Replace `.ok()` with `if let Err(e) = ... { warn!("...") }`.
|
||||
|
||||
### 2c. Add client read timeout
|
||||
|
||||
**File:** `crates/owlry-core/src/server.rs`
|
||||
**Problem:** A client that connects but never sends data blocks a thread forever.
|
||||
**Fix:** Set `stream.set_read_timeout(Some(Duration::from_secs(30)))` on accepted connections before entering the read loop.
|
||||
|
||||
---
|
||||
|
||||
## Tier 3: Robustness / Quality (owlry core)
|
||||
|
||||
### 3a. Log malformed JSON requests
|
||||
|
||||
**File:** `crates/owlry-core/src/server.rs`
|
||||
**Problem:** JSON parse errors only sent as response to client, not visible in daemon logs.
|
||||
**Fix:** Add `warn!("Malformed request from client: {}", e)` before sending the error response.
|
||||
|
||||
### 3b. Replace Mutex with RwLock for concurrent reads
|
||||
|
||||
**File:** `crates/owlry-core/src/server.rs`
|
||||
**Problem:** `Mutex<ProviderManager>` blocks all concurrent queries even though they're read-only.
|
||||
**Fix:** Replace both `Arc<Mutex<ProviderManager>>` and `Arc<Mutex<FrecencyStore>>` with `Arc<RwLock<...>>`.
|
||||
|
||||
Lock usage per request type:
|
||||
|
||||
| Request | ProviderManager | FrecencyStore |
|
||||
|---------|----------------|---------------|
|
||||
| Query | `read()` | `read()` |
|
||||
| Launch | — | `write()` |
|
||||
| Providers | `read()` | — |
|
||||
| Refresh | `write()` | — |
|
||||
| Toggle | — | — |
|
||||
| Submenu | `read()` | — |
|
||||
| PluginAction | `read()` | — |
|
||||
|
||||
Poisoning recovery: `.unwrap_or_else(|e| e.into_inner())` applies to RwLock the same way.
|
||||
|
||||
---
|
||||
|
||||
## Tier 4: Critical fixes (owlry-plugins)
|
||||
|
||||
### 4a. Fix `Box::leak` memory leak in converter
|
||||
|
||||
**File:** `owlry-plugins/crates/owlry-plugin-converter/src/units.rs`
|
||||
**Problem:** `Box::leak(code.into_boxed_str())` leaks memory on every keystroke for currency queries.
|
||||
**Fix:** Currency codes are already `&'static str` in `CURRENCY_ALIASES`. Change `resolve_currency_code()` return type from `Option<String>` to `Option<&'static str>` so it returns the static str directly. This eliminates the `Box::leak`. Callers in `units.rs` (`find_unit`, `convert_currency`, `convert_currency_common`) and `currency.rs` (`is_currency_alias`) must be updated to work with `&'static str` — mostly removing `.to_string()` calls or adding them at the boundary where `String` is needed (e.g., HashMap lookups that need owned keys).
|
||||
|
||||
### 4b. Fix bookmarks temp file race condition
|
||||
|
||||
**File:** `owlry-plugins/crates/owlry-plugin-bookmarks/src/lib.rs`
|
||||
**Problem:** Predictable `/tmp/owlry_places_temp.sqlite` path — concurrent instances clobber, symlink attacks possible.
|
||||
**Fix:** Append PID and monotonic counter to filename: `owlry_places_{pid}.sqlite`. Uses `std::process::id()`. Each profile copy gets its own name via index. Cleanup on exit remains the same.
|
||||
|
||||
### 4c. Fix bookmarks background refresh never updating state
|
||||
|
||||
**File:** `owlry-plugins/crates/owlry-plugin-bookmarks/src/lib.rs`
|
||||
**Problem:** Background thread loads items and saves cache but never writes back to `self.items`. Current session keeps stale data.
|
||||
**Fix:** Replace `items: Vec<PluginItem>` with `items: Arc<Mutex<Vec<PluginItem>>>`. Background thread writes to the shared vec after completing. `provider_refresh` reads from it. The `loading` AtomicBool already prevents concurrent loads.
|
||||
|
||||
---
|
||||
|
||||
## Tier 5: Quality fixes (owlry-plugins)
|
||||
|
||||
### 5a. SSH plugin: read terminal from config
|
||||
|
||||
**File:** `owlry-plugins/crates/owlry-plugin-ssh/src/lib.rs`
|
||||
**Problem:** Hardcoded `kitty` as terminal fallback. Core already detects terminals.
|
||||
**Fix:** Read `terminal` from `[plugins.ssh]` in `~/.config/owlry/config.toml`. Fall back to `$TERMINAL` env var, then `xdg-terminal-exec`. Same config pattern as weather/pomodoro plugins.
|
||||
|
||||
### 5b. WebSearch plugin: read engine from config
|
||||
|
||||
**File:** `owlry-plugins/crates/owlry-plugin-websearch/src/lib.rs`
|
||||
**Problem:** TODO comment for config reading, never implemented. Engine is always duckduckgo.
|
||||
**Fix:** Read `engine` from `[plugins.websearch]` in config.toml. Supports named engines (`google`, `duckduckgo`, etc.) or custom URL templates with `{query}`. Falls back to duckduckgo.
|
||||
|
||||
### 5c. Emoji plugin: build items once at init
|
||||
|
||||
**File:** `owlry-plugins/crates/owlry-plugin-emoji/src/lib.rs`
|
||||
**Problem:** `load_emojis()` clears and rebuilds ~370 items on every `refresh()` call.
|
||||
**Fix:** Call `load_emojis()` in `EmojiState::new()`. `provider_refresh` returns `self.items.clone()` without rebuilding.
|
||||
|
||||
### 5d. Calculator/Converter: safer shell commands
|
||||
|
||||
**Files:** `owlry-plugin-calculator/src/lib.rs`, `owlry-plugin-converter/src/lib.rs`
|
||||
**Problem:** `sh -c 'echo -n "..."'` pattern with double-quote interpolation. Theoretically breakable by unexpected result formatting.
|
||||
**Fix:** Use `printf '%s' '...' | wl-copy` with single-quote escaping (`replace('\'', "'\\''")`) — the same safe pattern already used by bookmarks and clipboard plugins.
|
||||
|
||||
---
|
||||
|
||||
## Out of scope
|
||||
|
||||
These were identified but deferred:
|
||||
|
||||
- **Hardcoded emoji list** — replacing with a crate/data file is a feature, not a fix
|
||||
- **Plugin vtable-level tests** — valuable but a separate testing initiative
|
||||
- **IPC protocol versioning** — protocol change, not a bug fix
|
||||
- **Plugin sandbox enforcement** — large feature, not a point fix
|
||||
- **Desktop Exec field sanitization** — deep rabbit hole, needs separate design
|
||||
- **Config validation** — separate concern, deserves its own pass
|
||||
161
docs/superpowers/specs/2026-03-26-runtime-integration-design.md
Normal file
161
docs/superpowers/specs/2026-03-26-runtime-integration-design.md
Normal file
@@ -0,0 +1,161 @@
|
||||
# Script Runtime Integration for owlry-core Daemon
|
||||
|
||||
**Date:** 2026-03-26
|
||||
**Scope:** Wire up Lua/Rune script runtime loading in the daemon, fix ABI mismatch, add filesystem-watching hot-reload, update plugin documentation
|
||||
**Repos:** owlry (core), owlry-plugins (docs only)
|
||||
|
||||
---
|
||||
|
||||
## Problem
|
||||
|
||||
The daemon (`owlry-core`) only loads native plugins from `/usr/lib/owlry/plugins/`. User script plugins in `~/.config/owlry/plugins/` are never discovered because `ProviderManager::new_with_config()` never calls the `LoadedRuntime` infrastructure that already exists in `runtime_loader.rs`. Both Lua and Rune runtimes are installed at `/usr/lib/owlry/runtimes/` and functional, but never invoked.
|
||||
|
||||
Additionally, the Lua runtime's `RuntimeInfo` struct has 5 fields while the core expects 2, causing a SIGSEGV on cleanup.
|
||||
|
||||
---
|
||||
|
||||
## 1. Fix Lua RuntimeInfo ABI mismatch
|
||||
|
||||
**File:** `owlry/crates/owlry-lua/src/lib.rs`
|
||||
|
||||
Shrink Lua's `RuntimeInfo` from 5 fields to 2, matching core and Rune:
|
||||
|
||||
```rust
|
||||
// Before (5 fields — ABI mismatch with core):
|
||||
pub struct RuntimeInfo {
|
||||
pub id: RString,
|
||||
pub name: RString,
|
||||
pub version: RString,
|
||||
pub description: RString,
|
||||
pub api_version: u32,
|
||||
}
|
||||
|
||||
// After (2 fields — matches core/Rune):
|
||||
pub struct RuntimeInfo {
|
||||
pub name: RString,
|
||||
pub version: RString,
|
||||
}
|
||||
```
|
||||
|
||||
Update `runtime_info()` to return only 2 fields. Remove the `LUA_RUNTIME_API_VERSION` constant and `LuaRuntimeVTable` (use the core's `ScriptRuntimeVTable` layout — both already match). The extra metadata (`id`, `description`) was never consumed by the core.
|
||||
|
||||
### Vtable `init` signature change
|
||||
|
||||
Change the `init` function in the vtable to accept the owlry version as a second parameter:
|
||||
|
||||
```rust
|
||||
// Before:
|
||||
pub init: extern "C" fn(plugins_dir: RStr<'_>) -> RuntimeHandle,
|
||||
|
||||
// After:
|
||||
pub init: extern "C" fn(plugins_dir: RStr<'_>, owlry_version: RStr<'_>) -> RuntimeHandle,
|
||||
```
|
||||
|
||||
This applies to:
|
||||
- `owlry-core/src/plugins/runtime_loader.rs` — `ScriptRuntimeVTable.init`
|
||||
- `owlry-lua/src/lib.rs` — `LuaRuntimeVTable.init` and `runtime_init()` implementation
|
||||
- `owlry-rune/src/lib.rs` — `RuneRuntimeVTable.init` and `runtime_init()` implementation
|
||||
|
||||
The core passes its version (`env!("CARGO_PKG_VERSION")` from `owlry-core`) when calling `(vtable.init)(plugins_dir, version)`. Runtimes forward it to `discover_and_load()` instead of hardcoding a version string. This keeps compatibility checks future-proof — no code changes needed on version bumps.
|
||||
|
||||
---
|
||||
|
||||
## 2. Change default entry points to `main`
|
||||
|
||||
**Files:**
|
||||
- `owlry/crates/owlry-lua/src/manifest.rs` — change `default_entry()` from `"init.lua"` to `"main.lua"`
|
||||
- `owlry/crates/owlry-rune/src/manifest.rs` — change `default_entry()` from `"init.rn"` to `"main.rn"`
|
||||
|
||||
Add `#[serde(alias = "entry_point")]` to the `entry` field in both manifests so existing `plugin.toml` files using `entry_point` continue to work.
|
||||
|
||||
---
|
||||
|
||||
## 3. Wire runtime loading into ProviderManager
|
||||
|
||||
**File:** `owlry/crates/owlry-core/src/providers/mod.rs`
|
||||
|
||||
In `ProviderManager::new_with_config()`, after native plugin loading:
|
||||
|
||||
1. Get user plugins directory from `paths::plugins_dir()`
|
||||
2. Get owlry version: `env!("CARGO_PKG_VERSION")`
|
||||
3. Try `LoadedRuntime::load_lua(&plugins_dir, version)` — log at `info!` if unavailable, not error
|
||||
4. Try `LoadedRuntime::load_rune(&plugins_dir, version)` — same
|
||||
5. Call `create_providers()` on each loaded runtime
|
||||
6. Feed runtime providers into existing categorization (static/dynamic/widget)
|
||||
|
||||
`LoadedRuntime::load_lua`, `load_rune`, and `load_from_path` all gain an `owlry_version: &str` parameter, which is passed to `(vtable.init)(plugins_dir, owlry_version)`.
|
||||
|
||||
Store `LoadedRuntime` instances on `ProviderManager` in a new field `runtimes: Vec<LoadedRuntime>`. These must stay alive for the daemon's lifetime (they own the `Library` handle via `Arc`).
|
||||
|
||||
Remove `#![allow(dead_code)]` from `runtime_loader.rs` since it's now used.
|
||||
|
||||
---
|
||||
|
||||
## 4. Filesystem watcher for automatic hot-reload
|
||||
|
||||
**New file:** `owlry/crates/owlry-core/src/plugins/watcher.rs`
|
||||
**Modified:** `owlry/crates/owlry-core/src/providers/mod.rs`, `Cargo.toml`
|
||||
|
||||
### Dependencies
|
||||
|
||||
Add to `owlry-core/Cargo.toml`:
|
||||
```toml
|
||||
notify = "7"
|
||||
notify-debouncer-mini = "0.5"
|
||||
```
|
||||
|
||||
### Watcher design
|
||||
|
||||
After initializing runtimes, spawn a background watcher thread:
|
||||
|
||||
1. Watch `~/.config/owlry/plugins/` recursively using `notify-debouncer-mini` with 500ms debounce
|
||||
2. On debounced event (any file create/modify/delete):
|
||||
- Acquire write lock on `ProviderManager`
|
||||
- Remove all runtime-backed providers from the provider vecs
|
||||
- Drop old `LoadedRuntime` instances
|
||||
- Re-load runtimes from `/usr/lib/owlry/runtimes/` with fresh plugin discovery
|
||||
- Add new runtime providers to provider vecs
|
||||
- Refresh the new providers
|
||||
- Release write lock
|
||||
|
||||
### Provider tracking
|
||||
|
||||
`ProviderManager` needs to distinguish runtime providers from native/core providers for selective removal during reload. Options:
|
||||
|
||||
- **Tag-based:** Runtime providers already use `ProviderType::Plugin(type_id)`. Keep a `HashSet<String>` of type_ids that came from runtimes. On reload, remove providers whose type_id is in the set.
|
||||
- **Separate storage:** Store runtime providers in their own vec, separate from native providers. Query merges results from both.
|
||||
|
||||
**Chosen: Tag-based.** Simpler — runtime type_ids are tracked in a `runtime_type_ids: HashSet<String>` on `ProviderManager`. Reload clears the set, removes matching providers, then re-adds.
|
||||
|
||||
### Thread communication
|
||||
|
||||
The watcher thread needs access to `Arc<RwLock<ProviderManager>>`. The `Server` already holds this Arc. Pass a clone to the watcher thread at startup. The watcher acquires `write()` only during reload (~10ms), so read contention is minimal.
|
||||
|
||||
### Watcher lifecycle
|
||||
|
||||
- Started in `Server::run()` (or `Server::bind()`) before the accept loop
|
||||
- Runs until the daemon exits (watcher thread is detached or joined on drop)
|
||||
- Errors in the watcher (e.g., inotify limit exceeded) are logged and the watcher stops — daemon continues without hot-reload
|
||||
|
||||
---
|
||||
|
||||
## 5. Plugin development documentation
|
||||
|
||||
**File:** `owlry-plugins/docs/PLUGIN_DEVELOPMENT.md`
|
||||
|
||||
Cover:
|
||||
- **Plugin directory structure** — `~/.config/owlry/plugins/<name>/plugin.toml` + `main.lua`/`main.rn`
|
||||
- **Manifest reference** — all `plugin.toml` fields (`id`, `name`, `version`, `description`, `entry`/`entry_point`, `owlry_version`, `[[providers]]` section, `[permissions]` section)
|
||||
- **Lua plugin guide** — `owlry.provider.register()` API with `refresh` and `query` callbacks, item table format (`id`, `name`, `command`, `description`, `icon`, `terminal`, `tags`)
|
||||
- **Rune plugin guide** — `pub fn refresh()` and `pub fn query(q)` signatures, `Item::new()` builder, `use owlry::Item`
|
||||
- **Hot-reload** — changes are picked up automatically, no daemon restart needed
|
||||
- **Examples** — complete working examples for both Lua and Rune
|
||||
|
||||
---
|
||||
|
||||
## Out of scope
|
||||
|
||||
- Config-gated runtime loading (runtimes self-skip if `.so` not installed)
|
||||
- Per-plugin selective reload (full runtime reload is fast enough)
|
||||
- Plugin registry/installation (already exists in the CLI)
|
||||
- Sandbox enforcement (separate concern, deferred from hardening spec)
|
||||
13
justfile
13
justfile
@@ -328,7 +328,7 @@ bump-meta new_version:
|
||||
|
||||
# === Testing ===
|
||||
|
||||
# Test a specific AUR package build locally
|
||||
# Quick local build test (no chroot, uses host deps)
|
||||
aur-test-pkg pkg:
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
@@ -337,3 +337,14 @@ aur-test-pkg pkg:
|
||||
makepkg -sf
|
||||
echo "Package built successfully!"
|
||||
ls -lh *.pkg.tar.zst
|
||||
|
||||
# Build AUR packages from the local working tree in a clean chroot.
|
||||
# Packages current source (incl. uncommitted changes), patches PKGBUILD,
|
||||
# builds in dep order, injects local artifacts, restores PKGBUILD on exit.
|
||||
#
|
||||
# Examples:
|
||||
# just aur-local-test owlry-core
|
||||
# just aur-local-test -c owlry-core owlry-rune
|
||||
# just aur-local-test --all --reset
|
||||
aur-local-test *args:
|
||||
scripts/aur-local-test {{args}}
|
||||
|
||||
373
scripts/aur-local-test
Executable file
373
scripts/aur-local-test
Executable file
@@ -0,0 +1,373 @@
|
||||
#!/usr/bin/env bash
|
||||
# scripts/aur-local-test
|
||||
#
|
||||
# Build AUR packages from the local working tree in a clean extra chroot.
|
||||
#
|
||||
# Packages the current working tree (including uncommitted changes) into a
|
||||
# tarball, temporarily patches each PKGBUILD to use it, runs
|
||||
# extra-x86_64-build, then restores the PKGBUILD on exit regardless of
|
||||
# success or failure.
|
||||
#
|
||||
# Packages with local AUR deps (e.g. owlry-rune depends on owlry-core) are
|
||||
# built in topological order and their artifacts injected automatically.
|
||||
#
|
||||
# Usage: scripts/aur-local-test [OPTIONS] [PKG...]
|
||||
# See --help for details.
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
REPO_ROOT="$(git -C "$SCRIPT_DIR" rev-parse --show-toplevel)"
|
||||
REPO_NAME="$(basename "$REPO_ROOT")"
|
||||
AUR_DIR="$REPO_ROOT/aur"
|
||||
|
||||
# State tracked for cleanup
|
||||
TMP_TARBALL=""
|
||||
declare -a PKGBUILD_BACKUPS=()
|
||||
declare -a PLACED_FILES=()
|
||||
|
||||
# Build config
|
||||
RESET_CHROOT=0
|
||||
declare -a INPUT_PKGS=()
|
||||
declare -a EXTRA_INJECT=() # --inject paths (external AUR deps)
|
||||
|
||||
# ─── Output helpers ──────────────────────────────────────────────────────────
|
||||
|
||||
die() { echo "error: $*" >&2; exit 1; }
|
||||
info() { printf '\033[1;34m==>\033[0m %s\n' "$*"; }
|
||||
ok() { printf '\033[1;32m ->\033[0m %s\n' "$*"; }
|
||||
warn() { printf '\033[1;33m !\033[0m %s\n' "$*" >&2; }
|
||||
fail() { printf '\033[1;31mFAIL\033[0m %s\n' "$*" >&2; }
|
||||
|
||||
# ─── Cleanup ─────────────────────────────────────────────────────────────────
|
||||
|
||||
cleanup() {
|
||||
local code=$?
|
||||
local f pkgbuild
|
||||
|
||||
# Remove tarballs placed in aur/ dirs
|
||||
for f in "${PLACED_FILES[@]+"${PLACED_FILES[@]}"}"; do
|
||||
[[ -f "$f" ]] && rm -f "$f"
|
||||
done
|
||||
|
||||
# Restore patched PKGBUILDs from backups
|
||||
for f in "${PKGBUILD_BACKUPS[@]+"${PKGBUILD_BACKUPS[@]}"}"; do
|
||||
pkgbuild="${f%.bak}"
|
||||
[[ -f "$f" ]] && mv "$f" "$pkgbuild"
|
||||
done
|
||||
|
||||
[[ -n "$TMP_TARBALL" && -f "$TMP_TARBALL" ]] && rm -f "$TMP_TARBALL"
|
||||
|
||||
exit "$code"
|
||||
}
|
||||
trap cleanup EXIT INT TERM
|
||||
|
||||
# ─── Usage ───────────────────────────────────────────────────────────────────
|
||||
|
||||
usage() {
|
||||
cat >&2 <<EOF
|
||||
Usage: $(basename "$0") [OPTIONS] [PKG...]
|
||||
|
||||
Build AUR packages from the local working tree in a clean chroot.
|
||||
Packages current working tree (incl. uncommitted changes), patches PKGBUILD
|
||||
source + checksum, runs extra-x86_64-build, then restores on exit.
|
||||
|
||||
Packages with local AUR deps are built in topological order and their
|
||||
.pkg.tar.zst artifacts are injected into dependent builds automatically.
|
||||
|
||||
OPTIONS
|
||||
-c, --reset Reset chroot matrix (passes -c to extra-x86_64-build).
|
||||
Only applied to the first package; subsequent builds
|
||||
reuse the already-fresh chroot.
|
||||
-a, --all Build all packages in aur/ (respects dep order).
|
||||
-I, --inject FILE Inject FILE (.pkg.tar.zst) into the chroot before
|
||||
building. For AUR deps not in the official repos
|
||||
(e.g. owlry-core when testing owlry-plugins).
|
||||
Can be repeated.
|
||||
-h, --help Show this help.
|
||||
|
||||
EXAMPLES
|
||||
# Single package
|
||||
$(basename "$0") owlry-core
|
||||
|
||||
# Multiple packages with chroot reset
|
||||
$(basename "$0") -c owlry-core owlry-rune
|
||||
|
||||
# All packages in dependency order
|
||||
$(basename "$0") --all --reset
|
||||
|
||||
# owlry-plugins: inject owlry-core from sibling repo
|
||||
$(basename "$0") -I ../owlry/aur/owlry-core/owlry-core-*.pkg.tar.zst --all
|
||||
EOF
|
||||
exit 1
|
||||
}
|
||||
|
||||
# ─── Argument parsing ────────────────────────────────────────────────────────
|
||||
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case "$1" in
|
||||
-c|--reset)
|
||||
RESET_CHROOT=1
|
||||
shift ;;
|
||||
-a|--all)
|
||||
for dir in "$AUR_DIR"/*/; do
|
||||
pkg=$(basename "$dir")
|
||||
[[ -f "$dir/PKGBUILD" ]] && INPUT_PKGS+=("$pkg")
|
||||
done
|
||||
shift ;;
|
||||
-I|--inject)
|
||||
[[ $# -ge 2 ]] || die "--inject requires an argument"
|
||||
[[ -f "$2" ]] || die "inject file not found: $2"
|
||||
EXTRA_INJECT+=("$(realpath "$2")")
|
||||
shift 2 ;;
|
||||
-h|--help) usage ;;
|
||||
-*) die "unknown option: $1" ;;
|
||||
*)
|
||||
if [[ "$1" == *.pkg.tar.zst ]]; then
|
||||
[[ -f "$1" ]] || die "inject file not found: $1"
|
||||
EXTRA_INJECT+=("$(realpath "$1")")
|
||||
else
|
||||
INPUT_PKGS+=("$1")
|
||||
fi
|
||||
shift ;;
|
||||
esac
|
||||
done
|
||||
|
||||
[[ ${#INPUT_PKGS[@]} -eq 0 ]] && usage
|
||||
|
||||
# ─── Inject deduplication ────────────────────────────────────────────────────
|
||||
|
||||
# Extract the package name from a .pkg.tar.zst filename.
|
||||
# Arch package filenames follow: {pkgname}-{pkgver}-{pkgrel}-{arch}.pkg.tar.zst
|
||||
# pkgver is guaranteed to have no dashes, so stripping the last three
|
||||
# dash-separated segments leaves pkgname.
|
||||
pkg_name_from_file() {
|
||||
local base
|
||||
base=$(basename "$1" .pkg.tar.zst)
|
||||
base="${base%-*}" # strip arch
|
||||
base="${base%-*}" # strip pkgrel
|
||||
base="${base%-*}" # strip pkgver (no dashes in pkgver by Arch policy)
|
||||
echo "$base"
|
||||
}
|
||||
|
||||
# Deduplicate a list of .pkg.tar.zst paths by package name.
|
||||
# When the same package name appears more than once, keep the highest version
|
||||
# (determined by sort -V on the filenames) and warn about the dropped ones.
|
||||
dedup_inject_files() {
|
||||
[[ $# -eq 0 ]] && return 0
|
||||
local -A best=()
|
||||
local f name winner
|
||||
for f in "$@"; do
|
||||
name=$(pkg_name_from_file "$f")
|
||||
if [[ -v "best[$name]" ]]; then
|
||||
winner=$(printf '%s\n%s\n' "${best[$name]}" "$f" | sort -V | tail -1)
|
||||
if [[ "$winner" == "$f" ]]; then
|
||||
warn "Dropping duplicate inject (older): $(basename "${best[$name]}")"
|
||||
best[$name]="$f"
|
||||
else
|
||||
warn "Dropping duplicate inject (older): $(basename "$f")"
|
||||
fi
|
||||
else
|
||||
best[$name]="$f"
|
||||
fi
|
||||
done
|
||||
printf '%s\n' "${best[@]}"
|
||||
}
|
||||
|
||||
# ─── Dependency resolution ───────────────────────────────────────────────────
|
||||
|
||||
# Return the names of local AUR packages that PKG depends on.
|
||||
local_deps_of() {
|
||||
local pkg="$1"
|
||||
local pkgbuild="$AUR_DIR/$pkg/PKGBUILD"
|
||||
[[ -f "$pkgbuild" ]] || return 0
|
||||
|
||||
local dep_line bare
|
||||
dep_line=$(grep '^depends=' "$pkgbuild" 2>/dev/null | head -1 || true)
|
||||
[[ -z "$dep_line" ]] && return 0
|
||||
|
||||
# Strip depends=, parens, and quotes; split on whitespace
|
||||
echo "$dep_line" \
|
||||
| sed "s/^depends=//; s/[()\"']/ /g" \
|
||||
| tr ' ' '\n' \
|
||||
| while IFS= read -r dep; do
|
||||
[[ -z "$dep" ]] && continue
|
||||
bare="${dep%%[><=]*}" # strip version constraints
|
||||
[[ -d "$AUR_DIR/$bare" ]] && echo "$bare"
|
||||
done
|
||||
}
|
||||
|
||||
# Topological sort (DFS) — deps before dependents.
|
||||
declare -A TOPO_VISITED=()
|
||||
declare -a TOPO_ORDER=()
|
||||
|
||||
topo_visit() {
|
||||
local pkg="$1"
|
||||
[[ -v "TOPO_VISITED[$pkg]" ]] && return 0
|
||||
TOPO_VISITED[$pkg]=1
|
||||
local dep
|
||||
while IFS= read -r dep; do
|
||||
topo_visit "$dep"
|
||||
done < <(local_deps_of "$pkg")
|
||||
TOPO_ORDER+=("$pkg")
|
||||
}
|
||||
|
||||
resolve_order() {
|
||||
TOPO_VISITED=()
|
||||
TOPO_ORDER=()
|
||||
local pkg
|
||||
for pkg in "$@"; do
|
||||
topo_visit "$pkg"
|
||||
done
|
||||
}
|
||||
|
||||
# ─── Tarball creation ────────────────────────────────────────────────────────
|
||||
|
||||
make_tarball() {
|
||||
TMP_TARBALL=$(mktemp /tmp/aur-local-XXXXXX.tar.gz)
|
||||
info "Packaging ${REPO_NAME} working tree (incl. uncommitted changes)..."
|
||||
tar czf "$TMP_TARBALL" \
|
||||
--exclude='.git' \
|
||||
--exclude='target' \
|
||||
--transform "s|^\.|${REPO_NAME}|" \
|
||||
-C "$REPO_ROOT" .
|
||||
ok "Tarball ready: $(du -b "$TMP_TARBALL" | cut -f1 | numfmt --to=iec 2>/dev/null || wc -c < "$TMP_TARBALL") bytes"
|
||||
}
|
||||
|
||||
# ─── PKGBUILD patching ───────────────────────────────────────────────────────
|
||||
|
||||
# Patch a package's PKGBUILD to use the local tarball.
|
||||
# Backs up the original; cleanup() restores it on exit.
|
||||
patch_pkgbuild() {
|
||||
local pkg="$1"
|
||||
local pkgbuild="$AUR_DIR/$pkg/PKGBUILD"
|
||||
local pkgdir="$AUR_DIR/$pkg"
|
||||
|
||||
# Skip packages with no remote source (meta/group packages)
|
||||
if ! grep -q '^source=' "$pkgbuild" || grep -qE '^source=\(\s*\)' "$pkgbuild"; then
|
||||
ok "No source URL to patch — skipping tarball injection for $pkg"
|
||||
return 0
|
||||
fi
|
||||
|
||||
local pkgname pkgver filename hash
|
||||
pkgname=$(grep '^pkgname=' "$pkgbuild" | cut -d= -f2- | tr -d "\"'")
|
||||
pkgver=$(grep '^pkgver=' "$pkgbuild" | cut -d= -f2- | tr -d "\"'")
|
||||
filename="${pkgname}-${pkgver}.tar.gz"
|
||||
hash=$(b2sum "$TMP_TARBALL" | cut -d' ' -f1)
|
||||
|
||||
# Backup original PKGBUILD
|
||||
cp "$pkgbuild" "${pkgbuild}.bak"
|
||||
PKGBUILD_BACKUPS+=("${pkgbuild}.bak")
|
||||
|
||||
# Place local tarball where makepkg looks for it
|
||||
cp "$TMP_TARBALL" "$pkgdir/$filename"
|
||||
PLACED_FILES+=("$pkgdir/$filename")
|
||||
|
||||
# Patch source and checksum lines in-place
|
||||
sed -i "s|^source=.*|source=(\"${filename}\")|" "$pkgbuild"
|
||||
sed -i "s|^b2sums=.*|b2sums=('${hash}')|" "$pkgbuild"
|
||||
|
||||
ok "Patched PKGBUILD: source=${filename}, b2sum=${hash:0:12}…"
|
||||
}
|
||||
|
||||
# ─── Build ───────────────────────────────────────────────────────────────────
|
||||
|
||||
# built_artifacts[pkg] = path to the .pkg.tar.zst produced in this run.
|
||||
# Used to inject pkg artifacts into dependent builds.
|
||||
declare -A BUILT_ARTIFACTS=()
|
||||
|
||||
find_artifact() {
|
||||
local pkg="$1"
|
||||
local pkgver
|
||||
# pkgver is the same in patched and original PKGBUILD
|
||||
pkgver=$(grep '^pkgver=' "$AUR_DIR/$pkg/PKGBUILD" | cut -d= -f2- | tr -d "\"'" \
|
||||
|| grep '^pkgver=' "$AUR_DIR/$pkg/PKGBUILD.bak" | cut -d= -f2- | tr -d "\"'")
|
||||
ls "$AUR_DIR/$pkg/${pkg}-${pkgver}-"*".pkg.tar.zst" 2>/dev/null \
|
||||
| grep -v -- '-debug-' | sort -V | tail -1 || true
|
||||
}
|
||||
|
||||
build_one() {
|
||||
local pkg="$1"
|
||||
local pkgdir="$AUR_DIR/$pkg"
|
||||
|
||||
info "[$pkg] Patching PKGBUILD..."
|
||||
patch_pkgbuild "$pkg"
|
||||
|
||||
# Collect inject args: extra (external) + artifacts of local deps built earlier
|
||||
local inject=()
|
||||
for f in "${EXTRA_INJECT[@]+"${EXTRA_INJECT[@]}"}"; do
|
||||
inject+=("-I" "$f")
|
||||
done
|
||||
while IFS= read -r dep; do
|
||||
if [[ -v "BUILT_ARTIFACTS[$dep]" ]]; then
|
||||
inject+=("-I" "${BUILT_ARTIFACTS[$dep]}")
|
||||
else
|
||||
warn "$pkg depends on $dep (local AUR) which was not built in this run"
|
||||
warn " → Build $dep first or pass: -I path/to/${dep}-*.pkg.tar.zst"
|
||||
fi
|
||||
done < <(local_deps_of "$pkg")
|
||||
|
||||
# Build args: -c only on the first package, then cleared
|
||||
local build_args=()
|
||||
if [[ $RESET_CHROOT -eq 1 ]]; then
|
||||
build_args+=("-c")
|
||||
RESET_CHROOT=0
|
||||
fi
|
||||
|
||||
info "[$pkg] Running extra-x86_64-build..."
|
||||
(
|
||||
cd "$pkgdir"
|
||||
if [[ ${#inject[@]} -gt 0 ]]; then
|
||||
extra-x86_64-build "${build_args[@]+"${build_args[@]}"}" -- "${inject[@]}"
|
||||
else
|
||||
extra-x86_64-build "${build_args[@]+"${build_args[@]}"}"
|
||||
fi
|
||||
)
|
||||
|
||||
# Record artifact for potential injection into dependents
|
||||
local artifact
|
||||
artifact=$(find_artifact "$pkg")
|
||||
if [[ -n "$artifact" ]]; then
|
||||
BUILT_ARTIFACTS[$pkg]="$artifact"
|
||||
ok "[$pkg] artifact: $(basename "$artifact")"
|
||||
fi
|
||||
}
|
||||
|
||||
# ─── Main ────────────────────────────────────────────────────────────────────
|
||||
|
||||
# Deduplicate external inject files by package name (keep highest version)
|
||||
if [[ ${#EXTRA_INJECT[@]} -gt 1 ]]; then
|
||||
mapfile -t EXTRA_INJECT < <(dedup_inject_files "${EXTRA_INJECT[@]}")
|
||||
fi
|
||||
|
||||
# Validate all requested packages exist
|
||||
for pkg in "${INPUT_PKGS[@]}"; do
|
||||
[[ -d "$AUR_DIR/$pkg" && -f "$AUR_DIR/$pkg/PKGBUILD" ]] \
|
||||
|| die "package not found: aur/$pkg/PKGBUILD"
|
||||
done
|
||||
|
||||
# Sort into build order (deps before dependents)
|
||||
resolve_order "${INPUT_PKGS[@]}"
|
||||
|
||||
# Create one tarball, reused for all packages in this run
|
||||
make_tarball
|
||||
|
||||
declare -a FAILED=()
|
||||
|
||||
for pkg in "${TOPO_ORDER[@]}"; do
|
||||
echo ""
|
||||
if build_one "$pkg"; then
|
||||
:
|
||||
else
|
||||
fail "[$pkg]"
|
||||
FAILED+=("$pkg")
|
||||
fi
|
||||
done
|
||||
|
||||
echo ""
|
||||
if [[ ${#FAILED[@]} -gt 0 ]]; then
|
||||
fail "packages failed: ${FAILED[*]}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
info "All packages built successfully!"
|
||||
Reference in New Issue
Block a user