public/main/inc/lib/dashboard.lib.php
<?php
/* For licensing terms, see /license.txt */
/**
* DashboardManager can be used to manage dashboard
* author Christian Fasanando <christian1827@gmail.com>.
*/
class DashboardManager
{
/**
* Constructor.
*/
public function __construct()
{
}
/**
* This function allows easy activating and inactivating of dashboard plugins.
*/
public static function handle_dashboard_plugins()
{
$token = Security::get_existing_token();
$tokenCondition = '&sec_token='.$token;
/* We scan the plugin directory. Each folder is a potential plugin. */
$dashboard_pluginpath = api_get_path(SYS_PLUGIN_PATH).'dashboard/';
$possiblePlugins = self::getPossibleDashboardPluginsPath();
$table_cols = ['name', 'version', 'description'];
echo Display::page_subheader(get_lang('Dashboard plugins'));
echo '<form name="plugins" method="post" action="'.api_get_self().'?category='.Security::remove_XSS($_GET['category']).$tokenCondition.'">';
echo '<table class="table table-hover">';
echo '<tr>';
echo '<th width="50px">'.get_lang('Enabled').'</th>';
echo '<th width="250px">'.get_lang('Name').'</th>';
echo '<th width="100px">'.get_lang('Version').'</th>';
echo '<th>'.get_lang('Description').'</th>';
echo '</tr>';
$disabled_blocks_data = self::get_block_data_without_plugin();
// We display all the possible enabled or disabled plugins
foreach ($possiblePlugins as $testplugin) {
$plugin_info_file = $dashboard_pluginpath.$testplugin."/$testplugin.info";
if (file_exists($plugin_info_file) && is_readable($plugin_info_file)) {
$plugin_info = api_parse_info_file($plugin_info_file);
// change index to lower case
$plugin_info = array_change_key_case($plugin_info);
echo '<tr>';
self::display_dashboard_plugin_checkboxes($testplugin);
for ($i = 0; $i < count($table_cols); $i++) {
$key = $table_cols[$i];
if (isset($plugin_info[$key])) {
echo '<td>';
echo $plugin_info[$key];
echo '</td>';
} else {
echo '<td></td>';
}
}
echo '</tr>';
} else {
if ('css' != $testplugin) {
echo Display::tag(
'tr',
Display::tag(
'td',
get_lang('Check file permissions').' '.Security::remove_XSS($plugin_info_file),
['colspan' => '3']
)
);
}
}
}
// display all disabled block data
if (count($disabled_blocks_data) > 0) {
foreach ($disabled_blocks_data as $disabled_block) {
echo '<tr style="background-color:#eee">';
echo '<td><center><input type="checkbox" name="disabled_block" value="true" checked disabled /></center>';
for ($j = 0; $j < count($table_cols); $j++) {
$key = $table_cols[$j];
if (isset($disabled_block[$key])) {
if (2 == $j) {
echo '<td>';
echo '<font color="#aaa">'.$disabled_block[$key].'</font><br />';
echo '<font color="red">'.get_lang('This plugin has been deleted from the dashboard plugin directory').'</font>';
echo '</td>';
} else {
echo '<td>';
echo '<font color="#aaa">'.$disabled_block[$key].'</font>';
echo '</td>';
}
} else {
echo '<td> </td>';
}
}
echo '</tr>';
}
}
echo '</table>';
echo '<br />';
echo '<button
class="btn btn--plain"
type="submit"
name="submit_dashboard_plugins"
value="'.get_lang('EnableDashboard plugins').'">'.
get_lang('EnableDashboard plugins').'</button></form>';
}
/**
* display checkboxes for dashboard plugin list.
*
* @param string $plugin_path
*/
public static function display_dashboard_plugin_checkboxes($plugin_path)
{
$tbl_block = Database::get_main_table(TABLE_MAIN_BLOCK);
$sql = "SELECT * FROM $tbl_block
WHERE path = '".Database::escape_string($plugin_path)."' AND active = 1";
$rs = Database::query($sql);
$checked = '';
if (Database::num_rows($rs) > 0) {
$checked = "checked";
}
echo "<td align=\"center\">";
echo '<input type="checkbox" name="'.$plugin_path.'" value="true" '.$checked.'/>';
echo "</td>";
}
/**
* This function allows easy activating and inactivating
* of plugins and save them inside db.
*
* @param array $plugin_paths dashboard plugin paths
* return int affected rows
*/
public static function store_dashboard_plugins($plugin_paths)
{
$tbl_block = Database::get_main_table(TABLE_MAIN_BLOCK);
$affected_rows = 0;
// get all plugins path inside plugin directory
$dashboard_pluginpath = api_get_path(SYS_PLUGIN_PATH).'dashboard/';
$possiblePlugins = self::getPossibleDashboardPluginsPath();
if (count($possiblePlugins) > 0) {
$selected_plugins = array_intersect(array_keys($plugin_paths), $possiblePlugins);
$not_selected_plugins = array_diff($possiblePlugins, array_keys($plugin_paths));
// get blocks id from not selected path
$not_selected_blocks_id = [];
foreach ($not_selected_plugins as $plugin) {
$block_data = self::get_enabled_dashboard_blocks($plugin);
if (!empty($block_data[$plugin])) {
$not_selected_blocks_id[] = $block_data[$plugin]['id'];
}
}
/* clean not selected plugins for extra user data and block data */
// clean from extra user data
$field_variable = 'dashboard';
$extra_user_data = UserManager::get_extra_user_data_by_field_variable($field_variable);
if (!empty($extra_user_data) && count($extra_user_data) > 0) {
foreach ($extra_user_data as $key => $user_data) {
$user_id = $key;
$user_block_data = self::get_user_block_data($user_id);
$user_block_id = array_keys($user_block_data);
// clean disabled block data
foreach ($user_block_id as $block_id) {
if (in_array($block_id, $not_selected_blocks_id)) {
unset($user_block_data[$block_id]);
}
}
// get columns and blocks id for updating extra user data
$columns = [];
$user_blocks_id = [];
foreach ($user_block_data as $data) {
$user_blocks_id[$data['block_id']] = true;
$columns[$data['block_id']] = $data['column'];
}
// update extra user blocks data
self::store_user_blocks($user_id, $user_blocks_id, $columns);
}
}
// clean from block data
if (!empty($not_selected_blocks_id)) {
$sql_check = "SELECT id FROM $tbl_block
WHERE id IN(".implode(',', $not_selected_blocks_id).")";
$rs_check = Database::query($sql_check);
if (Database::num_rows($rs_check) > 0) {
$del = "DELETE FROM $tbl_block WHERE id IN(".implode(',', $not_selected_blocks_id).")";
Database::query($del);
}
}
// store selected plugins
if (!empty($selected_plugins) && count($selected_plugins) > 0) {
foreach ($selected_plugins as $testplugin) {
$selected_path = Database::escape_string($testplugin);
// check if the path already stored inside block table for updating or adding it
$sql = "SELECT path FROM $tbl_block WHERE path = '$selected_path'";
$rs = Database::query($sql);
if (Database::num_rows($rs) > 0) {
// update
$upd = "UPDATE $tbl_block SET active = 1 WHERE path = '$selected_path'";
$result = Database::query($upd);
$affected_rows = Database::affected_rows($result);
} else {
// insert
$plugin_info_file = $dashboard_pluginpath.$testplugin."/$testplugin.info";
$plugin_info = [];
if (file_exists($plugin_info_file)) {
$plugin_info = api_parse_info_file($plugin_info_file);
}
// change keys to lower case
$plugin_info = array_change_key_case($plugin_info);
// setting variables
$plugin_name = $testplugin;
$plugin_description = '';
$plugin_controller = '';
$plugin_path = $testplugin;
if (isset($plugin_info['name'])) {
$plugin_name = Database::escape_string($plugin_info['name']);
}
if (isset($plugin_info['description'])) {
$plugin_description = Database::escape_string($plugin_info['description']);
}
if (isset($plugin_info['controller'])) {
$plugin_controller = Database::escape_string($plugin_info['controller']);
}
$ins = "INSERT INTO $tbl_block(title, description, path, controller, active)
VALUES ('$plugin_name', '$plugin_description', '$plugin_path', '$plugin_controller', 1)";
$result = Database::query($ins);
$affected_rows = Database::affected_rows($result);
}
}
}
}
return $affected_rows;
}
/**
* Get all plugins path inside dashboard directory.
*
* @return array name plugins directories
*/
public static function getPossibleDashboardPluginsPath()
{
// get all plugins path inside plugin directory
/* We scan the plugin directory. Each folder is a potential plugin. */
$possiblePlugins = [];
$dashboard_pluginpath = api_get_path(SYS_PLUGIN_PATH).'dashboard/';
$handle = @opendir($dashboard_pluginpath);
while (false !== ($file = readdir($handle))) {
if ('.' != $file && '..' != $file && is_dir($dashboard_pluginpath.$file)) {
$possiblePlugins[] = $file;
}
}
@closedir($handle);
return $possiblePlugins;
}
/**
* Get all blocks data without plugin directory.
*
* @return array Block data
*/
public static function get_block_data_without_plugin()
{
$tbl_block = Database::get_main_table(TABLE_MAIN_BLOCK);
$possiblePlugins = self::getPossibleDashboardPluginsPath();
// We check if plugin exists inside directory for updating active field
$sql = "SELECT * FROM $tbl_block";
$rs = Database::query($sql);
if (Database::num_rows($rs) > 0) {
while ($row = Database::fetch_array($rs)) {
if (!in_array($row['path'], $possiblePlugins)) {
$active = 0;
} else {
$active = 1;
}
// update active
$upd = "UPDATE $tbl_block SET active = '$active'
WHERE path = '".$row['path']."'";
Database::query($upd);
}
}
// get disabled block data
$block_data = [];
$sql = "SELECT * FROM $tbl_block WHERE active = 0";
$rs_block = Database::query($sql);
if (Database::num_rows($rs_block) > 0) {
while ($row_block = Database::fetch_array($rs_block)) {
if (!isset($row_block['name'])) {
$row_block['name'] = $row_block['title'];
}
$block_data[] = $row_block;
}
}
return $block_data;
}
/**
* get data about enabled dashboard block (stored insise block table).
*
* @param string $path plugin path
*
* @return array data
*/
public static function get_enabled_dashboard_blocks($path = '')
{
$tbl_block = Database::get_main_table(TABLE_MAIN_BLOCK);
$condition_path = '';
if (!empty($path)) {
$path = Database::escape_string($path);
$condition_path = ' AND path = "'.$path.'" ';
}
$sql = "SELECT * FROM $tbl_block WHERE active = 1 $condition_path ";
$rs = Database::query($sql);
$block_data = [];
if (Database::num_rows($rs) > 0) {
while ($row = Database::fetch_array($rs)) {
$block_data[$row['path']] = $row;
}
}
return $block_data;
}
/**
* display user dashboard list.
*
* @param int User id
*/
public static function display_user_dashboard_list($user_id)
{
$enabled_dashboard_plugins = self::get_enabled_dashboard_blocks();
$user_block_data = self::get_user_block_data($user_id);
$html = '';
if (count($enabled_dashboard_plugins) > 0) {
$html .= '<div style="margin-top:20px">';
$html .= '<div><strong>'.get_lang('Select blocks to display in the dashboard blocks view').'</strong></div><br />';
$html .= '<form name="dashboard_list" method="post" action="index.php?action=store_user_block">';
$html .= '<table class="data_table">';
$html .= '<tr>';
$html .= '<th width="5%">';
$html .= get_lang('Enabled');
$html .= '</th>';
$html .= '<th width="30%">';
$html .= get_lang('Name');
$html .= '</th>';
$html .= '<th width="40%">';
$html .= get_lang('Description');
$html .= '</th>';
$html .= '<th>';
$html .= get_lang('Position (column)');
$html .= '</th>';
$html .= '</tr>';
// We display all enabled plugins and the checkboxes
foreach ($enabled_dashboard_plugins as $block) {
$path = $block['path'];
$controller_class = $block['controller'];
$filename_controller = $path.'.class.php';
$dashboard_plugin_path = api_get_path(SYS_PLUGIN_PATH).'dashboard/'.$path.'/';
require_once $dashboard_plugin_path.$filename_controller;
if (class_exists($controller_class)) {
$obj_block = new $controller_class($user_id);
// check if user is allowed to see the block
if (method_exists($obj_block, 'is_block_visible_for_user')) {
$is_block_visible_for_user = $obj_block->is_block_visible_for_user($user_id);
if (!$is_block_visible_for_user) {
continue;
}
}
$html .= '<tr>';
// checkboxes
$html .= self::display_user_dashboard_list_checkboxes($user_id, $block['id']);
$html .= '<td>'.$block['title'].'</td>';
$html .= '<td>'.$block['description'].'</td>';
$html .= '<td>
<select class="selectpicker show-tick form-control" name="columns['.$block['id'].']">
<option value="1" '.(isset($user_block_data[$block['id']]) && 1 == $user_block_data[$block['id']]['column'] ? 'selected' : '').' >1</option>
<option value="2" '.(isset($user_block_data[$block['id']]) && 2 == $user_block_data[$block['id']]['column'] ? 'selected' : '').' >2</option>
</select>
</td>';
$html .= '</tr>';
} else {
$html .= Display::tag('tr', Display::tag('td', get_lang('Error').' '.$controller_class, ['colspan' => '3']));
}
}
$html .= '</table>';
$html .= '<div class="row"><div class="col-md-12">';
$html .= '<button class="btn btn--plain" type="submit" name="submit_dashboard_list" value="'.get_lang('Enable dashboard block').'"><em class="fa fa-check-square"></em> '.
get_lang('Enable dashboard block').'</button></form>';
$html .= '</div></div>';
} else {
$html .= '<div style="margin-top:20px">'.get_lang('ThereAreNoEnabledDashboard plugins').'</div>';
if (api_is_platform_admin()) {
$html .= '<a class="btn btn--plain" href="'.api_get_path(WEB_CODE_PATH).'admin/settings.php?category=Plugins">'.
get_lang('Configure Dashboard Plugin').'</a>';
}
}
return $html;
}
/**
* display checkboxes for user dashboard list.
*
* @param int User id
* @param int Block id
*/
public static function display_user_dashboard_list_checkboxes($user_id, $block_id)
{
$user_id = intval($user_id);
$user_block_data = self::get_user_block_data($user_id);
$enabled_blocks_id = array_keys($user_block_data);
$checked = '';
if (in_array($block_id, $enabled_blocks_id)) {
$checked = "checked";
}
$html = "<td align=\"center\">";
$html .= '<input type="checkbox" name="enabled_blocks['.$block_id.']" value="true" '.$checked.'/>';
$html .= "</td>";
return $html;
}
/**
* This function store enabled blocks id with its column position (block_id1:colum;block_id2:colum; ...)
* inside extra user fields.
*
* @param int $user_id User id
* @param array $enabled_blocks selected blocks
* @param array $columns columns position
*
* @return bool
*/
public static function store_user_blocks($user_id, $enabled_blocks, $columns)
{
$selected_blocks_id = [];
if (is_array($enabled_blocks) && count($enabled_blocks) > 0) {
$selected_blocks_id = array_keys($enabled_blocks);
}
// build data for storing inside extra user field
$fname = 'dashboard';
$fvalue = [];
foreach ($selected_blocks_id as $block_id) {
$fvalue[] = $block_id.':'.$columns[$block_id];
}
$upd_extra_field = UserManager::update_extra_field_value(
$user_id,
$fname,
$fvalue
);
return $upd_extra_field;
}
/**
* This function get user block data (block id with its number of column) from extra user data.
*
* @param int User id
*
* @return array data (block_id,column)
*/
public static function get_user_block_data($user_id)
{
$user_id = intval($user_id);
$field_variable = 'dashboard';
$extra_user_data = UserManager::get_extra_user_data_by_field($user_id, $field_variable);
if (!isset($extra_user_data[$field_variable])) {
return [];
}
$extra_user_data = explode(';', $extra_user_data[$field_variable]);
$data = [];
foreach ($extra_user_data as $extra) {
$split_extra = explode(':', $extra);
if (!empty($split_extra)) {
$block_id = $split_extra[0];
$column = isset($split_extra[1]) ? $split_extra[1] : null;
$data[$block_id] = ['block_id' => $block_id, 'column' => $column];
}
}
return $data;
}
/**
* This function update extra user blocks data after closing a dashboard block.
*
* @param int $user_id User id
* @param string plugin path
*
* @return bool
*/
public static function close_user_block($user_id, $path)
{
$enabled_dashboard_blocks = self::get_enabled_dashboard_blocks($path);
$user_block_data = self::get_user_block_data($user_id);
foreach ($enabled_dashboard_blocks as $enabled_block) {
unset($user_block_data[$enabled_block['id']]);
}
// get columns and blocks id for updating extra user data
$columns = [];
$user_blocks_id = [];
foreach ($user_block_data as $data) {
$user_blocks_id[$data['block_id']] = true;
$columns[$data['block_id']] = $data['column'];
}
// update extra user blocks data
$upd_extra_field = self::store_user_blocks($user_id, $user_blocks_id, $columns);
return $upd_extra_field;
}
/**
* get links for styles from dashboard plugins.
*
* @return string links
*/
public static function getStyleSheet()
{
return '<link rel="stylesheet" href="'.api_get_path(WEB_PLUGIN_PATH).'dashboard/css/default.css" type="text/css" />'.PHP_EOL;
}
}