Initial Release

Author: murrant

.gitignore

@@ -0,0 +1,3 @@
+/vendor/
+.*
+!.gitignore

LICENSE

@@ -1,24 +1,10 @@
-This is free and unencumbered software released into the public domain.
-
-Anyone is free to copy, modify, publish, use, compile, sell, or
-distribute this software, either in source code form or as a compiled
-binary, for any purpose, commercial or non-commercial, and by any
-means.
-
-In jurisdictions that recognize copyright laws, the author or authors
-of this software dedicate any and all copyright interest in the
-software to the public domain. We make this dedication for the benefit
-of the public at large and to the detriment of our heirs and
-successors. We intend this dedication to be an overt act of
-relinquishment in perpetuity of all present and future rights to this
-software under copyright law.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
-OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
-
-For more information, please refer to <https://unlicense.org>
+Permission to use, copy, modify, and/or distribute this software for
+any purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE
+FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY
+DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
+AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -1,2 +1,27 @@
-# plugin-interfaces
-Interfaces for LibreNMS plugins
+# LibreNMS Plugin Interfaces
+
+Create a new Laravel Package as described:
+https://laravel.com/docs/packages
+
+Require this package
+
+    composer require librenms/plugin-interfaces
+
+
+Register your plugin with LibreNMS in your provider boot method and check to see if it is enabled:
+
+```php
+    public function boot(): void
+    {
+        $pluginName = 'example-plugin';
+        $pluginManager = $this->app->make(\LibreNMS\Interfaces\Plugins\PluginManagerInterface::class);
+
+        $pluginManager->publishHook($pluginName, \LibreNMS\Interfaces\Plugins\MenuEntryHook::class, MenuEntryHook::class);
+
+        if (! $pluginManager->pluginEnabled($pluginName)) {
+            return; // if plugin is disabled, don't boot
+        }
+
+        // Do regular Laravel Package actions here, such as register routes and views or publish files.
+    }
+```

composer.json

@@ -0,0 +1,15 @@
+{
+    "name": "librenms/plugin-interfaces",
+    "description": "Interfaces required to create a LibreNMS Plugin",
+    "type": "library",
+    "license": "Zero-Clause BSD",
+    "homepage": "https://www.librenms.org/",
+    "autoload": {
+        "psr-4": {
+            "LibreNMS\\Interfaces\\Plugins\\": "src/"
+        }
+    },
+    "require": {
+        "php": ">=7.1"
+    }
+}

src/Hook.php

@@ -0,0 +1,19 @@
+<?php
+
+
+namespace LibreNMS\Interfaces\Plugins;
+
+interface Hook
+{
+    /**
+     * Will be called by the plugin manager to check if the user is authorized. Will be called with Dependency Injection.
+     */
+//    public function authorize(): bool;
+
+    /**
+     * Will be called by the plugin manager to execute this plugin at the correct time. Will be called with Dependency Injection.
+     * Available variables for injection: $pluginName, $settings
+     *
+     */
+//    public function handle();
+}

src/Hooks/DeviceOverviewHook.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace LibreNMS\Interfaces\Plugins\Hooks;
+
+use LibreNMS\Interfaces\Plugins\Hook;
+
+interface DeviceOverviewHook extends Hook
+{
+
+}

src/Hooks/MenuEntryHook.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace LibreNMS\Interfaces\Plugins\Hooks;
+
+use LibreNMS\Interfaces\Plugins\Hook;
+
+interface MenuEntryHook extends Hook
+{
+
+}

src/Hooks/PortTabHook.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace LibreNMS\Interfaces\Plugins\Hooks;
+
+use LibreNMS\Interfaces\Plugins\Hook;
+
+interface PortTabHook extends Hook
+{
+
+}

src/Hooks/SettingsHook.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace LibreNMS\Interfaces\Plugins\Hooks;
+
+use LibreNMS\Interfaces\Plugins\Hook;
+
+interface SettingsHook extends Hook
+{
+
+}

src/Hooks/SinglePageHook.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace LibreNMS\Interfaces\Plugins\Hooks;
+
+use LibreNMS\Interfaces\Plugins\Hook;
+
+interface SinglePageHook extends Hook
+{
+
+}