Moderators: Developers, Moderators
Code: Select all
} else if (function_exists('plugin_' . $file . '_install') && function_exists('plugin_' . $file . '_version')) {
$function = $file . '_version';
$cinfo[$file] = $function();
However, this still doesn't change the above. Code: Select all
<?php
function plugin_minimal_version()
{
return array( 'name' => 'minimal',
'version' => '0.1',
'longname' => 'My Minimal Plugin',
'author' => 'Joe Hacker',
'homepage' => 'http://example.org/myplugin/',
'email' => 'joe@example.org',
'url' => 'http://example.org/version.php'
);
}
function plugin_minimal_install()
{
}
function minimal_version()
{
return(plugin_minimal_version());
}
Code: Select all
<?php
/*
Mandatory management functions
*/
function plugin_skeleton_version() {
return array('name' => 'skeleton',
'longname' => 'Skeleton plugin', // this will be used as a heading in the plugins table when the plugin is installed
'version' => '0.1',
'author' => 'NegativeEpsilon',
'email' => 'delta@example.org',
'webpage' => 'http://example.org/', // PA bug, this will be used in the initial display of an not yet installed plugin
'homepage' => 'http://example.org/'); // this address will be inserted into the plugin_config.webpage when installing, and displayed afterwards
}
/*
PA bug
plugins.lib:218 first checks:
function_exists('plugin_' . $file . '_version')
then calls:
$f = $file . '_version'; $f();
*/
function skeleton_version() {
return plugin_skeleton_version();
}
function plugin_skeleton_install() {
/*
This is called when you press Install in the WebUI.
It is not strictly mandatory, but if you want to register any hooks & setup tables, do it here
*/
/*
api_plugin_db_table_create($plugin_name, $table_name, $table_def)
$plugin_name - name of the plugin (directory)
$table_name - name of the table, probably best to use the form $plugin_name . '_whatever',
as there is a possible 'security' hole with creating a new table that shares the name of an existing table.
When the plugin would be uninstalled, the table would be dropped (would work even with Cacti core tables :))
$table_def - associative array of arrays, containing column definitions
*/
$table_def = array();
$table_def['columns'][] = array('name' => 'id', 'type' => 'int', 'NULL' => false, 'auto_increment' => true);
$table_def['columns'][] = array('name' => 'data', 'type' => 'text');
$table_def['primary'] = 'id'; // optional
$table_def['keys'] = array(); // mandatory
// we could define additional keys with $table_def['keys'][] = array('name' => 'key_name', 'columns' => 'columns') // mandatory - bug?
$table_def['type'] = 'MyISAM'; // mandatory
api_plugin_db_table_create('skeleton', 'skeleton_data', $table_def);
// if you have a lot of tables to create, it may be better to move this to a separate function, e.g. plugin_$name_setup_database
/*
api_plugin_register_hook($plugin_name, $hook_name, $function_name, $file)
$plugin_name - name of the plugin (directory)
$hook_name - name of the hook, as listed in http://docs.cacti.net/plugins:development.hook_api_ref#hook_api_reference
$function_name - name of the function, that will be called
$file - file, containing the function (path is relative to $this plugin directory)
*/
api_plugin_register_hook('skeleton', 'page_title', 'skeleton_page_title', 'setup.php');
}
/*
Optional management functions
*/
function plugin_skeleton_check_config() {
/*
This is called after plugin_$file_install. You can check for additional dependencies / (mis)configuration here.
Return TRUE, if everything is OK, the plugin will go into state 'Disabled'.
Return FALSE otherwise, the plugin will go into state 'Awaiting configuration'
Caveat emptor:
PA has a few bugs, that will first cause the 'Check' link on the plugin management page do nothing.
When you fix that, you have to either manually change the plugin state in plugin_config table,
or patch the api_plugin_check_config function, becuse the plugin will be stuck in 'Awaiting...' state.
*/
return TRUE;
}
function plugin_skeleton_uninstall() {
/*
Tables and columns created with api_plugin_* calls will be automatically deleted.
Here you can perform additional cleanup (files on disk, ...)
*/
}
/*
Hook functions
These can also be moved to separate files
*/
function skeleton_page_title() {
// change every page title to contain the server name - useful if you have a ton of windows
return $_SERVER['SERVER_NAME'] . ' - Cacti';
}
?>
Users browsing this forum: No registered users and 3 guests