Skip to content

Add Plugin API #2152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
lancepioch wants to merge 2 commits into
base: main
Choose a base branch
from
+342 −0
Draft

Add Plugin API #2152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c5a443
Add plugin api
lancepioch Jan 29, 2026
8f63592
Add basic info to application api
lancepioch Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions app/Http/Controllers/Api/Application/PanelController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?php

namespace App\Http\Controllers\Api\Application;

use App\Http\Requests\Api\Application\GetPanelInfoRequest;
use App\Transformers\Api\Application\PanelInfoTransformer;

class PanelController extends ApplicationApiController
{
/**
* Get panel statistics
*
* Returns panel information
*
* @return array<mixed>
*/
public function __invoke(GetPanelInfoRequest $request): array
{
return $this->fractal->item(null)
->transformWith($this->getTransformer(PanelInfoTransformer::class))
->toArray();
}
}
125 changes: 125 additions & 0 deletions app/Http/Controllers/Api/Application/Plugins/PluginController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
<?php

namespace App\Http\Controllers\Api\Application\Plugins;

use App\Http\Controllers\Api\Application\ApplicationApiController;
use App\Http\Requests\Api\Application\Plugins\GetPluginsRequest;
use App\Http\Requests\Api\Application\Plugins\ImportPluginRequest;
use App\Http\Requests\Api\Application\Plugins\PluginWriteRequest;
use App\Models\Plugin;
use App\Services\Helpers\PluginService;
use App\Transformers\Api\Application\PluginTransformer;
use Illuminate\Http\Response;

class PluginController extends ApplicationApiController
{
public function __construct(private PluginService $pluginService)
{
parent::__construct();
}

/**
* List all plugins
*
* Returns all plugins without pagination
*
* @return array<mixed>
*/
public function index(GetPluginsRequest $request): array
{
return $this->fractal->collection(Plugin::all())
->transformWith($this->getTransformer(PluginTransformer::class))
->toArray();
}

/**
* Install a plugin
*
* Runs migrations, seeders, and enables the plugin
*
* @return array<mixed>
*/
public function install(PluginWriteRequest $request, Plugin $plugin): array
{
$this->pluginService->installPlugin($plugin);

return $this->fractal->item($plugin->fresh())
->transformWith($this->getTransformer(PluginTransformer::class))
->toArray();
}

/**
* Enable a plugin
*
* @return array<mixed>
*/
public function enable(PluginWriteRequest $request, Plugin $plugin): array
{
$this->pluginService->enablePlugin($plugin);

return $this->fractal->item($plugin->fresh())
->transformWith($this->getTransformer(PluginTransformer::class))
->toArray();
}

/**
* Disable a plugin
*
* @return array<mixed>
*/
public function disable(PluginWriteRequest $request, Plugin $plugin): array
{
$this->pluginService->disablePlugin($plugin);

return $this->fractal->item($plugin->fresh())
->transformWith($this->getTransformer(PluginTransformer::class))
->toArray();
}

/**
* Uninstall a plugin
*
* Rolls back migrations and removes the plugin files
*/
public function uninstall(PluginWriteRequest $request, Plugin $plugin): Response
{
$this->pluginService->uninstallPlugin($plugin, deleteFiles: true);

return $this->returnNoContent();
}

/**
* Update a plugin
*
* Downloads and installs the latest version
*
* @return array<mixed>
*/
public function update(PluginWriteRequest $request, Plugin $plugin): array
{
$this->pluginService->updatePlugin($plugin);

return $this->fractal->item($plugin->fresh())
->transformWith($this->getTransformer(PluginTransformer::class))
->toArray();
}

/**
* Import a plugin from URL
*
* Downloads and extracts a plugin from a remote URL
*
* @return array<mixed>
*/
public function import(ImportPluginRequest $request): array
{
$this->pluginService->downloadPluginFromUrl($request->input('url'));

// The plugin model needs to be refreshed to get the new data
Plugin::clearBootedModels();

return $this->fractal->collection(Plugin::all())
->transformWith($this->getTransformer(PluginTransformer::class))
->toArray();
}
}
18 changes: 18 additions & 0 deletions app/Http/Requests/Api/Application/GetPanelInfoRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php

namespace App\Http\Requests\Api\Application;

use App\Services\Acl\Api\AdminAcl;

class GetPanelInfoRequest extends ApplicationApiRequest
{
protected ?string $resource = 'panel';

protected int $permission = AdminAcl::READ;

public function authorize(): bool
{
// Any valid application API key can access panel information
return $this->user() !== null;
}
}
14 changes: 14 additions & 0 deletions app/Http/Requests/Api/Application/Plugins/GetPluginsRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?php

namespace App\Http\Requests\Api\Application\Plugins;

use App\Http\Requests\Api\Application\ApplicationApiRequest;
use App\Models\Plugin;
use App\Services\Acl\Api\AdminAcl;

class GetPluginsRequest extends ApplicationApiRequest
{
protected ?string $resource = Plugin::RESOURCE_NAME;

protected int $permission = AdminAcl::READ;
}
22 changes: 22 additions & 0 deletions app/Http/Requests/Api/Application/Plugins/ImportPluginRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?php

namespace App\Http\Requests\Api\Application\Plugins;

use App\Http\Requests\Api\Application\ApplicationApiRequest;
use App\Models\Plugin;
use App\Services\Acl\Api\AdminAcl;

