Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
44.44% covered (danger)
44.44%
4 / 9
CRAP
76.72% covered (warning)
76.72%
178 / 232
module
0.00% covered (danger)
0.00%
0 / 1
44.44% covered (danger)
44.44%
4 / 9
134.57
76.72% covered (warning)
76.72%
178 / 232
 __construct
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
8 / 8
 get_name
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
1 / 1
 exists
100.00% covered (success)
100.00%
1 / 1
11
100.00% covered (success)
100.00%
30 / 30
 add
0.00% covered (danger)
0.00%
0 / 1
49.75
73.08% covered (warning)
73.08%
76 / 104
 remove
0.00% covered (danger)
0.00%
0 / 1
19.76
62.22% covered (warning)
62.22%
28 / 45
 reverse
0.00% covered (danger)
0.00%
0 / 1
7.54
53.33% covered (warning)
53.33%
8 / 15
 get_module_info
0.00% covered (danger)
0.00%
0 / 1
2.03
80.00% covered (warning)
80.00%
4 / 5
 get_categories_list
100.00% covered (success)
100.00%
1 / 1
2
100.00% covered (success)
100.00%
8 / 8
 get_parent_module_id
0.00% covered (danger)
0.00%
0 / 1
6.01
93.75% covered (success)
93.75%
15 / 16
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\db\migration\tool;
use phpbb\module\exception\module_exception;
/**
* Migration module management tool
*/
class module implements \phpbb\db\migration\tool\tool_interface
{
    /** @var \phpbb\cache\service */
    protected $cache;
    /** @var \phpbb\db\driver\driver_interface */
    protected $db;
    /** @var \phpbb\user */
    protected $user;
    /** @var \phpbb\module\module_manager */
    protected $module_manager;
    /** @var string */
    protected $phpbb_root_path;
    /** @var string */
    protected $php_ext;
    /** @var string */
    protected $modules_table;
    /** @var array */
    protected $module_categories = array();
    /**
    * Constructor
    *
    * @param \phpbb\db\driver\driver_interface $db
    * @param \phpbb\cache\service $cache
    * @param \phpbb\user $user
    * @param \phpbb\module\module_manager    $module_manager
    * @param string $phpbb_root_path
    * @param string $php_ext
    * @param string $modules_table
    */
    public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\cache\service $cache, \phpbb\user $user, \phpbb\module\module_manager $module_manager, $phpbb_root_path, $php_ext, $modules_table)
    {
        $this->db = $db;
        $this->cache = $cache;
        $this->user = $user;
        $this->module_manager = $module_manager;
        $this->phpbb_root_path = $phpbb_root_path;
        $this->php_ext = $php_ext;
        $this->modules_table = $modules_table;
    }
    /**
    * {@inheritdoc}
    */
    public function get_name()
    {
        return 'module';
    }
    /**
    * 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
    * @param bool $lazy Checks lazily if the module exists. Returns true if it exists in at
    *       least one given parent.
    * @return bool true if module exists in *all* given parents, false if not in any given parent;
     *      true if ignoring parent check and module exists class wide, false if not found at all.
    */
    public function exists($class, $parent, $module, $lazy = false)
    {
        // the main root directory should return true
        if (!$module)
        {
            return true;
        }
        $parent_sqls = [];
        if ($parent !== false)
        {
            $parents = $this->get_parent_module_id($parent, $module, false);
            if ($parents === false)
            {
                return false;
            }
            foreach ((array) $parents as $parent_id)
            {
                $parent_sqls[] = 'AND parent_id = ' . (int) $parent_id;
            }
        }
        else
        {
            $parent_sqls[] = '';
        }
        foreach ($parent_sqls as $parent_sql)
        {
            $sql = 'SELECT module_id
                FROM ' . $this->modules_table . "
                WHERE module_class = '" . $this->db->sql_escape($class) . "'
                    $parent_sql
                    AND " . ((is_numeric($module)) ? 'module_id = ' . (int) $module : "module_langname = '" . $this->db->sql_escape($module) . "'");
            $result = $this->db->sql_query($sql);
            $module_id = $this->db->sql_fetchfield('module_id');
            $this->db->sql_freeresult($result);
            if (!$lazy && !$module_id)
            {
                return false;
            }
            if ($lazy && $module_id)
            {
                return true;
            }
        }
        // Returns true, if modules exist in all parents and false otherwise
        return !$lazy;
    }
    /**
    * 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.
    *     path, specify that here
    * @return null
    * @throws \phpbb\db\migration\exception
    */
    public function add($class, $parent = 0, $data = array())
    {
        global $user, $phpbb_log;
        // allow sending the name as a string in $data to create a category
        if (!is_array($data))
        {
            $data = array('module_langname' => $data);
        }
        $parents = (array) $this->get_parent_module_id($parent, $data);
        if (!isset($data['module_langname']))
        {
            // The "automatic" way
            $basename = (isset($data['module_basename'])) ? $data['module_basename'] : '';
            $module = $this->get_module_info($class, $basename);
            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.
                    foreach ($parents as $parent)
                    {
                        $this->add($class, $parent, $new_module);
                    }
                }
            }
            return;
        }
        foreach ($parents as $parent)
        {
            $data['parent_id'] = $parent;
            // The "manual" way
            if (!$this->exists($class, false, $parent))
            {
                throw new \phpbb\db\migration\exception('MODULE_NOT_EXIST', $parent);
            }
            if ($this->exists($class, $parent, $data['module_langname']))
            {
                throw new \phpbb\db\migration\exception('MODULE_EXISTS', $data['module_langname']);
            }
            $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'] : '',
            );
            try
            {
                $this->module_manager->update_module_data($module_data);
                // Success
                $module_log_name = ((isset($this->user->lang[$data['module_langname']])) ? $this->user->lang[$data['module_langname']] : $data['module_langname']);
                $phpbb_log->add('admin', (isset($user->data['user_id'])) ? $user->data['user_id'] : ANONYMOUS, $user->ip, 'LOG_MODULE_ADD', false, array($module_log_name));
                // Move the module if requested above/below an existing one
                if (isset($data['before']) && $data['before'])
                {
                    $before_mode = $before_langname = '';
                    if (is_array($data['before']))
                    {
                        // Restore legacy-legacy behaviour from phpBB 3.0
                        list($before_mode, $before_langname) = $data['before'];
                    }
                    else
                    {
                        // Legacy behaviour from phpBB 3.1+
                        $before_langname = $data['before'];
                    }
                    $sql = 'SELECT left_id
                    FROM ' . $this->modules_table . "
                    WHERE module_class = '" . $this->db->sql_escape($class) . "'
                        AND parent_id = " . (int) $parent . "
                        AND module_langname = '" . $this->db->sql_escape($before_langname) . "'"
                        . (($before_mode) ? " AND module_mode = '" . $this->db->sql_escape($before_mode) . "'" : '');
                    $result = $this->db->sql_query($sql);
                    $to_left = (int) $this->db->sql_fetchfield('left_id');
                    $this->db->sql_freeresult($result);
                    $sql = 'UPDATE ' . $this->modules_table . "
                    SET left_id = left_id + 2, right_id = right_id + 2
                    WHERE module_class = '" . $this->db->sql_escape($class) . "'
                        AND left_id >= $to_left
                        AND left_id < {$module_data['left_id']}";
                    $this->db->sql_query($sql);
                    $sql = 'UPDATE ' . $this->modules_table . "
                    SET left_id = $to_left, right_id = " . ($to_left + 1) . "
                    WHERE module_class = '" . $this->db->sql_escape($class) . "'
                        AND module_id = {$module_data['module_id']}";
                    $this->db->sql_query($sql);
                }
                else if (isset($data['after']) && $data['after'])
                {
                    $after_mode = $after_langname = '';
                    if (is_array($data['after']))
                    {
                        // Restore legacy-legacy behaviour from phpBB 3.0
                        list($after_mode, $after_langname) = $data['after'];
                    }
                    else
                    {
                        // Legacy behaviour from phpBB 3.1+
                        $after_langname = $data['after'];
                    }
                    $sql = 'SELECT right_id
                    FROM ' . $this->modules_table . "
                    WHERE module_class = '" . $this->db->sql_escape($class) . "'
                        AND parent_id = " . (int) $parent . "
                        AND module_langname = '" . $this->db->sql_escape($after_langname) . "'"
                        . (($after_mode) ? " AND module_mode = '" . $this->db->sql_escape($after_mode) . "'" : '');
                    $result = $this->db->sql_query($sql);
                    $to_right = (int) $this->db->sql_fetchfield('right_id');
                    $this->db->sql_freeresult($result);
                    $sql = 'UPDATE ' . $this->modules_table . "
                    SET left_id = left_id + 2, right_id = right_id + 2
                    WHERE module_class = '" . $this->db->sql_escape($class) . "'
                        AND left_id >= $to_right
                        AND left_id < {$module_data['left_id']}";
                    $this->db->sql_query($sql);
                    $sql = 'UPDATE ' . $this->modules_table . '
                    SET left_id = ' . ($to_right + 1) . ', right_id = ' . ($to_right + 2) . "
                    WHERE module_class = '" . $this->db->sql_escape($class) . "'
                        AND module_id = {$module_data['module_id']}";
                    $this->db->sql_query($sql);
                }
            }
            catch (module_exception $e)
            {
                // Error
                throw new \phpbb\db\migration\exception('MODULE_ERROR', $e->getMessage());
            }
        }
        // Clear the Modules Cache
        $this->module_manager->remove_cache_file($class);
    }
    /**
    * 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
    *     specify that here
    * @return null
    * @throws \phpbb\db\migration\exception
    */
    public function remove($class, $parent = 0, $module = '')
    {
        // 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']);
            }
            // Failed.
            if (!isset($module['module_basename']))
            {
                throw new \phpbb\db\migration\exception('MODULE_NOT_EXIST');
            }
            // Automatic method
            $basename = $module['module_basename'];
            $module_info = $this->get_module_info($class, $basename);
            foreach ($module_info['modes'] as $mode => $info)
            {
                if (!isset($module['modes']) || in_array($mode, $module['modes']))
                {
                    $this->remove($class, $parent, $info['title']);
                }
            }
        }
        else
        {
            if (!$this->exists($class, $parent, $module, true))
            {
                return;
            }
            $parent_sql = '';
            if ($parent !== false)
            {
                $parents = (array) $this->get_parent_module_id($parent, $module);
                $parent_sql = 'AND ' . $this->db->sql_in_set('parent_id', $parents);
            }
            $module_ids = array();
            if (!is_numeric($module))
            {
                $sql = 'SELECT module_id
                    FROM ' . $this->modules_table . "
                    WHERE module_langname = '" . $this->db->sql_escape($module) . "'
                        AND module_class = '" . $this->db->sql_escape($class) . "'
                        $parent_sql";
                $result = $this->db->sql_query($sql);
                while ($module_id = $this->db->sql_fetchfield('module_id'))
                {
                    $module_ids[] = (int) $module_id;
                }
                $this->db->sql_freeresult($result);
            }
            else
            {
                $module_ids[] = (int) $module;
            }
            foreach ($module_ids as $module_id)
            {
                $this->module_manager->delete_module($module_id, $class);
            }
            $this->module_manager->remove_cache_file($class);
        }
    }
    /**
    * {@inheritdoc}
    */
    public function reverse()
    {
        $arguments = func_get_args();
        $original_call = array_shift($arguments);
        $call = false;
        switch ($original_call)
        {
            case 'add':
                $call = 'remove';
            break;
            case 'remove':
                $call = 'add';
            break;
            case 'reverse':
                // Reversing a reverse is just the call itself
                $call = array_shift($arguments);
            break;
        }
        if ($call)
        {
            return call_user_func_array(array(&$this, $call), $arguments);
        }
    }
    /**
    * Wrapper for \acp_modules::get_module_infos()
    *
    * @param string $class Module Class
    * @param string $basename Module Basename
    * @return array Module Information
    * @throws \phpbb\db\migration\exception
    */
    protected function get_module_info($class, $basename)
    {
        $module = $this->module_manager->get_module_infos($class, $basename, true);
        if (empty($module))
        {
            throw new \phpbb\db\migration\exception('MODULE_INFO_FILE_NOT_EXIST', $class, $basename);
        }
        return array_pop($module);
    }
    /**
    * Get the list of installed module categories
    *    key - module_id
    *    value - module_langname
    *
    * @return null
    */
    protected function get_categories_list()
    {
        // Select the top level categories
        // and 2nd level [sub]categories
        $sql = 'SELECT m2.module_id, m2.module_langname
            FROM ' . $this->modules_table . ' m1, ' . $this->modules_table . " m2
            WHERE m1.parent_id = 0
                AND (m1.module_id = m2.module_id OR m2.parent_id = m1.module_id)
            ORDER BY m1.module_id, m2.module_id ASC";
        $result = $this->db->sql_query($sql);
        while ($row = $this->db->sql_fetchrow($result))
        {
            $this->module_categories[(int) $row['module_id']] = $row['module_langname'];
        }
        $this->db->sql_freeresult($result);
    }
    /**
    * Get parent module id
    *
    * @param string|int $parent_id The parent module_id|module_langname
    * @param int|string|array $data The module_id, module_langname for existance checking or module data array for adding
    * @param bool $throw_exception The flag indicating if exception should be thrown on error
    * @return mixed The int parent module_id, an array of int parent module_id values or false
    * @throws \phpbb\db\migration\exception
    */
    public function get_parent_module_id($parent_id, $data = '', $throw_exception = true)
    {
        // Allow '' to be sent as 0
        $parent_id = $parent_id ?: 0;
        if (!is_numeric($parent_id))
        {
            // Refresh the $module_categories array
            $this->get_categories_list();
            // Search for the parent module_langname
            $ids = array_keys($this->module_categories, $parent_id);
            switch (count($ids))
            {
                // No parent with the given module_langname exist
                case 0:
                    if ($throw_exception)
                    {
                        throw new \phpbb\db\migration\exception('MODULE_NOT_EXIST', $parent_id);
                    }
                    return false;
                break;
                // Return the module id
                case 1:
                    return (int) $ids[0];
                break;
                default:
                    // This represents the old behaviour of phpBB 3.0
                    return $ids;
                break;
            }
        }
        return $parent_id;
    }
}