<?php
/**
* This file implements the UI controller for plugins management.
*
* This file is part of the evoCore framework - {@link http://evocore.net/}
* See also {@link https://github.com/b2evolution/b2evolution}.
*
* @license GNU GPL v2 - {@link http://b2evolution.net/about/gnu-gpl-license}
*
* @copyright (c)2003-2020 by Francois Planque - {@link http://fplanque.com/}
* Parts of this file are copyright (c)2004-2006 by Daniel HAHLER - {@link http://thequod.de/contact}.
*
* @package admin
*/
if( !defined('EVO_MAIN_INIT') ) die( 'Please, do not access this page directly.' );
global $admin_url;
// Check permission to display:
check_user_perm( 'admin', 'normal', true );
check_user_perm( 'options', 'view', true );
load_funcs( 'plugins/_plugin.funcs.php' );
// Memorize this as the last "tab" used in the Blog Settings:
$UserSettings->set( 'pref_glob_settings_tab', $ctrl );
$UserSettings->dbupdate();
$action = param_action( 'list' );
$tab = param( 'tab', 'string', 'general' );
$AdminUI->set_path( 'options', 'plugins', $tab );
$UserSettings->param_Request( 'plugins_disp_avail', 'plugins_disp_avail', 'integer', 0 );
/**
* @var Plugins_admin
*/
$admin_Plugins = & get_Plugins_admin();
$admin_Plugins->restart();
// Pre-walk list of plugins, this will register all existing plugins and verify the statuses
while( $loop_Plugin = & $admin_Plugins->get_next() )
{
if( $loop_Plugin->status == 'broken' && ! isset( $admin_Plugins->plugin_errors[$loop_Plugin->ID] ) )
{ // The plugin is not "broken" anymore or it has only some required db changes (either the problem got fixed or it was "broken" from a canceled "install_db_schema" action)
if( install_plugin_db_schema_action( $loop_Plugin, false ) )
{ // There are no required db changes and no error detected so this plugin is not broken any more
// TODO: set this to the previous status (dh)
$Plugins->set_Plugin_status( $loop_Plugin, 'disabled' );
}
}
}
/*
* Action Handling part I
* Actions that delegate to other actions (other than list):
*/
switch( $action )
{
case 'del_settings_set':
// Delete a set from an array type setting:
param( 'plugin_ID', 'integer', true );
param( 'set_path', 'string' );
$edit_Plugin = & $admin_Plugins->get_by_ID($plugin_ID);
_set_setting_by_path( $edit_Plugin, 'Settings', $set_path, NULL );
// Don't delete from the db yet. It will be updated in the db when Save button is clicked. It works similar as the async pair of this action
#$edit_Plugin->Settings->dbupdate();
$action = 'edit_settings';
break;
case 'add_settings_set': // delegates to edit_settings
// Add a new set to an array type setting:
param( 'plugin_ID', 'integer', true );
param( 'set_path', 'string', '' );
$edit_Plugin = & $admin_Plugins->get_by_ID($plugin_ID);
_set_setting_by_path( $edit_Plugin, 'Settings', $set_path, array() );
// Don't update the db, before it is not filled. It will be saved when Save button is clicked.
#$edit_Plugin->Settings->dbupdate();
$action = 'edit_settings';
break;
}
/*
* Action Handling part II
*/
switch( $action )
{
case 'disable_plugin':
// Disable a plugin, only if it is "enabled"
// Check that this action request is not a CSRF hacked request:
$Session->assert_received_crumb( 'plugin' );
check_user_perm( 'options', 'edit', true );
param( 'plugin_ID', 'integer', true );
$action = 'list';
$edit_Plugin = & $admin_Plugins->get_by_ID( $plugin_ID );
if( empty($edit_Plugin) )
{
$Messages->add( sprintf( TB_( 'The plugin with ID %d could not be instantiated.' ), $plugin_ID ), 'error' );
break;
}
if( $edit_Plugin->status != 'enabled' )
{
$Messages->add( sprintf( TB_( 'The plugin with ID %d is already disabled.' ), $plugin_ID ), 'note' );
break;
}
// Check dependencies
$msgs = $admin_Plugins->validate_dependencies( $edit_Plugin, 'disable' );
if( ! empty( $msgs['error'] ) )
{
$Messages->add( TB_( 'The plugin cannot be disabled because of the following dependencies:' ).' <ul><li>'.implode('</li><li>', $msgs['error']).'</li></ul>', 'error' );
break;
}
// we call $Plugins(!) here: the Plugin gets disabled on the current page already and it should not get (un)registered on $admin_Plugins!
$Plugins->set_Plugin_status( $edit_Plugin, 'disabled' ); // sets $edit_Plugin->status
// invalidate all PageCaches
invalidate_pagecaches();
$Messages->add( /* TRANS: plugin name, class name and ID */ sprintf( TB_('Disabled "%s" plugin (%s, #%d).'), $edit_Plugin->name, $edit_Plugin->classname, $edit_Plugin->ID ), 'success' );
//save fadeout item
$Session->set('fadeout_id', $plugin_ID);
// Redirect so that a reload doesn't write to the DB twice:
header_redirect( '?ctrl=plugins', 303 ); // Will EXIT
// We have EXITed already at this point!!
break;
case 'enable_plugin':
// Try to enable a plugin, only if it is in state "disabled" or "needs_config"
// Check that this action request is not a CSRF hacked request:
$Session->assert_received_crumb( 'plugin' );
check_user_perm( 'options', 'edit', true );
param( 'plugin_ID', 'integer', true );
$action = 'list';
$edit_Plugin = & $admin_Plugins->get_by_ID( $plugin_ID );
if( empty($edit_Plugin) )
{
$Messages->add( sprintf( TB_( 'The plugin with ID %d could not be instantiated.' ), $plugin_ID ), 'error' );
break;
}
if( $edit_Plugin->status == 'enabled' )
{
$Messages->add( /* TRANS: plugin name, class name and ID */ sprintf( TB_( 'The "%s" plugin (%s, #%d) is already enabled.' ), $edit_Plugin->name, $edit_Plugin->classname, $plugin_ID ), 'note' );
break;
}
if( $edit_Plugin->status == 'broken' )
{
$Messages->add( sprintf( TB_( 'The plugin is in a broken state. It cannot be enabled.' ), $plugin_ID ), 'error' );
break;
}
// Check dependencies
$msgs = $admin_Plugins->validate_dependencies( $edit_Plugin, 'enable' );
if( ! empty( $msgs['error'] ) )
{
$Messages->add( TB_( 'The plugin cannot be enabled because of the following dependencies:' ).' <ul><li>'.implode('</li><li>', $msgs['error']).'</li></ul>' );
break;
}
if( install_plugin_db_schema_action( $edit_Plugin ) )
{ // Changes are done, or no changes
$action = 'list';
}
else
{ // delta queries have to be confirmed in payload
$action = 'install_db_schema';
$next_action = 'enable_plugin';
break;
}
// Try to enable plugin:
$enable_return = $edit_Plugin->BeforeEnable();
if( $enable_return === true )
{
// NOTE: we don't need to handle plug_version here, because it gets handled in Plugins::register() already.
// Detect new events:
$admin_Plugins->save_events( $edit_Plugin, array() );
// we call $Plugins(!) here: the Plugin gets active on the current page already and it should not get (un)registered on $admin_Plugins!
$Plugins->set_Plugin_status( $edit_Plugin, 'enabled' ); // sets $edit_Plugin->status
// invalidate all PageCaches
invalidate_pagecaches();
$Messages->add( /* TRANS: plugin name, class name and ID */ sprintf( TB_('Enabled "%s" plugin (%s, #%d).'), $edit_Plugin->name, $edit_Plugin->classname, $edit_Plugin->ID ), 'success' );
}
else
{
$Messages->add( TB_('The plugin has not been enabled.').( empty($enable_return) ? '' : '<br />'.$enable_return ), 'error' );
// Set plugin status to "needs_config" to mark the plugin as incomplete for using:
$Plugins->set_Plugin_status( $edit_Plugin, 'needs_config' );
}
//save fadeout item
$Session->set('fadeout_id', $plugin_ID);
// Redirect so that a reload doesn't write to the DB twice:
header_redirect( '?ctrl=plugins', 303 ); // Will EXIT
// We have EXITed already at this point!!
break;
case 'reload_plugins':
// Register new events
// Unregister obsolete events
// Detect plugins with no code and try to have at least one plugin with the default code
// Check that this action request is not a CSRF hacked request:
$Session->assert_received_crumb( 'plugin' );
// Check permission:
check_user_perm( 'options', 'edit', true );
if( $admin_Plugins->reload_plugins() )
{ // Plugins have been changed
$Messages->add( TB_('Plugins have been reloaded.'), 'success' );
}
else
{
$Messages->add( TB_('Plugins have not changed.'), 'note' );
}
$action = 'list';
// Redirect so that a reload doesn't write to the DB twice:
header_redirect( '?ctrl=plugins', 303 ); // Will EXIT
// We have EXITed already at this point!!
break;
case 'install':
// Install a plugin. This may be a two-step action, when DB changes have to be confirmed
$action = 'list';
// Check that this action request is not a CSRF hacked request:
$Session->assert_received_crumb( 'plugin' );
// Check permission:
check_user_perm( 'options', 'edit', true );
param( 'plugin', 'string', true );
$edit_Plugin = & $admin_Plugins->install( $plugin, 'broken' ); // "broken" by default, gets adjusted later
if( is_string($edit_Plugin) )
{
$Messages->add( $edit_Plugin, 'error' );
break;
}
case 'install_db_schema':
// we come here from the first step ("install")
// Check that this action request is not a CSRF hacked request:
$Session->assert_received_crumb( 'plugin' );
// Check permission:
check_user_perm( 'options', 'edit', true );
param( 'plugin_ID', 'integer', 0 );
if( $plugin_ID )
{ // second step:
$edit_Plugin = & $admin_Plugins->get_by_ID( $plugin_ID );
if( ! ( $edit_Plugin instanceof Plugin ) )
{
$Messages->add( sprintf( TB_( 'The plugin with ID %d could not be instantiated.' ), $plugin_ID ), 'error' );
$action = 'list';
break;
}
}
if( install_plugin_db_schema_action( $edit_Plugin ) )
{ // Changes are done, or no changes
$action = 'list';
}
else
{ // delta queries have to be confirmed in payload
$action = 'install_db_schema';
$next_action = 'install_db_schema';
break;
}
$msg = sprintf( TB_('Installed plugin «%s».'), $edit_Plugin->classname );
if( ($edit_settings_url = $edit_Plugin->get_edit_settings_url()) )
{
$msg .= ' <a href="'.$edit_settings_url.'">'.TB_('Click here to configure').'</a>.';
}
$Messages->add( $msg, 'success' );
// Install completed:
$params = array();
$r = $admin_Plugins->call_method( $edit_Plugin->ID, 'AfterInstall', $params );
// invalidate all PageCaches
invalidate_pagecaches();
// Try to enable plugin:
$enable_return = $edit_Plugin->BeforeEnable();
if( $enable_return === true )
{
$Plugins->set_Plugin_status( $edit_Plugin, 'enabled' );
}
else
{
$Messages->add( TB_('The plugin has not been enabled.').( empty($enable_return) ? '' : '<br />'.$enable_return ), 'error' );
// Set plugin status to "needs_config" to mark the plugin as incomplete for using:
$Plugins->set_Plugin_status( $edit_Plugin, 'needs_config' );
}
if( ! empty( $edit_Plugin->install_dep_notes ) )
{ // Add notes from dependencies
foreach( $edit_Plugin->install_dep_notes as $note )
{
$Messages->add( $note, 'note' );
}
}
// Redirect so that a reload doesn't write to the DB twice:
header_redirect( '?ctrl=plugins', 303 ); // Will EXIT
// We have EXITed already at this point!!
break;
case 'uninstall':
// Uninstall plugin:
// Check that this action request is not a CSRF hacked request:
$Session->assert_received_crumb( 'plugin' );
// Check permission:
check_user_perm( 'options', 'edit', true );
param( 'plugin_ID', 'integer', true );
param( 'uninstall_confirmed_drop', 'integer', 0 );
$action = 'list'; // leave 'uninstall' by default
$edit_Plugin = & $admin_Plugins->get_by_ID( $plugin_ID );
if( empty($edit_Plugin) )
{
$Messages->add( sprintf( TB_( 'The plugin with ID %d could not be instantiated.' ), $plugin_ID ), 'error' );
break;
}
// Check dependencies:
$msgs = $admin_Plugins->validate_dependencies( $edit_Plugin, 'disable' );
if( ! empty( $msgs['error'] ) )
{
$Messages->add( TB_( 'The plugin cannot be uninstalled because of the following dependencies:' ).' <ul><li>'.implode('</li><li>', $msgs['error']).'</li></ul>', 'error' );
break;
}
if( ! empty( $msgs['note'] ) )
{ // just notes:
foreach( $msgs['note'] as $note )
{
$Messages->add( $note, 'note' );
}
}
// Ask plugin:
$params = array( 'unattended' => false );
$uninstall_ok = $admin_Plugins->call_method( $edit_Plugin->ID, 'BeforeUninstall', $params );
if( $uninstall_ok === false )
{ // Plugin said "NO":
$Messages->add( sprintf( TB_('Could not uninstall plugin #%d.'), $edit_Plugin->ID ), 'error' );
break;
}
// See if we have (canonical) tables to drop:
$uninstall_tables_to_drop = $DB->get_col( 'SHOW TABLES LIKE "'.$edit_Plugin->get_sql_table('%').'"' );
if( $uninstall_ok === true )
{ // Plugin said "YES":
// invalidate all PageCaches
invalidate_pagecaches();
if( $uninstall_tables_to_drop )
{ // There are tables with the prefix for this plugin:
if( $uninstall_confirmed_drop )
{ // Drop tables:
$sql = 'DROP TABLE IF EXISTS '.implode( ', ', $uninstall_tables_to_drop );
$DB->query( $sql );
$Messages->add( TB_('Dropped the table(s) of the plugin.'), 'success' );
}
else
{
$uninstall_ok = false;
}
}
if( $uninstall_ok )
{ // We either have no tables to drop or it has been confirmed:
$admin_Plugins->uninstall( $edit_Plugin->ID );
$Messages->add( /* %s = plugin's classname, %d = plugin's ID */
sprintf( TB_('The «%s» plugin (#%d) has been uninstalled.'), $edit_Plugin->classname, $edit_Plugin->ID ), 'success' );
// Redirect so that a reload doesn't write to the DB twice:
header_redirect( '?ctrl=plugins', 303 ); // Will EXIT
// We have EXITed already at this point!!
break;
}
}
// $ok === NULL (or other): execute plugin event BeforeUninstallPayload() below
// $ok === false: let the admin confirm DB table dropping below
$action = 'uninstall';
break;
case 'update_settings':
case 'update_edit_settings':
// Update plugin settings:
// Check that this action request is not a CSRF hacked request:
$Session->assert_received_crumb( 'plugin' );
// Check permission:
check_user_perm( 'options', 'edit', true );
param( 'plugin_ID', 'integer', true );
$edit_Plugin = & $admin_Plugins->get_by_ID( $plugin_ID );
if( empty( $edit_Plugin ) )
{
$Messages->add( sprintf( TB_( 'The plugin with ID %d could not be instantiated.' ), $plugin_ID ), 'error' );
$action = 'list';
break;
}
// Params from/for form:
param( 'edited_plugin_name', 'string' );
param( 'edited_plugin_shortdesc', 'string' );
param( 'edited_plugin_code', 'string' );
param( 'edited_plugin_priority', 'integer' );
param( 'edited_plugin_displayed_events', 'array:string', array() );
param( 'edited_plugin_events', 'array:integer', array() );
// Update the folding states for current user:
save_fieldset_folding_values();
$default_Plugin = & $admin_Plugins->register( $edit_Plugin->classname );
// Update plugin name:
// (Only if changed to preserve initial localization feature and therefor also priorize NULL)
if( $edit_Plugin->name != $edited_plugin_name )
{
$set_to = $edited_plugin_name == $default_Plugin->name ? NULL : $edited_plugin_name;
$edit_Plugin->name = $edited_plugin_name;
if( $DB->query( '
UPDATE T_plugins
SET plug_name = '.$DB->quote( $set_to ).'
WHERE plug_ID = '.$plugin_ID ) )
{
$Messages->add( TB_('Plugin name updated.'), 'success' );
}
}
// Update plugin shortdesc:
// (Only if changed to preserve initial localization feature and therefor also priorize NULL)
if( $edit_Plugin->short_desc != $edited_plugin_shortdesc )
{
$set_to = $edited_plugin_shortdesc == $default_Plugin->short_desc ? NULL : $edited_plugin_shortdesc;
$edit_Plugin->short_desc = $edited_plugin_shortdesc;
if( $DB->query( '
UPDATE T_plugins
SET plug_shortdesc = '.$DB->quote($set_to).'
WHERE plug_ID = '.$plugin_ID ) )
{
$Messages->add( TB_('Plugin description updated.'), 'success' );
}
}
// Plugin Events:
$registered_events = $admin_Plugins->get_registered_events( $edit_Plugin );
$enable_events = array();
$disable_events = array();
foreach( $edited_plugin_displayed_events as $l_event )
{
if( ! in_array( $l_event, $registered_events ) )
{ // unsupported event
continue;
}
if( isset($edited_plugin_events[$l_event]) && $edited_plugin_events[$l_event] )
{
$enable_events[] = $l_event; // may be already there
}
else
{ // unset:
$disable_events[] = $l_event;
}
}
if( $admin_Plugins->save_events( $edit_Plugin, $enable_events, $disable_events ) )
{
$Messages->add( TB_('Plugin events have been updated.'), 'success' );
}
// Plugin code
// Check if a ping plugin has a code (which is required) (this has to go after event handling!):
if( $admin_Plugins->has_event( $edit_Plugin->ID, 'ItemSendPing' )
&& empty($edited_plugin_code) )
{
param_error( 'edited_plugin_code', sprintf( TB_('This ping plugin needs a non-empty code.'), $edit_Plugin->name ) );
}
else
{
$updated = $admin_Plugins->set_code( $edit_Plugin->ID, $edited_plugin_code );
if( is_string( $updated ) )
{
param_error( 'edited_plugin_code', $updated );
$action = 'edit_settings';
}
elseif( $updated === 1 )
{
$Messages->add( TB_('Plugin code updated.'), 'success' );
}
}
// Plugin priority
if( param_check_range( 'edited_plugin_priority', 0, 255, sprintf( TB_('Plugin priority must be numeric (%s).'), '0-255' ), true ) )
{
$updated = $admin_Plugins->set_priority( $edit_Plugin->ID, $edited_plugin_priority );
if( $updated === 1 )
{
$Messages->add( TB_('Plugin priority updated.'), 'success' );
}
}
else
{
$action = 'edit_settings';
}
// Plugin specific settings:
if( $edit_Plugin->Settings )
{
// Loop through settings for this plugin:
$dummy = array( 'for_editing' => true );
foreach( $edit_Plugin->GetDefaultSettings( $dummy ) as $set_name => $set_meta )
{
autoform_set_param_from_request( $set_name, $set_meta, $edit_Plugin, 'Settings' );
}
// Let the plugin handle custom fields:
// We use call_method to keep track of this call, although calling the plugins PluginSettingsUpdateAction method directly _might_ work, too.
$tmp_params = array();
$ok_to_update = $admin_Plugins->call_method( $edit_Plugin->ID, 'PluginSettingsUpdateAction', $tmp_params );
if( $ok_to_update === false )
{ // Rollback settings: the plugin has said they should not get updated.
$edit_Plugin->Settings->reset();
}
elseif( $edit_Plugin->Settings->dbupdate() )
{
$Messages->add( TB_('Plugin settings have been updated').'.', 'success' );
}
}
// Check if plugin status should be changed to incomplete:
$enable_return = $edit_Plugin->BeforeEnable();
if( $enable_return !== true )
{
$Messages->add( TB_('The plugin has been disabled.').( empty( $enable_return ) ? '' : '<br />'.$enable_return ), 'error' );
// Set plugin status to "needs_config" to mark the plugin as incomplete for using:
$Plugins->set_Plugin_status( $edit_Plugin, 'needs_config' );
}
elseif( $edit_Plugin->status != 'enabled' )
{ // Set plugin status to "enabled" if it is allowed for current plugin configuration:
$Plugins->set_Plugin_status( $edit_Plugin, 'enabled' );
}
if( $action == 'update_settings' && ! $Messages->has_errors() )
{ // there were no errors, go back to list:
//save fadeout item
$Session->set('fadeout_id', $edit_Plugin->ID);
// Redirect so that a reload doesn't write to the DB twice:
header_redirect( '?ctrl=plugins', 303 ); // Will EXIT
// We have EXITed already at this point!!
}
// Redisplay so user can fix errors:
$action = 'edit_settings';
break;
case 'edit_settings':
// Check permission:
check_user_perm( 'options', 'view', true );
// Edit plugin settings:
param( 'plugin_ID', 'integer', true );
$edit_Plugin = & $admin_Plugins->get_by_ID( $plugin_ID );
if( ! $edit_Plugin )
{
$Debuglog->add( 'The plugin with ID '.$plugin_ID.' was not found.', array('plugins', 'error') );
$action = 'list';
break;
}
if( $edit_Plugin->status == 'broken' && ! install_plugin_db_schema_action( $edit_Plugin ) )
{ // If the plugin is in broken status and has some required db changes then display the db changes
$action = 'install_db_schema';
$next_action = 'install_db_schema';
break;
}
// Detect new events, so they get displayed correctly in the "Edit events" fieldset:
$admin_Plugins->save_events( $edit_Plugin, array() );
// Inform Plugin that it gets edited:
$tmp_params = array();
$admin_Plugins->call_method( $edit_Plugin->ID, 'PluginSettingsEditAction', $tmp_params );
// Params for form:
$edited_plugin_name = $edit_Plugin->name;
$edited_plugin_shortdesc = $edit_Plugin->short_desc;
$edited_plugin_code = $edit_Plugin->code;
$edited_plugin_priority = $edit_Plugin->priority;
break;
case 'default_settings':
// Restore default settings
// Check that this action request is not a CSRF hacked request:
$Session->assert_received_crumb( 'plugin' );
// Check permission:
check_user_perm( 'options', 'edit', true );
param( 'plugin_ID', 'integer', true );
$edit_Plugin = & $admin_Plugins->get_by_ID( $plugin_ID );
if( !$edit_Plugin )
{
$Debuglog->add( 'The plugin with ID '.$plugin_ID.' was not found.', array('plugins', 'error') );
$action = 'list';
break;
}
// this returns NULL for code as it's seen as a duplicate plugin
$default_Plugin = & $admin_Plugins->register($edit_Plugin->classname);
// grab a raw copy of the plugin
$raw_Plugin = new $edit_Plugin->classname();
// Params for/"from" form:
$edited_plugin_name = $default_Plugin->name;
$edited_plugin_shortdesc = $default_Plugin->short_desc;
$edited_plugin_code = $raw_Plugin->code;
$edited_plugin_priority = $default_Plugin->priority;
// Name and short desc:
$DB->query( '
UPDATE T_plugins
SET plug_name = NULL,
plug_shortdesc = NULL
WHERE plug_ID = '.$plugin_ID );
// Code:
$updated = $admin_Plugins->set_code( $edit_Plugin->ID, $edited_plugin_code );
if( is_string( $updated ) )
{ // error message
param_error( 'edited_plugin_code', $updated );
$action = 'edit_settings';
}
elseif( $updated === 1 )
{
$Messages->add( TB_('Plugin code updated.'), 'success' );
}
// Priority:
if( ! preg_match( '~^1?\d?\d$~', $edited_plugin_priority ) )
{
param_error( 'edited_plugin_priority', sprintf( TB_('Plugin priority must be numeric (%s).'), '0-255' ) );
}
else
{
$updated = $admin_Plugins->set_priority( $edit_Plugin->ID, $edited_plugin_priority );
if( $updated === 1 )
{
$Messages->add( TB_('Plugin priority updated.'), 'success' );
}
}
// PluginSettings:
if( $edit_Plugin->Settings )
{
if( $edit_Plugin->Settings->restore_defaults() )
{
$Messages->add( TB_('Restored default values.'), 'success' );
}
else
{
$Messages->add( TB_('Settings have not changed.'), 'note' );
}
}
// Enable all events:
if( $admin_Plugins->save_events( $edit_Plugin ) )
{
$Messages->add( TB_('Plugin events have been updated.'), 'success' );
}
// Check if we should change plugin status to 'needs_config'
// to view this plugin in list with orange "question" icon:
if( $edit_Plugin->status == 'enabled' || $edit_Plugin->status == 'disabled' )
{
$enable_return = $edit_Plugin->BeforeEnable();
if( $enable_return !== true )
{ // Plugin cannot be enabled
$Messages->add( TB_('The plugin has been disabled.').( empty( $enable_return ) ? '' : '<br />'.$enable_return ), 'error' );
// Set plugin status to "needs_config" to mark the plugin as incomplete for using:
$Plugins->set_Plugin_status( $edit_Plugin, 'needs_config' );
}
}
// blueyed>> IMHO it's good to see the new settings again. Perhaps we could use $action = 'list' for "Settings have not changed"?
$action = 'edit_settings';
break;
case 'update_shared_settings':
// Update plugin settings for shared containers:
// Check that this action request is not a CSRF hacked request:
$Session->assert_received_crumb( 'shared_settings' );
$Plugins->restart();
while( $loop_Plugin = & $Plugins->get_next() )
{
$tmp_params = array( 'for_editing' => true );
$pluginsettings = $loop_Plugin->get_shared_setting_definitions( $tmp_params );
if( empty( $pluginsettings ) )
{
continue;
}
// Loop through settings for this plugin:
foreach( $pluginsettings as $set_name => $set_meta )
{
autoform_set_param_from_request( $set_name, $set_meta, $loop_Plugin, 'SharedSettings' );
}
// Let the plugin handle custom fields:
// We use call_method to keep track of this call, although calling the plugins PluginSettingsUpdateAction method directly _might_ work, too.
$tmp_params = array();
$ok_to_update = $Plugins->call_method( $loop_Plugin->ID, 'PluginSettingsUpdateAction', $tmp_params );
if( $ok_to_update === false )
{ // The plugin has said they should not get updated, Rollback settings:
$loop_Plugin->Settings->reset();
}
else
{ // Update message settings of the Plugin:
$loop_Plugin->Settings->dbupdate();
}
}
$Messages->add( TB_('Settings updated.'), 'success' );
// Redirect so that a reload doesn't write to the DB twice:
header_redirect( $admin_url.'?ctrl=plugins&tab=shared', 303 ); // Will EXIT
// We have EXITed already at this point!!
break;
case 'info':
case 'disp_help':
case 'disp_help_plain': // just the help, without any payload
// Check permission: (with plugins... you never know...)
check_user_perm( 'options', 'view', true );
param( 'plugin_class', 'string', true );
if( ! ( $edit_Plugin = & $admin_Plugins->get_by_classname( $plugin_class ) ) )
{ // Plugin is not installed:
$edit_Plugin = & $admin_Plugins->register( $plugin_class );
if( is_string($edit_Plugin) )
{
$Messages->add($edit_Plugin, 'error');
$edit_Plugin = false;
$action = 'list';
}
else
{
$admin_Plugins->unregister( $edit_Plugin, true /* force */ );
}
}
if( $edit_Plugin->status == 'broken' )
{
$Messages->add( TB_('The requested plugin doesn\'t exist!'), 'error' );
}
break;
}
// Extend titlearea for some actions and add JS:
switch( $action )
{
case 'edit_settings':
$AdminUI->append_to_titlearea( '<a href="'.regenerate_url('', 'action=edit_settings&plugin_ID='.$edit_Plugin->ID).'">'
.sprintf( TB_('Edit plugin «%s» (ID %d)'), $edit_Plugin->name, $edit_Plugin->ID ).'</a>' );
// Initialize JS for color picker field on the edit plugin settings form:
init_colorpicker_js();
init_hotkeys_js();
break;
case 'disp_help_plain': // just the help, without any payload
case 'disp_help':
if( ! ($help_file = $edit_Plugin->get_help_file()) )
{
$action = 'list';
break;
}
if( $action == 'disp_help_plain' )
{ // display it now and exit:
readfile($help_file);
exit(0);
}
$title = sprintf( TB_('Help for plugin «%s»'), '<a href="'.$admin_url.'?ctrl=plugins&action=edit_settings&plugin_ID='.$edit_Plugin->ID.'">'.$edit_Plugin->name.'</a>' );
if( ! empty($edit_Plugin->help_url) )
{
$title .= ' '.action_icon( TB_('External help page'), 'help', $edit_Plugin->help_url );
}
$AdminUI->append_to_titlearea( $title );
break;
}
// Display load error from Plugins::register() (if any):
if( isset($edit_Plugin) && is_object($edit_Plugin) && isset( $admin_Plugins->plugin_errors[$edit_Plugin->ID] )
&& ! empty($admin_Plugins->plugin_errors[$edit_Plugin->ID]['register']) )
{
$Messages->add( get_icon('warning').' '.$admin_Plugins->plugin_errors[$edit_Plugin->ID]['register'], 'error' );
}
$AdminUI->breadcrumbpath_init( false );
$AdminUI->breadcrumbpath_add( TB_('System'), $admin_url.'?ctrl=system',
TB_('Global settings are shared between all blogs; see Blog settings for more granular settings.') );
$AdminUI->breadcrumbpath_add( TB_('Plugin configuration'), $admin_url.'?ctrl=plugins' );
// Set an url for manual page:
switch( $action )
{
case 'list_available':
$AdminUI->set_page_manual_link( 'plugins-available-for-installation' );
break;
case 'edit_settings':
$AdminUI->set_page_manual_link( 'plugins-editing' );
break;
default:
$AdminUI->set_page_manual_link( 'installed-plugins' );
break;
}
init_popover_js( 'rsc_url', $AdminUI->get_template( 'tooltip_plugin' ) );
// Display <html><head>...</head> section! (Note: should be done early if actions do not redirect)
$AdminUI->disp_html_head();
// Display title, menu, messages, etc. (Note: messages MUST be displayed AFTER the actions)
$AdminUI->disp_body_top();
// Begin payload block:
$AdminUI->disp_payload_begin();
switch( $action )
{
case 'disp_help':
// Display plugin help:
$help_file_body = implode( '', file($help_file) );
// Try to extract the BODY part:
if( preg_match( '~<body.*?>(.*)</body>~is', $help_file_body, $match ) )
{
$help_file_body = $match[1];
}
echo $help_file_body;
unset($help_file_body);
break;
case 'install_db_schema':
// Payload for 'install_db_schema' action if DB layout changes have to be confirmed:
?>
<div class="panelinfo">
<?php
$Form = new Form( NULL, 'install_db_deltas', 'get', 'compact' );
$Form->global_icon( TB_('Cancel installation!'), 'close', regenerate_url() );
$Form->begin_form( 'fform', sprintf( /* TRANS: %d is ID, %d name */ TB_('Finish setup for plugin #%d (%s)'), $edit_Plugin->ID, $edit_Plugin->name ) );
$Form->add_crumb( 'plugin' );
$Form->hidden_ctrl();
$Form->hidden( 'action', $next_action );
$Form->hidden( 'plugin_ID', $edit_Plugin->ID );
echo '<p>'.TB_('The plugin needs the following database changes.').'</p>';
if( ! empty($install_db_deltas) )
{
echo '<p>'.TB_('The following database changes will be carried out. If you are not sure what this means, it will probably be alright.').'</p>';
echo '<ul>';
foreach( $install_db_deltas as $l_delta )
{
#echo '<li><code>'.nl2br($l_delta).'</code></li>';
echo '<li><pre>'.str_replace( "\t", ' ', $l_delta ).'</pre></li>';
}
echo '</ul>';
$Form->hidden( 'install_db_deltas_confirm_md5', md5(implode( '', $install_db_deltas )) );
}
echo '<div class="center">';
$Form->submit( array( '', TB_('Install').'!', 'ActionButton btn-primary' ) );
echo '</div>';
$Form->end_form();
?>
</div>
<?php
break;
case 'uninstall': // We come here either if the plugin requested a call to BeforeUninstallPayload() or if there are tables to be dropped {{{
?>
<div class="panelinfo">
<?php
$Form = new Form( '', 'uninstall_plugin', 'post', 'compact' );
$Form->global_icon( TB_('Cancel uninstall!'), 'close', regenerate_url() );
$Form->begin_form( 'fform', sprintf( /* TRANS: %d is ID, %d name */ TB_('Uninstall plugin #%d (%s)'), $edit_Plugin->ID, $edit_Plugin->name ) );
$Form->add_crumb( 'plugin' );
// We may need to use memorized params in the next page
$Form->hiddens_by_key( get_memorized( 'action,plugin_ID') );
$Form->hidden( 'action', 'uninstall' );
$Form->hidden( 'plugin_ID', $edit_Plugin->ID );
$Form->hidden( 'uninstall_confirmed_drop', 1 );
if( $uninstall_tables_to_drop )
{
echo '<p>'.TB_('Uninstalling this plugin will also delete its database tables:').'</p>'
.'<ul>'
.'<li>'
.implode( '</li><li>', $uninstall_tables_to_drop )
.'</li>'
.'</ul>';
}
if( $uninstall_ok === NULL )
{ // Plugin requested this:
$params = array( 'Form' => & $Form );
$admin_Plugins->call_method( $edit_Plugin->ID, 'BeforeUninstallPayload', $params );
}
echo '<p>'.TB_('THIS CANNOT BE UNDONE!').'</p>';
$Form->submit( array( '', TB_('I am sure!'), 'DeleteButton btn-danger' ) );
$Form->end_form();
?>
</div>
<?php // }}}
break;
case 'edit_settings':
$AdminUI->disp_view( 'plugins/views/_plugin_settings.form.php' );
break;
case 'info':
if( $edit_Plugin->status == 'broken' )
{
break;
}
// Display plugin info:
$Form = new Form( $pagenow );
if( $edit_Plugin->ID > 0 && check_user_perm( 'options', 'edit', false ) )
{ // Edit settings button (if installed):
$Form->global_icon( TB_('Edit plugin settings!'), 'edit', $admin_url.'?ctrl=plugins&action=edit_settings&plugin_ID='.$edit_Plugin->ID );
}
// Close button:
$Form->global_icon( TB_('Close info!'), 'close', regenerate_url() );
$Form->begin_form( 'fform', ' ' );
$Form->hidden( 'ctrl', 'plugins' );
$Form->begin_fieldset('Plugin info', array('class' => 'fieldset'));
$Form->info_field( TB_('Name'), $edit_Plugin->name );
$Form->info_field( TB_('Code'),
( empty($edit_Plugin->code) ? ' - ' : $edit_Plugin->code ),
array( 'note' => TB_('This 8-32 character code identifies the plugin when it needs to be called directly and specifically. This is especially useful for renderer plugins and widgets (SkinTags).') ) );
$Form->info_field( TB_('Short desc'), $edit_Plugin->short_desc );
$Form->info_field( TB_('Long desc'), $edit_Plugin->long_desc );
if( $edit_Plugin->ID > 0 )
{ // do not display ID for non registered Plugins
$Form->info_field( TB_('ID'), $edit_Plugin->ID );
}
$Form->info_field( TB_('Version'), $edit_Plugin->version );
$Form->info_field( TB_('Classname'), $edit_Plugin->classname );
$Form->info_field( TB_('Class file'), rel_path_to_base($edit_Plugin->classfile_path ) );
// Help icons (to homepage and README.html), if available:
$help_icons = array();
if( $help_www = $edit_Plugin->get_help_link('$help_url') )
{
$help_icons[] = $help_www;
}
if( ! empty($help_icons) )
{
$Form->info_field( TB_('Help'), implode( ' ', $help_icons ) );
}
if( $edit_Plugin->ID < 1 )
{ // add "Install NOW" submit button (if not already installed)
$registrations = $admin_Plugins->count_regs($edit_Plugin->classname);
if( ! isset( $edit_Plugin->number_of_installs )
|| ( $admin_Plugins->count_regs($edit_Plugin->classname) < $edit_Plugin->number_of_installs ) )
{ // number of installations are not limited or not reached yet
$Form->add_crumb('plugin');
$Form->hidden( 'action', 'install' );
$Form->hidden( 'plugin', $edit_Plugin->classname );
echo '<div class="center">';
$Form->submit( array( '', TB_('Install NOW!'), 'ActionButton btn-primary' ) );
echo '</div>';
}
}
$Form->end_fieldset();
$Form->end_form();
$action = '';
break;
}
switch( $action )
{
case 'list':
// Display VIEW:
switch( $tab )
{
case 'shared':
$AdminUI->disp_view( 'plugins/views/_plugin_shared_settings.form.php' );
break;
default:
$AdminUI->disp_view( 'plugins/views/_plugin_list.view.php' );
}
break;
case 'list_available':
// Display VIEW:
$AdminUI->disp_view( 'plugins/views/_plugin_list_available.view.php' );
break;
}
// End payload block:
$AdminUI->disp_payload_end();
// Display body bottom, debug info and close </html>:
$AdminUI->disp_global_footer();
?>