class ImportPluginRequest extends ApplicationApiRequest
{
protected ?string $resource = Plugin::RESOURCE_NAME;

protected int $permission = AdminAcl::WRITE;

/** @return array<string, string|string[]> */
public function rules(): array
{
return [
'url' => ['required', 'string', 'url'],
];
}
}
14 changes: 14 additions & 0 deletions app/Http/Requests/Api/Application/Plugins/PluginWriteRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?php

namespace App\Http\Requests\Api\Application\Plugins;

use App\Http\Requests\Api\Application\ApplicationApiRequest;
use App\Models\Plugin;
use App\Services\Acl\Api\AdminAcl;

class PluginWriteRequest extends ApplicationApiRequest
{
protected ?string $resource = Plugin::RESOURCE_NAME;

protected int $permission = AdminAcl::WRITE;
}
1 change: 1 addition & 0 deletions app/Models/ApiKey.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ public function getPermission(string $resource): int
Database::RESOURCE_NAME,
Mount::RESOURCE_NAME,
Role::RESOURCE_NAME,
Plugin::RESOURCE_NAME,
];

/** @var string[] */
Expand Down
2 changes: 2 additions & 0 deletions app/Models/Plugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ class Plugin extends Model implements HasPluginSettings
{
use Sushi;

public const RESOURCE_NAME = 'plugin';

protected $primaryKey = 'id';

protected $keyType = 'string';
Expand Down
53 changes: 53 additions & 0 deletions app/Transformers/Api/Application/PanelInfoTransformer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<?php

namespace App\Transformers\Api\Application;

use App\Services\Helpers\SoftwareVersionService;

class PanelInfoTransformer extends BaseTransformer
{
private SoftwareVersionService $versionService;

public function handle(SoftwareVersionService $versionService): void
{
$this->versionService = $versionService;
}

public function getResourceName(): string
{
return 'panel';
}

/**
* @param null $model
*/
public function transform($model): array
{
$currentVersion = config('app.version', 'canary');

return [
'version' => $currentVersion,
'git_hash' => $this->getGitHash(),
'fqdn' => parse_url(config('app.url'), PHP_URL_HOST),
'url' => config('app.url'),
'timezone' => config('app.timezone'),
'latest_version' => $this->versionService->latestPanelVersion(),
'is_latest' => $this->versionService->isLatestPanel(),
];
}

private function getGitHash(): ?string
{
if (file_exists(base_path('.git/HEAD'))) {
$head = explode(' ', file_get_contents(base_path('.git/HEAD')));
if (array_key_exists(1, $head)) {
$path = base_path('.git/' . trim($head[1]));
if (file_exists($path)) {
return substr(file_get_contents($path), 0, 7);
}
}
}

return null;
}
}
42 changes: 42 additions & 0 deletions app/Transformers/Api/Application/PluginTransformer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<?php

namespace App\Transformers\Api\Application;

use App\Models\Plugin;

class PluginTransformer extends BaseTransformer
{
public function getResourceName(): string
{
return Plugin::RESOURCE_NAME;
}

/**
* @param Plugin $model
*/
public function transform($model): array
{
return [
'id' => $model->id,
'name' => $model->name,
'author' => $model->author,
'version' => $model->version,
'description' => $model->description,
'category' => $model->category->value,
'url' => $model->url,
'update_url' => $model->update_url,
'namespace' => $model->namespace,
'class' => $model->class,
'panels' => $model->panels,
'panel_version' => $model->panel_version,
'status' => $model->status->value,
'status_message' => $model->status_message,
'load_order' => $model->load_order,
'is_compatible' => $model->isCompatible(),
'is_update_available' => $model->isUpdateAvailable(),
'has_settings' => $model->hasSettings(),
'can_enable' => $model->canEnable(),
'can_disable' => $model->canDisable(),
];
}
}
28 changes: 28 additions & 0 deletions routes/api-application.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,3 +172,31 @@

Route::delete('/{role:id}', [Application\Roles\RoleController::class, 'delete']);
});

/*
|--------------------------------------------------------------------------
| Panel Stats Controller Routes
|--------------------------------------------------------------------------
|
| Endpoint: /api/application/panel
|
*/
Route::get('/panel', Application\PanelController::class)->name('api.application.panel');

/*
|--------------------------------------------------------------------------
| Plugin Controller Routes
|--------------------------------------------------------------------------
|
| Endpoint: /api/application/plugins
|
*/
Route::prefix('/plugins')->group(function () {
Route::get('/', [Application\Plugins\PluginController::class, 'index'])->name('api.application.plugins');
Route::post('/import', [Application\Plugins\PluginController::class, 'import'])->name('api.application.plugins.import');
Route::post('/{plugin:id}/install', [Application\Plugins\PluginController::class, 'install'])->name('api.application.plugins.install');
Route::post('/{plugin:id}/update', [Application\Plugins\PluginController::class, 'update'])->name('api.application.plugins.update');
Route::patch('/{plugin:id}/enable', [Application\Plugins\PluginController::class, 'enable'])->name('api.application.plugins.enable');
Route::patch('/{plugin:id}/disable', [Application\Plugins\PluginController::class, 'disable'])->name('api.application.plugins.disable');
Route::delete('/{plugin:id}', [Application\Plugins\PluginController::class, 'uninstall'])->name('api.application.plugins.uninstall');
});