. */ 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 '
'; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; echo ''; $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 ''; self::display_dashboard_plugin_checkboxes($testplugin); for ($i = 0; $i < count($table_cols); $i++) { if (isset($plugin_info[strtolower($table_cols[$i])])) { echo ''; } else { echo ''; } } echo ''; } else { if ($testplugin != 'css') { 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 ''; echo ''; } else { echo ''; } } else { echo ''; } } echo ''; } } echo '
'.get_lang('Enabled').''.get_lang('Name').''.get_lang('Version').''.get_lang('Description').'
'; echo $plugin_info[$table_cols[$i]]; echo '
'; for ($j = 0; $j < count($table_cols); $j++) { if (isset($disabled_block[strtolower($table_cols[$j])])) { if ($j == 2) { echo '		'; echo ''.$disabled_block[$table_cols[$j]].'
'; echo ''.get_lang('This plugin has been deleted from the dashboard plugin directory').''; echo '		'; echo ''.$disabled_block[$table_cols[$j]].''; echo ' 
'; echo '
'; echo '
'; } /** * 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 ""; echo ''; echo ""; } /** * 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(name, 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)) { $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 .= '
'; $html .= '
'.get_lang('Select blocks to display in the dashboard blocks view').'

'; $html .= '
'; $html .= ''; $html .= ''; $html .= ''; $html .= ''; $html .= ''; $html .= ''; $html .= ''; // 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 .= ''; // checkboxes $html .= self::display_user_dashboard_list_checkboxes($user_id, $block['id']); $html .= ''; $html .= ''; $html .= ''; $html .= ''; } else { $html .= Display::tag('tr', Display::tag('td', get_lang('Error').' '.$controller_class, ['colspan' => '3'])); } } $html .= '
'; $html .= get_lang('Enabled'); $html .= ''; $html .= get_lang('Name'); $html .= ''; $html .= get_lang('Description'); $html .= ''; $html .= get_lang('Position (column)'); $html .= '
'.$block['name'].''.$block['description'].'
'; $html .= '
'; $html .= ''; $html .= '
'; } else { $html .= '
'.get_lang('ThereAreNoEnabledDashboard plugins').'
'; if (api_is_platform_admin()) { $html .= ''. get_lang('Configure Dashboard Plugin').''; } } 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 = ""; $html .= ''; $html .= ""; 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 ''.PHP_EOL; } }