diff --git a/doc/Plugin_System.md b/doc/Plugin_System.md new file mode 100644 index 000000000..3d0c41ce9 --- /dev/null +++ b/doc/Plugin_System.md @@ -0,0 +1,61 @@ +# Developing for the Plugin System + +This documentation will hopefully give you a basis for how to write a plugin for LibreNMS. + +A test plugin is available on GitHib: https://github.com/laf/Test + +Plugins need to be installed into html/plugins + +The structure of a plugin is follows: + +``` +html/plugins + /PluginName + /PluginName.php + /PluginName.inc.php +``` + +The above structure is checked before a plugin can be installed. + +All files / folder names are case sensitive and must match. + +PluginName - This is a directory and needs to be named as per the plugin you are creating. + +PluginName.php - This file is used to process calls into the plugin from the main LibreNMS install. + Here only functions within the class for your plugin that LibreNMS calls will be executed. + For a list of currently enabled system hooks, please see further down. + The minimum code required in this file is (replace Test with the name of your plugin): +``` + +``` + +PluginName.inc.php - This file is the main included file when browsing to the plugin itself. + You can use this to display / edit / remove whatever you like. + The minimum code required in this file is: +``` + +``` + +### System Hooks ### + +System hooks are called as functions within your plugin class, so for example to create a menu entry within the PLugin dropdown you would do: + +``` + public function menu() { + echo('
  • '.get_class().'
    • '); + } +``` + +This would then add the name and a link to your plugin. + +The following system hooks are currently available: + +menu() +* This is called to build the plugin menu system and you can use this to link to your plugin (you don't have to). diff --git a/html/includes/plugins.inc.php b/html/includes/plugins.inc.php new file mode 100644 index 000000000..5ca6ca718 --- /dev/null +++ b/html/includes/plugins.inc.php @@ -0,0 +1,68 @@ + diff --git a/html/includes/print-menubar.php b/html/includes/print-menubar.php index 460625eb8..001d80728 100644 --- a/html/includes/print-menubar.php +++ b/html/includes/print-menubar.php @@ -484,15 +484,19 @@ if(is_file("includes/print-menubar-custom.inc.php"))
  • + Plugins +
  • System diff --git a/html/index.php b/html/index.php index 583ceb573..fd90a7ea3 100755 --- a/html/index.php +++ b/html/index.php @@ -17,6 +17,8 @@ include("../config.php"); include_once("../includes/definitions.inc.php"); include("../includes/functions.php"); include("includes/functions.inc.php"); +include('includes/plugins.inc.php'); +Plugins::start(); // Check for install.inc.php if (!file_exists('../config.php') && $_SERVER['PATH_INFO'] != '/install.php') { diff --git a/html/pages/plugin.inc.php b/html/pages/plugin.inc.php new file mode 100644 index 000000000..dcae4aacb --- /dev/null +++ b/html/pages/plugin.inc.php @@ -0,0 +1,20 @@ + 'plugin'); + +$pagetitle[] = "Plugin"; + +if ($vars['view'] == "admin") +{ + include_once('pages/plugin/admin.inc.php'); +} +else +{ + $plugin = dbFetchRow("SELECT `plugin_name` FROM `plugins` WHERE `plugin_name` = '".$vars['p']."'"); + if(!empty($plugin)) + { + require('plugins/'.$plugin['plugin_name'].'/'.$plugin['plugin_name'].'.inc.php'); + } +} + +?> diff --git a/html/pages/plugin/admin.inc.php b/html/pages/plugin/admin.inc.php new file mode 100644 index 000000000..ce92d906c --- /dev/null +++ b/html/pages/plugin/admin.inc.php @@ -0,0 +1,95 @@ += '10') +{ + + // Scan for new plugins and add to the database + $new_plugins = scan_new_plugins(); + + + // Check if we have to toggle enabled / disable a particular module + $plugin_id = $_POST['plugin_id']; + $plugin_active = $_POST['plugin_active']; + if(is_numeric($plugin_id) && is_numeric($plugin_active)) + { + if( $plugin_active == '0') + { + $plugin_active = 1; + } + elseif( $plugin_active == '1') + { + $plugin_active = 0; + } + else + { + $plugin_active = 0; + } + + dbUpdate(array('plugin_active' => $plugin_active), 'plugins', '`plugin_id` = ?', array($plugin_id)); + + } + +?> + +
    +
    + System plugins +
    + 0) + { + echo('
    +
    + We have found ' . $new_plugins . ' new plugins that need to be configured and enabled +
    +
    '); + } +?> + + + + + + + + + + '); + } + +?> +
    NameAction
    + '. $plugins['plugin_name'] . ' + +
    + + + +
    +
    +
    + + diff --git a/html/plugins/.gitignore b/html/plugins/.gitignore new file mode 100644 index 000000000..d6b7ef32c --- /dev/null +++ b/html/plugins/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore diff --git a/includes/definitions.inc.php b/includes/definitions.inc.php index 9e99b41b7..0d101714c 100644 --- a/includes/definitions.inc.php +++ b/includes/definitions.inc.php @@ -1218,5 +1218,6 @@ if (!isset($config['html_dir'])) { $config['html_dir'] = $config['install_dir'] if (!isset($config['rrd_dir'])) { $config['rrd_dir'] = $config['install_dir'] . '/rrd'; } if (!isset($config['log_dir'])) { $config['log_dir'] = $config['install_dir'] . '/logs'; } if (!isset($config['log_file'])) { $config['log_dir'] . "/" . $config['project_id'] . ".log"; } +if (!isset($config['plugin_dir'])) { $config['plugin_dir'] = $config['html_dir'] . '/plugins'; } ?> diff --git a/includes/functions.php b/includes/functions.php index 582585912..0213d935d 100755 --- a/includes/functions.php +++ b/includes/functions.php @@ -876,4 +876,40 @@ function is_port_valid($port, $device) return $valid; } +function scan_new_plugins() +{ + + global $config, $debug; + + $installed = 0; // Track how many plugins we install. + + if(file_exists($config['plugin_dir'])) + { + $plugin_files = scandir($config['plugin_dir']); + foreach($plugin_files as $name) + { + if(is_dir($config['plugin_dir'].'/'.$name)) + { + if($name != '.' && $name != '..') + { + if(is_file($config['plugin_dir'].'/'.$name.'/'.$name.'.php') && is_file($config['plugin_dir'].'/'.$name.'/'.$name.'.inc.php')) + { + $plugin_id = dbFetchRow("SELECT `plugin_id` FROM `plugins` WHERE `plugin_name` = '$name'"); + if(empty($plugin_id)) + { + if(dbInsert(array('plugin_name' => $name, 'plugin_active' => '0'), 'plugins')) + { + $installed++; + } + } + } + } + } + } + } + + return( $installed ); + +} + ?> diff --git a/sql-schema/030.sql b/sql-schema/030.sql new file mode 100644 index 000000000..5acc85c2e --- /dev/null +++ b/sql-schema/030.sql @@ -0,0 +1 @@ +CREATE TABLE IF NOT EXISTS `plugins` ( `plugin_id` INT NOT NULL AUTO_INCREMENT PRIMARY KEY , `plugin_name` VARCHAR( 60 ) NOT NULL , `plugin_active` INT NOT NULL ) ENGINE=InnoDB DEFAULT CHARSET=latin1;