Skip to content

Latest commit

 

History

History
75 lines (60 loc) · 6.88 KB

splify2-api-1.1.md

File metadata and controls

75 lines (60 loc) · 6.88 KB

splify2-api 1.1 — что добавлено к 1.0

splify2 26.11 говорит splify2-api 1.1 (SDK 1.3.0). Это прибавка к splify2-api.md: плагин, написанный по 1.0, работает без изменений. Плагину, которому нужно новое, пишут compat.splify2-api: "^1.1"; хост отдаёт свою версию в plugins_list (splify2_api). Тест совместимости — sh tests/compat/run.sh <каталог плагина> 1.1 (заглушка tests/compat/splify2-1.1/).

Нужда, из которой выросло: интерфейс Andromeda переезжает из пакета splify2 в плагин andromeda (SPLIFY2_PLATFORM.md, раздел 6). Плагину нужны два шва, которых в 1.0 не было: подменить главный экран каркаса и узнать у хоста каталоги, которые он зашивал в код.

1. splify2.luci.interface: плагин подменяет главный экран

"compat": { "splify2-api": "^1.1" },
"splify2": { "luci": { "interface": "luci/home.js" } }
  • Значение — путь прямо в каталоге luci/ плагина (luci/<имя>.js, без вложенных каталогов): вид LuCI (view.extend), который рисует главный экран. Рядом в luci/ плагин может держать всё, что нужно виду: сборку интерфейса, стили, шрифты. Это единственный каталог плагина, который раздаёт веб-сервер для вида; ui/ по-прежнему раздаётся как интерфейс хоста по host-api.
  • plugin_sync (после установки, включения, отключения и снятия плагина и при установке пакета splify2) ведёт ссылку /www/luci-static/resources/view/splify2/p-<id> → <каталог плагина>/luci для каждого включённого плагина с luci.interface и убирает остальные. LuCI грузит вид как модуль view.splify2.p-<id>.<имя>, а файлы рядом доступны по адресу /luci-static/resources/view/splify2/p-<id>/<файл> (L.resource('view/splify2/p-<id>/<файл>')).
  • Какой интерфейс откроется на странице splify2 (admin/services/splify2, адрес меню не меняется), решает настройка interface (prefs_set): basic — вид самого каркаса, <id> — интерфейс плагина. Пока выбор не сделан, откроется интерфейс плагина andromeda, если он стоит и включён, иначе basic. Настройка называет плагин, которого нет или который отключён, — открывается basic.
  • ?basic=1 в адресе страницы всегда открывает вид каркаса, ?basic=0 — интерфейс плагина andromeda; ни то ни другое не запоминается. Если вид плагина не загрузился (плагин снят, файл не найден), каркас открывает свой вид с сообщением, а не пустую страницу. Безопасный режим (/etc/splify2/safe) всегда открывает вид каркаса.
  • prefs_get отвечает перечнем: interfaces: [{id, view}] (view — имя модуля view.splify2.p-<id>.<имя>) и прежними полями interface, interface_set, andromeda.
  • Право: заявлять отдельное право не нужно — выбор интерфейса остаётся за человеком (prefs_set), плагин сам ничего не подменяет.
  • Таймаут вызовов ubus (L.env.rpctimeout, не меньше 120 с: установки идут долго) выставляет вид каркаса view/splify2/index.js, а не вид плагина.
  • s2p lint: путь luci/<имя>.js, файл есть, compat.splify2-api не включает 1.0.

splify2.luci.views и splify2.luci.tabs по-прежнему зарезервированы.

2. Метод paths: где хост держит каталоги

Новая строка methods.tsv: paths — вид frame, права read. Это тот же ответ, что служба хоста paths для программ плагина (splify2-api.md), для интерфейса в браузере:

{ "ok": true, "lists": "/etc/steer/lists", "spec_dir": "/etc/steer", "subs_dir": "/etc/steer/subs", "steer": "/usr/bin/steer" }
Поле Что
lists каталог списков: спека называет списки путями под ним
spec_dir каталог спеки: относительные пути в спеке (подписка, файл ключа) отсчитываются от него
subs_dir каталог подписок
steer программа ядра

Раньше интерфейс зашивал /etc/steer/lists/ и /etc/steer/ сам и держал дубль правила бэкенда. Интерфейс берёт каталоги у хоста, зашитое значение остаётся только запасным до первого ответа. Новое поле ответа — minor.

3. Версии

  • PLUGIN_SPLIFY2_API хоста — 1.1.0; файл /usr/share/splify2/compat/splify2-api пишет сборка пакета.
  • Строка tests/compat/matrix.json: SDK 1.3.0 — splify2 26.11.0 — splify2-api 1.1.0, host-api 1.0.0, steer-api 1.3.0.
  • s2p lint сверяет compat.splify2-api с 1.1.0.

4. Семя плагинов splify2

Не часть API плагина, а соглашение пакета (как у steer-core, s2p.md): пакет splify2 несёт подписанные .s2p плагинов «из коробки» в /usr/share/splify2/seed/ и ставит их при установке и обновлении командой splify2-seed через steer plugin install --file. Плагин ничего для этого не делает: достаточно быть в официальном репозитории splify2-core-plugins с признаком «из коробки» (default: true в индексе) и попасть в семя при сборке выпуска пакета.