mirror of
https://github.com/phpbb/phpbb.git
synced 2025-05-12 02:25:18 +02:00
6c44dadecb
Version numbers 3.1 updates Restore database_update.php file to what it was in develop Get first forum to place global announcements in PHPBB3-9737
447 lines
14 KiB
PHP
447 lines
14 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
* @package migration
|
|
* @copyright (c) 2012 phpBB Group
|
|
* @license http://opensource.org/licenses/gpl-license.php GNU Public License v2
|
|
*
|
|
*/
|
|
|
|
class phpbb_db_migration_tools_module
|
|
{
|
|
/** @var phpbb_cache_service */
|
|
protected $cache = null;
|
|
|
|
/** @var dbal */
|
|
protected $db = null;
|
|
|
|
/** @var phpbb_user */
|
|
protected $user = null;
|
|
|
|
/** @var string */
|
|
protected $phpbb_root_path = null;
|
|
|
|
/** @var string */
|
|
protected $php_ext = null;
|
|
|
|
public function __construct(dbal $db, phpbb_cache_driver_interface $cache, $user, $phpbb_root_path, $php_ext)
|
|
{
|
|
$this->db = $db;
|
|
$this->cache = $cache;
|
|
$this->user = $user;
|
|
$this->phpbb_root_path = $phpbb_root_path;
|
|
$this->php_ext = $php_ext;
|
|
}
|
|
|
|
/**
|
|
* Module Exists
|
|
*
|
|
* Check if a module exists
|
|
*
|
|
* @param string $class The module class(acp|mcp|ucp)
|
|
* @param int|string|bool $parent The parent module_id|module_langname (0 for no parent). Use false to ignore the parent check and check class wide.
|
|
* @param int|string $module The module_id|module_langname you would like to check for to see if it exists
|
|
*
|
|
* @return bool true/false if module exists
|
|
*/
|
|
public function exists($class, $parent, $module)
|
|
{
|
|
// the main root directory should return true
|
|
if (!$module)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
$class = $this->db->sql_escape($class);
|
|
$module = $this->db->sql_escape($module);
|
|
|
|
$parent_sql = '';
|
|
if ($parent !== false)
|
|
{
|
|
// Allows '' to be sent as 0
|
|
$parent = (!$parent) ? 0 : $parent;
|
|
|
|
if (!is_numeric($parent))
|
|
{
|
|
$sql = 'SELECT module_id FROM ' . MODULES_TABLE . "
|
|
WHERE module_langname = '" . $this->db->sql_escape($parent) . "'
|
|
AND module_class = '$class'";
|
|
$result = $this->db->sql_query($sql);
|
|
$row = $this->db->sql_fetchrow($result);
|
|
$this->db->sql_freeresult($result);
|
|
|
|
if (!$row)
|
|
{
|
|
return false;
|
|
}
|
|
|
|
$parent_sql = 'AND parent_id = ' . (int) $row['module_id'];
|
|
}
|
|
else
|
|
{
|
|
$parent_sql = 'AND parent_id = ' . (int) $parent;
|
|
}
|
|
}
|
|
|
|
$sql = 'SELECT module_id FROM ' . MODULES_TABLE . "
|
|
WHERE module_class = '$class'
|
|
$parent_sql
|
|
AND " . ((is_numeric($module)) ? 'module_id = ' . (int) $module : "module_langname = '$module'");
|
|
$result = $this->db->sql_query($sql);
|
|
$row = $this->db->sql_fetchrow($result);
|
|
$this->db->sql_freeresult($result);
|
|
|
|
if ($row)
|
|
{
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Module Add
|
|
*
|
|
* Add a new module
|
|
*
|
|
* @param string $class The module class(acp|mcp|ucp)
|
|
* @param int|string $parent The parent module_id|module_langname (0 for no parent)
|
|
* @param array $data an array of the data on the new module. This can be setup in two different ways.
|
|
* 1. The "manual" way. For inserting a category or one at a time. It will be merged with the base array shown a bit below,
|
|
* but at the least requires 'module_langname' to be sent, and, if you want to create a module (instead of just a category) you must send module_basename and module_mode.
|
|
* array(
|
|
* 'module_enabled' => 1,
|
|
* 'module_display' => 1,
|
|
* 'module_basename' => '',
|
|
* 'module_class' => $class,
|
|
* 'parent_id' => (int) $parent,
|
|
* 'module_langname' => '',
|
|
* 'module_mode' => '',
|
|
* 'module_auth' => '',
|
|
* )
|
|
* 2. The "automatic" way. For inserting multiple at a time based on the specs in the info file for the module(s). For this to work the modules must be correctly setup in the info file.
|
|
* An example follows (this would insert the settings, log, and flag modes from the includes/acp/info/acp_asacp.php file):
|
|
* array(
|
|
* 'module_basename' => 'asacp',
|
|
* 'modes' => array('settings', 'log', 'flag'),
|
|
* )
|
|
* Optionally you may not send 'modes' and it will insert all of the modules in that info file.
|
|
* @param string|bool $include_path If you would like to use a custom include path, specify that here
|
|
*/
|
|
public function add($class, $parent = 0, $data = array(), $include_path = false)
|
|
{
|
|
// Allows '' to be sent as 0
|
|
$parent = (!$parent) ? 0 : $parent;
|
|
|
|
// allow sending the name as a string in $data to create a category
|
|
if (!is_array($data))
|
|
{
|
|
$data = array('module_langname' => $data);
|
|
}
|
|
|
|
if (!isset($data['module_langname']))
|
|
{
|
|
/**
|
|
* @TODO does not work with 3.1 modules yet, but must continue for old 3.0 versions for
|
|
* upgrades from a 3.0.x version to 3.1
|
|
*/
|
|
// The "automatic" way
|
|
$basename = (isset($data['module_basename'])) ? $data['module_basename'] : '';
|
|
$basename = str_replace(array('/', '\\'), '', $basename);
|
|
$class = str_replace(array('/', '\\'), '', $class);
|
|
$info_file = "$class/info/{$class}_$basename.{$this->php_ext}";
|
|
|
|
// The manual and automatic ways both failed...
|
|
if (!file_exists((($include_path === false) ? $this->phpbb_root_path . 'includes/' : $include_path) . $info_file))
|
|
{
|
|
throw new phpbb_db_migration_exception('MODULE_ADD', $class, $info_file);
|
|
}
|
|
|
|
$classname = "{$class}_{$basename}_info";
|
|
|
|
if (!class_exists($classname))
|
|
{
|
|
include((($include_path === false) ? $this->phpbb_root_path . 'includes/' : $include_path) . $info_file);
|
|
}
|
|
|
|
$info = new $classname;
|
|
$module = $info->module();
|
|
unset($info);
|
|
|
|
$result = '';
|
|
foreach ($module['modes'] as $mode => $module_info)
|
|
{
|
|
if (!isset($data['modes']) || in_array($mode, $data['modes']))
|
|
{
|
|
$new_module = array(
|
|
'module_basename' => $basename,
|
|
'module_langname' => $module_info['title'],
|
|
'module_mode' => $mode,
|
|
'module_auth' => $module_info['auth'],
|
|
'module_display' => (isset($module_info['display'])) ? $module_info['display'] : true,
|
|
'before' => (isset($module_info['before'])) ? $module_info['before'] : false,
|
|
'after' => (isset($module_info['after'])) ? $module_info['after'] : false,
|
|
);
|
|
|
|
// Run the "manual" way with the data we've collected.
|
|
$result .= ((isset($data['spacer'])) ? $data['spacer'] : '<br />') . $this->add($class, $parent, $new_module);
|
|
}
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
// The "manual" way
|
|
add_log('admin', 'LOG_MODULE_ADD', ((isset($this->user->lang[$data['module_langname']])) ? $this->user->lang[$data['module_langname']] : $data['module_langname']));
|
|
|
|
$class = $this->db->sql_escape($class);
|
|
|
|
if (!is_numeric($parent))
|
|
{
|
|
$sql = 'SELECT module_id FROM ' . MODULES_TABLE . "
|
|
WHERE module_langname = '" . $this->db->sql_escape($parent) . "'
|
|
AND module_class = '$class'";
|
|
$result = $this->db->sql_query($sql);
|
|
$row = $this->db->sql_fetchrow($result);
|
|
$this->db->sql_freeresult($result);
|
|
|
|
if (!$row)
|
|
{
|
|
throw new phpbb_db_migration_exception('MODULE_PARENT_NOT_EXIST', $parent);
|
|
}
|
|
|
|
$parent = $data['parent_id'] = $row['module_id'];
|
|
}
|
|
else if (!$this->exists($class, false, $parent))
|
|
{
|
|
throw new phpbb_db_migration_exception('MODULE_PARENT_NOT_EXIST', $parent);
|
|
}
|
|
|
|
if ($this->exists($class, $parent, $data['module_langname']))
|
|
{
|
|
throw new phpbb_db_migration_exception('MODULE_ALREADY_EXIST', $data['module_langname']);
|
|
}
|
|
|
|
if (!class_exists('acp_modules'))
|
|
{
|
|
include($this->phpbb_root_path . 'includes/acp/acp_modules.' . $this->php_ext);
|
|
$this->user->add_lang('acp/modules');
|
|
}
|
|
$acp_modules = new acp_modules();
|
|
|
|
$module_data = array(
|
|
'module_enabled' => (isset($data['module_enabled'])) ? $data['module_enabled'] : 1,
|
|
'module_display' => (isset($data['module_display'])) ? $data['module_display'] : 1,
|
|
'module_basename' => (isset($data['module_basename'])) ? $data['module_basename'] : '',
|
|
'module_class' => $class,
|
|
'parent_id' => (int) $parent,
|
|
'module_langname' => (isset($data['module_langname'])) ? $data['module_langname'] : '',
|
|
'module_mode' => (isset($data['module_mode'])) ? $data['module_mode'] : '',
|
|
'module_auth' => (isset($data['module_auth'])) ? $data['module_auth'] : '',
|
|
);
|
|
$result = $acp_modules->update_module_data($module_data, true);
|
|
|
|
// update_module_data can either return a string or an empty array...
|
|
if (is_string($result))
|
|
{
|
|
// Error
|
|
throw new phpbb_db_migration_exception('MODULE_ERROR', $result);
|
|
}
|
|
else
|
|
{
|
|
// Success
|
|
|
|
// Move the module if requested above/below an existing one
|
|
if (isset($data['before']) && $data['before'])
|
|
{
|
|
$sql = 'SELECT left_id FROM ' . MODULES_TABLE . '
|
|
WHERE module_class = \'' . $class . '\'
|
|
AND parent_id = ' . (int) $parent . '
|
|
AND module_langname = \'' . $this->db->sql_escape($data['before']) . '\'';
|
|
$this->db->sql_query($sql);
|
|
$to_left = $this->db->sql_fetchfield('left_id');
|
|
|
|
$sql = 'UPDATE ' . MODULES_TABLE . " SET left_id = left_id + 2, right_id = right_id + 2
|
|
WHERE module_class = '$class'
|
|
AND left_id >= $to_left
|
|
AND left_id < {$module_data['left_id']}";
|
|
$this->db->sql_query($sql);
|
|
|
|
$sql = 'UPDATE ' . MODULES_TABLE . " SET left_id = $to_left, right_id = " . ($to_left + 1) . "
|
|
WHERE module_class = '$class'
|
|
AND module_id = {$module_data['module_id']}";
|
|
$this->db->sql_query($sql);
|
|
}
|
|
else if (isset($data['after']) && $data['after'])
|
|
{
|
|
$sql = 'SELECT right_id FROM ' . MODULES_TABLE . '
|
|
WHERE module_class = \'' . $class . '\'
|
|
AND parent_id = ' . (int) $parent . '
|
|
AND module_langname = \'' . $this->db->sql_escape($data['after']) . '\'';
|
|
$this->db->sql_query($sql);
|
|
$to_right = $this->db->sql_fetchfield('right_id');
|
|
|
|
$sql = 'UPDATE ' . MODULES_TABLE . " SET left_id = left_id + 2, right_id = right_id + 2
|
|
WHERE module_class = '$class'
|
|
AND left_id >= $to_right
|
|
AND left_id < {$module_data['left_id']}";
|
|
$this->db->sql_query($sql);
|
|
|
|
$sql = 'UPDATE ' . MODULES_TABLE . ' SET left_id = ' . ($to_right + 1) . ', right_id = ' . ($to_right + 2) . "
|
|
WHERE module_class = '$class'
|
|
AND module_id = {$module_data['module_id']}";
|
|
$this->db->sql_query($sql);
|
|
}
|
|
}
|
|
|
|
// Clear the Modules Cache
|
|
$this->cache->destroy("_modules_$class");
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Module Remove
|
|
*
|
|
* Remove a module
|
|
*
|
|
* @param string $class The module class(acp|mcp|ucp)
|
|
* @param int|string|bool $parent The parent module_id|module_langname (0 for no parent). Use false to ignore the parent check and check class wide.
|
|
* @param int|string $module The module id|module_langname
|
|
* @param string|bool $include_path If you would like to use a custom include path, specify that here
|
|
*/
|
|
public function remove($class, $parent = 0, $module = '', $include_path = false)
|
|
{
|
|
// Imitation of module_add's "automatic" and "manual" method so the uninstaller works from the same set of instructions for umil_auto
|
|
if (is_array($module))
|
|
{
|
|
if (isset($module['module_langname']))
|
|
{
|
|
// Manual Method
|
|
return $this->remove($class, $parent, $module['module_langname'], $include_path);
|
|
}
|
|
|
|
// Failed.
|
|
if (!isset($module['module_basename']))
|
|
{
|
|
throw new phpbb_db_migration_exception('MODULE_NOT_EXIST');
|
|
}
|
|
|
|
// Automatic method
|
|
$basename = str_replace(array('/', '\\'), '', $module['module_basename']);
|
|
$class = str_replace(array('/', '\\'), '', $class);
|
|
$info_file = "$class/info/{$class}_$basename.{$this->php_ext}";
|
|
|
|
if (!file_exists((($include_path === false) ? $this->phpbb_root_path . 'includes/' : $include_path) . $info_file))
|
|
{
|
|
throw new phpbb_db_migration_exception('MODULE_NOT_EXIST', $info_file);
|
|
}
|
|
|
|
$classname = "{$class}_{$basename}_info";
|
|
|
|
if (!class_exists($classname))
|
|
{
|
|
include((($include_path === false) ? $this->phpbb_root_path . 'includes/' : $include_path) . $info_file);
|
|
}
|
|
|
|
$info = new $classname;
|
|
$module_info = $info->module();
|
|
unset($info);
|
|
|
|
foreach ($module_info['modes'] as $mode => $info)
|
|
{
|
|
if (!isset($module['modes']) || in_array($mode, $module['modes']))
|
|
{
|
|
$this->remove($class, $parent, $info['title']) . '<br />';
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
$class = $this->db->sql_escape($class);
|
|
|
|
if (!$this->exists($class, $parent, $module))
|
|
{
|
|
throw new phpbb_db_migration_exception('MODULE_NOT_EXIST', ((isset($this->user->lang[$module])) ? $this->user->lang[$module] : $module));
|
|
}
|
|
|
|
$parent_sql = '';
|
|
if ($parent !== false)
|
|
{
|
|
// Allows '' to be sent as 0
|
|
$parent = (!$parent) ? 0 : $parent;
|
|
|
|
if (!is_numeric($parent))
|
|
{
|
|
$sql = 'SELECT module_id FROM ' . MODULES_TABLE . "
|
|
WHERE module_langname = '" . $this->db->sql_escape($parent) . "'
|
|
AND module_class = '$class'";
|
|
$result = $this->db->sql_query($sql);
|
|
$row = $this->db->sql_fetchrow($result);
|
|
$this->db->sql_freeresult($result);
|
|
|
|
// we know it exists from the module_exists check
|
|
$parent_sql = 'AND parent_id = ' . (int) $row['module_id'];
|
|
}
|
|
else
|
|
{
|
|
$parent_sql = 'AND parent_id = ' . (int) $parent;
|
|
}
|
|
}
|
|
|
|
$module_ids = array();
|
|
if (!is_numeric($module))
|
|
{
|
|
$module = $this->db->sql_escape($module);
|
|
$sql = 'SELECT module_id FROM ' . MODULES_TABLE . "
|
|
WHERE module_langname = '$module'
|
|
AND module_class = '$class'
|
|
$parent_sql";
|
|
$result = $this->db->sql_query($sql);
|
|
while ($row = $this->db->sql_fetchrow($result))
|
|
{
|
|
$module_ids[] = (int) $row['module_id'];
|
|
}
|
|
$this->db->sql_freeresult($result);
|
|
|
|
$module_name = $module;
|
|
}
|
|
else
|
|
{
|
|
$module = (int) $module;
|
|
$sql = 'SELECT module_langname FROM ' . MODULES_TABLE . "
|
|
WHERE module_id = $module
|
|
AND module_class = '$class'
|
|
$parent_sql";
|
|
$result = $this->db->sql_query($sql);
|
|
$row = $this->db->sql_fetchrow($result);
|
|
$this->db->sql_freeresult($result);
|
|
|
|
$module_name = $row['module_langname'];
|
|
$module_ids[] = $module;
|
|
}
|
|
|
|
if (!class_exists('acp_modules'))
|
|
{
|
|
include($this->phpbb_root_path . 'includes/acp/acp_modules.' . $this->php_ext);
|
|
$this->user->add_lang('acp/modules');
|
|
}
|
|
$acp_modules = new acp_modules();
|
|
$acp_modules->module_class = $class;
|
|
|
|
foreach ($module_ids as $module_id)
|
|
{
|
|
$result = $acp_modules->delete_module($module_id);
|
|
if (!empty($result))
|
|
{
|
|
throw new phpbb_db_migration_exception('CANNOT_REMOVE_MODULE', $module_id);
|
|
}
|
|
}
|
|
|
|
$cache->destroy("_modules_$class");
|
|
|
|
return false;
|
|
}
|
|
}
|
|
} |