mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
70c2c543f3
* Plugin Update Extract interfaces for use in plugin packages # Conflicts: # composer.lock * Fix some issues settings_view -> content_view
100 lines
3.2 KiB
PHP
100 lines
3.2 KiB
PHP
<?php
|
|
/*
|
|
* PluginProvider.php
|
|
*
|
|
* -Description-
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* @package LibreNMS
|
|
* @link http://librenms.org
|
|
* @copyright 2021 Tony Murray
|
|
* @author Tony Murray <murraytony@gmail.com>
|
|
*/
|
|
|
|
namespace App\Providers;
|
|
|
|
use App\Exceptions\PluginDoesNotImplementHookException;
|
|
use Illuminate\Support\ServiceProvider;
|
|
use Illuminate\Support\Str;
|
|
use LibreNMS\Interfaces\Plugins\PluginManagerInterface;
|
|
|
|
class PluginProvider extends ServiceProvider
|
|
{
|
|
public function register(): void
|
|
{
|
|
$this->app->singleton(PluginManagerInterface::class, function ($app) {
|
|
return new \App\Plugins\PluginManager;
|
|
});
|
|
}
|
|
|
|
public function boot(): void
|
|
{
|
|
$this->loadLocalPlugins($this->app->make(PluginManagerInterface::class));
|
|
}
|
|
|
|
/**
|
|
* Load any local plugins these plugins must implement only one hook.
|
|
*/
|
|
protected function loadLocalPlugins(PluginManagerInterface $manager): void
|
|
{
|
|
$plugin_view_location_registered = [];
|
|
|
|
foreach (glob(base_path('app/Plugins/*/*.php')) as $file) {
|
|
if (preg_match('#^(.*/([^/]+))/([^/.]+)\.php#', $file, $matches)) {
|
|
$plugin_name = $matches[2]; // containing directory name
|
|
if ($plugin_name == 'Hooks') {
|
|
continue; // don't load the hooks :D
|
|
}
|
|
|
|
$class = $this->className($plugin_name, $matches[3]);
|
|
$hook_type = $this->hookType($class);
|
|
|
|
// publish hooks in class
|
|
$hook_published = $manager->publishHook($plugin_name, $hook_type, $class);
|
|
|
|
// register view namespace
|
|
if ($hook_published && ! in_array($plugin_name, $plugin_view_location_registered)) {
|
|
$plugin_view_location_registered[] = $plugin_name; // don't register twice
|
|
$this->loadViewsFrom($matches[1], $plugin_name);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if a hook is extended by the given class.
|
|
*
|
|
* @param string $class
|
|
* @return string
|
|
*
|
|
* @throws \App\Exceptions\PluginDoesNotImplementHookException
|
|
*/
|
|
protected function hookType(string $class): string
|
|
{
|
|
foreach (class_implements($class) as $parent) {
|
|
if (Str::startsWith($parent, 'LibreNMS\Interfaces\Plugins\Hooks\\')) {
|
|
return $parent;
|
|
}
|
|
}
|
|
|
|
throw new PluginDoesNotImplementHookException($class);
|
|
}
|
|
|
|
protected function className(string $dir, string $name): string
|
|
{
|
|
return 'App\Plugins\\' . $dir . '\\' . $name;
|
|
}
|
|
}
|