301 lines
8.1 KiB
PHP
301 lines
8.1 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
* @package Board3 Portal v2.3
|
|
* @copyright (c) 2023 Board3 Group ( www.board3.de )
|
|
* @license GNU General Public License, version 2 (GPL-2.0-only)
|
|
*
|
|
*/
|
|
|
|
namespace board3\portal\controller;
|
|
|
|
class helper
|
|
{
|
|
/** @var \board3\portal\portal\columns */
|
|
protected $portal_columns;
|
|
|
|
/**
|
|
* Auth object
|
|
* @var \phpbb\auth\auth
|
|
*/
|
|
protected $auth;
|
|
|
|
/**
|
|
* phpBB Config object
|
|
* @var \phpbb\config\config
|
|
*/
|
|
protected $config;
|
|
|
|
/** @var \phpbb\language\language */
|
|
protected $language;
|
|
|
|
/**
|
|
* Template object
|
|
* @var \phpbb\template
|
|
*/
|
|
protected $template;
|
|
|
|
/**
|
|
* User object
|
|
* @var \phpbb\user
|
|
*/
|
|
protected $user;
|
|
|
|
/**
|
|
* phpBB root path
|
|
* @var string
|
|
*/
|
|
protected $phpbb_root_path;
|
|
|
|
/**
|
|
* PHP file extension
|
|
* @var string
|
|
*/
|
|
protected $php_ext;
|
|
|
|
/**
|
|
* Portal root path
|
|
* @var string
|
|
*/
|
|
protected $root_path;
|
|
|
|
/**
|
|
* phpBB path helper
|
|
* @var \phpbb\path_helper
|
|
*/
|
|
protected $path_helper;
|
|
|
|
/**
|
|
* Portal Helper object
|
|
* @var \board3\portal\includes\helper
|
|
*/
|
|
protected $portal_helper;
|
|
|
|
/**
|
|
* Portal modules array
|
|
* @var array
|
|
*/
|
|
protected $portal_modules;
|
|
|
|
/** @var int Board3 module disabled */
|
|
const B3_MODULE_DISABLED = 0;
|
|
|
|
/**
|
|
* Constructor
|
|
* NOTE: The parameters of this method must match in order and type with
|
|
* the dependencies defined in the services.yml file for this service.
|
|
* @param \phpbb\auth\auth $auth Auth object
|
|
* @param \board3\portal\portal\columns $portal_columns Board3 Portal columns object
|
|
* @param \phpbb\config\config $config phpBB Config object
|
|
* @param \phpbb\language\language $language phpBB language
|
|
* @param \phpbb\template $template Template object
|
|
* @param \phpbb\user $user User object
|
|
* @param \phpbb\path_helper $path_helper phpBB path helper
|
|
* @param \board3\portal\includes\helper $portal_helper Portal helper class
|
|
* @param string $phpbb_root_path phpBB root path
|
|
* @param string $php_ext PHP file extension
|
|
*/
|
|
public function __construct($auth, $portal_columns, $config, $language, $template, $user, $path_helper, $portal_helper, $phpbb_root_path, $php_ext)
|
|
{
|
|
$this->auth = $auth;
|
|
$this->portal_columns = $portal_columns;
|
|
$this->config = $config;
|
|
$this->language = $language;
|
|
$this->template = $template;
|
|
$this->user = $user;
|
|
$this->path_helper = $path_helper;
|
|
$this->phpbb_root_path = $phpbb_root_path;
|
|
$this->php_ext = $php_ext;
|
|
$this->portal_helper = $portal_helper;
|
|
|
|
$this->root_path = str_replace($this->path_helper->get_web_root_path(), '', $phpbb_root_path . 'ext/board3/portal/');
|
|
}
|
|
|
|
/**
|
|
* Check if user should be able to access this page. Redirect to index
|
|
* if this does not apply.
|
|
*
|
|
* @return null
|
|
*/
|
|
protected function check_permission()
|
|
{
|
|
if (empty($this->config['board3_enable']) || !$this->auth->acl_get('u_view_portal'))
|
|
{
|
|
redirect(append_sid($this->phpbb_root_path . 'index' . $this->php_ext));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return true if online list should be displayed
|
|
*
|
|
* @return mixed True if online list should be display, current value
|
|
* if unsure
|
|
*/
|
|
public function check_online_list($module_classname, $display_online)
|
|
{
|
|
return ($module_classname === '\board3\portal\modules\whois_online') ? true : $display_online;
|
|
}
|
|
|
|
/**
|
|
* Get portal module and run module start checks
|
|
*
|
|
* @param array $row Module row
|
|
*
|
|
* @return mixed False if one of the module checks failed, the module
|
|
* object if checks were successful
|
|
*/
|
|
public function get_portal_module($row)
|
|
{
|
|
// Do not try to load non-existent or disabled modules
|
|
if ($row['module_status'] == self::B3_MODULE_DISABLED || !is_object($module = $this->portal_helper->get_module($row['module_classname'])))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Check if module shouldn't be loaded
|
|
if ($this->check_column_disabled($row))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Check for permissions before loading anything
|
|
* the default group of a user always defines his/her permission
|
|
*/
|
|
return ($this->check_group_access($row)) ? $module : false;
|
|
}
|
|
|
|
/**
|
|
* Check if column is disabled
|
|
*
|
|
* @param array $row Module database row
|
|
*
|
|
* @return bool False if column is not disabled, true if it is
|
|
*/
|
|
protected function check_column_disabled($row)
|
|
{
|
|
return ($this->config['board3_left_column'] === false && $this->portal_columns->number_to_string($row['module_column']) === 'left') || ($this->config['board3_right_column'] === false && $this->portal_columns->number_to_string($row['module_column']) === 'right');
|
|
}
|
|
|
|
/**
|
|
* Check if user is in required groups.
|
|
* If the group_ary is empty, this means that there are no limitation on
|
|
* which groups can see this module.
|
|
*
|
|
* @param array $row Module row
|
|
*
|
|
* @return bool True if group has access, false if not
|
|
*/
|
|
protected function check_group_access($row)
|
|
{
|
|
$group_ary = (!empty($row['module_group_ids'])) ? explode(',', $row['module_group_ids']) : '';
|
|
if ((is_array($group_ary) && !in_array($this->user->data['group_id'], $group_ary)))
|
|
{
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Load language file of module
|
|
*
|
|
* @param object $module Module of which language file should be loaded
|
|
*/
|
|
public function load_module_language($module)
|
|
{
|
|
if ($language_file = $module->get_language())
|
|
{
|
|
// Load language file from vendor if specified
|
|
if (is_array($language_file))
|
|
{
|
|
$this->language->add_lang($language_file['file'], $language_file['vendor']);
|
|
}
|
|
else
|
|
{
|
|
$this->language->add_lang('modules/' . $language_file, 'board3/portal');
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Assign module's template vars
|
|
*
|
|
* @param array $row Database row of module
|
|
* @param mixed $template_module Template data as returned by module
|
|
*
|
|
* @return null
|
|
*/
|
|
public function assign_module_vars($row, $template_module)
|
|
{
|
|
$fa_styles = json_decode($this->config['board3_portal_fa_styles']);
|
|
$use_fa = !empty($fa_styles) && in_array($this->user->style['style_name'], $fa_styles);
|
|
|
|
if (is_array($template_module))
|
|
{
|
|
$this->template->assign_block_vars('modules_' . $this->portal_columns->number_to_string($row['module_column']), array(
|
|
'TEMPLATE_FILE' => $this->parse_template_file($template_module['template']),
|
|
'IMAGE_SRC' => $this->path_helper->get_web_root_path() . ltrim($this->root_path . 'styles/all/theme/images/portal/' . $template_module['image_src'], './'),
|
|
'TITLE' => $template_module['title'],
|
|
'CODE' => $template_module['code'],
|
|
'MODULE_ID' => $row['module_id'],
|
|
'IMAGE_WIDTH' => $row['module_image_width'],
|
|
'IMAGE_HEIGHT' => $row['module_image_height'],
|
|
'FA_ICON' => isset($row['module_fa_icon']) ? utf8_htmlspecialchars($row['module_fa_icon']) : '',
|
|
'FA_SIZE' => $row['module_fa_size'] ?? '',
|
|
'FA_ENABLED' => $use_fa,
|
|
));
|
|
}
|
|
else
|
|
{
|
|
$this->template->assign_block_vars('modules_' . $this->portal_columns->number_to_string($row['module_column']), array(
|
|
'TEMPLATE_FILE' => $this->parse_template_file($template_module),
|
|
'IMAGE_SRC' => $this->path_helper->get_web_root_path() . ltrim($this->root_path . 'styles/all/theme/images/portal/' . $row['module_image_src'], './'),
|
|
'IMAGE_WIDTH' => $row['module_image_width'],
|
|
'IMAGE_HEIGHT' => $row['module_image_height'],
|
|
'MODULE_ID' => $row['module_id'],
|
|
'TITLE' => (isset($this->user->lang[$row['module_name']])) ? $this->user->lang[$row['module_name']] : utf8_normalize_nfc($row['module_name']),
|
|
'FA_ICON' => isset($row['module_fa_icon']) ? utf8_htmlspecialchars($row['module_fa_icon']) : '',
|
|
'FA_SIZE' => $row['module_fa_size'] ?? '',
|
|
'FA_ENABLED' => $use_fa,
|
|
));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Run initial tasks that are required for a properly setup extension
|
|
*
|
|
* @return null
|
|
*/
|
|
public function run_initial_tasks()
|
|
{
|
|
// Check for permissions first
|
|
$this->check_permission();
|
|
|
|
// Load language file
|
|
$this->language->add_lang('portal', 'board3/portal');
|
|
|
|
// Obtain portal config
|
|
obtain_portal_config();
|
|
}
|
|
|
|
/**
|
|
* Parse template file by prefixing default modules with the portal path
|
|
*
|
|
* @param string $template_file HTML template
|
|
*
|
|
* @return string Parsed template file
|
|
*/
|
|
protected function parse_template_file($template_file)
|
|
{
|
|
if (strpos($template_file, '@') === false)
|
|
{
|
|
$template_file = 'portal/modules/' . $template_file;
|
|
}
|
|
|
|
return $template_file;
|
|
}
|
|
}
|