installedPluginListName)) { $this->installedPluginListName = $this->get_installed_plugins(); } return $this->installedPluginListName; } /** * @return array List of Plugin */ public function getInstalledPluginListObject() { if (empty($this->installedPluginListObject)) { $this->setInstalledPluginListObject(); } return $this->installedPluginListObject; } /** * @return array */ public function setInstalledPluginListObject() { $pluginListName = $this->getInstalledPluginListName(); $pluginList = array(); if (!empty($pluginListName)) { foreach ($pluginListName as $pluginName) { $plugin_info = $this->getPluginInfo($pluginName); if (isset($plugin_info['plugin_class'])) { $pluginList[] = $plugin_info['plugin_class']::create(); } } } $this->installedPluginListObject = $pluginList; } /** * @return array */ public function get_installed_plugins() { $installedPlugins = array(); $plugins = api_get_settings_params( array( "variable = ? AND selected_value = ? AND category = ? " => array('status', 'installed', 'Plugins') ) ); if (!empty($plugins)) { foreach ($plugins as $row) { $installedPlugins[$row['subkey']] = true; } $installedPlugins = array_keys($installedPlugins); } return $installedPlugins; } /** * @param string $pluginName * @param int $urlId */ public function install($pluginName, $urlId = null) { if (empty($urlId)) { $urlId = api_get_current_access_url_id(); } else { $urlId = intval($urlId); } api_add_setting( 'installed', 'status', $pluginName, 'setting', 'Plugins', $pluginName, null, null, null, $urlId, 1 ); $pluginPath = api_get_path(SYS_PLUGIN_PATH).$pluginName.'/install.php'; if (is_file($pluginPath) && is_readable($pluginPath)) { // Execute the install procedure. require $pluginPath; } } /** * @param string $pluginName * @param int $urlId */ public function uninstall($pluginName, $urlId = null) { if (empty($urlId)) { $urlId = api_get_current_access_url_id(); } else { $urlId = intval($urlId); } // First call the custom uninstall to allow full access to global settings $pluginPath = api_get_path(SYS_PLUGIN_PATH).$pluginName.'/uninstall.php'; if (is_file($pluginPath) && is_readable($pluginPath)) { // Execute the uninstall procedure. require $pluginPath; } // Second remove all remaining global settings api_delete_settings_params( array('category = ? AND access_url = ? AND subkey = ? ' => array('Plugins', $urlId, $pluginName)) ); } /** * @param string $pluginName * * @return array */ public function get_areas_by_plugin($pluginName) { $result = api_get_settings('Plugins'); $areas = array(); foreach ($result as $row) { if ($pluginName == $row['selected_value']) { $areas[] = $row['variable']; } } return $areas; } /** * @param string $location * * @return bool */ public function is_valid_plugin_location($location) { return in_array($location, $this->plugin_list); } /** * @param string $pluginName * * @return bool */ public function is_valid_plugin($pluginName) { if (is_dir(api_get_path(SYS_PLUGIN_PATH).$pluginName)) { if (is_file(api_get_path(SYS_PLUGIN_PATH).$pluginName.'/index.php')) { return true; } } return false; } /** * @return array */ public function get_plugin_regions() { sort($this->plugin_regions); return $this->plugin_regions; } /** * @param string $region * @param string $template * @param bool $forced * * @return null|string */ public function load_region($region, $template, $forced = false) { if ($region == 'course_tool_plugin') { return null; } ob_start(); $this->get_all_plugin_contents_by_region($region, $template, $forced); $content = ob_get_contents(); ob_end_clean(); return $content; } /** * Loads the translation files inside a plugin if exists. It loads by default english see the hello world plugin * * @param string $plugin_name * * @todo add caching */ public function load_plugin_lang_variables($plugin_name) { global $language_interface; $root = api_get_path(SYS_PLUGIN_PATH); // 1. Loading english if exists $english_path = $root.$plugin_name."/lang/english.php"; if (is_readable($english_path)) { include $english_path; foreach ($strings as $key => $string) { $GLOBALS[$key] = $string; } } // 2. Loading the system language if ($language_interface != 'english') { $path = $root.$plugin_name."/lang/$language_interface.php"; if (is_readable($path)) { include $path; if (!empty($strings)) { foreach ($strings as $key => $string) { $GLOBALS[$key] = $string; } } } } } /** * @param string $region * @param Template $template * @param bool $forced * * @return bool * * @todo improve this function */ public function get_all_plugin_contents_by_region($region, $template, $forced = false) { global $_plugins; if (isset($_plugins[$region]) && is_array($_plugins[$region])) { //if (1) { //Load the plugin information foreach ($_plugins[$region] as $plugin_name) { //The plugin_info variable is available inside the plugin index $plugin_info = $this->getPluginInfo($plugin_name, $forced); //We also know where the plugin is $plugin_info['current_region'] = $region; // Loading the plugin/XXX/index.php file $plugin_file = api_get_path(SYS_PLUGIN_PATH)."$plugin_name/index.php"; if (file_exists($plugin_file)) { //Loading the lang variables of the plugin if exists self::load_plugin_lang_variables($plugin_name); //Printing the plugin index.php file require $plugin_file; //If the variable $_template is set we assign those values to be accesible in Twig if (isset($_template)) { $_template['plugin_info'] = $plugin_info; } else { $_template = array(); $_template['plugin_info'] = $plugin_info; } //Setting the plugin info available in the template if exists $template->assign($plugin_name, $_template); //Loading the Twig template plugin files if exists $template_list = array(); if (isset($plugin_info) && isset($plugin_info['templates'])) { $template_list = $plugin_info['templates']; } if (!empty($template_list)) { foreach ($template_list as $plugin_tpl) { if (!empty($plugin_tpl)) { //$template_plugin_file = api_get_path(SYS_PLUGIN_PATH)."$plugin_name/$plugin_tpl"; //for smarty $template_plugin_file = "$plugin_name/$plugin_tpl"; // for twig $template->display($template_plugin_file); } } } } } } return true; } /** * @param string $plugin_name * @param bool $forced * * @deprecated */ public function get_plugin_info($plugin_name, $forced = false) { return $this->getPluginInfo($plugin_name, $forced); } /** * Loads plugin info * * @staticvar array $plugin_data * @param string $plugin_name * @param bool $forced load from DB or from the static array * * @return array * @todo filter setting_form */ public function getPluginInfo($plugin_name, $forced = false) { static $plugin_data = array(); if (isset($plugin_data[$plugin_name]) && $forced == false) { return $plugin_data[$plugin_name]; } else { $plugin_file = api_get_path(SYS_PLUGIN_PATH)."$plugin_name/plugin.php"; $plugin_info = array(); if (file_exists($plugin_file)) { require $plugin_file; } //extra options $plugin_settings = api_get_settings_params( array( "subkey = ? AND category = ? AND type = ? " => array($plugin_name, 'Plugins','setting') ) ); $settings_filtered = array(); foreach ($plugin_settings as $item) { $settings_filtered[$item['variable']] = $item['selected_value']; } $plugin_info['settings'] = $settings_filtered; $plugin_data[$plugin_name] = $plugin_info; return $plugin_info; } } /** * Get the template list * @param string $pluginName * @return bool */ public function get_templates_list($pluginName) { $plugin_info = $this->getPluginInfo($pluginName); if (isset($plugin_info) && isset($plugin_info['templates'])) { return $plugin_info['templates']; } else { return false; } } /** * Remove all regions of an specific plugin */ public function remove_all_regions($plugin) { $access_url_id = api_get_current_access_url_id(); if (!empty($plugin)) { api_delete_settings_params( array( 'category = ? AND type = ? AND access_url = ? AND subkey = ? ' => array('Plugins', 'region', $access_url_id, $plugin) ) ); } } /** * Add a plugin to a region * @param string $plugin * @param string $region */ public function add_to_region($plugin, $region) { $access_url_id = api_get_current_access_url_id(); api_add_setting($plugin, $region, $plugin, 'region', 'Plugins', $plugin, null, null, null, $access_url_id, 1); } /** * @param int $courseId */ public function install_course_plugins($courseId) { $pluginList = $this->getInstalledPluginListObject(); if (!empty($pluginList)) { /** @var Plugin $obj */ foreach ($pluginList as $obj) { $pluginName = $obj->get_name(); $plugin_path = api_get_path(SYS_PLUGIN_PATH).$pluginName.'/plugin.php'; if (file_exists($plugin_path)) { require $plugin_path; if (isset($plugin_info) && isset($plugin_info['plugin_class']) && $obj->isCoursePlugin) { $obj->course_install($courseId); } } } } } /** * @param FormValidator $form */ public function add_course_settings_form($form) { $pluginList = $this->getInstalledPluginListObject(); /** @var Plugin $obj */ foreach ($pluginList as $obj) { $plugin_name = $obj->get_name(); $pluginTitle = $obj->get_title(); if (!empty($obj->course_settings)) { if (is_file(api_get_path(SYS_CODE_PATH).'img/icons/'.ICON_SIZE_SMALL.'/'.$plugin_name.'.png')) { $icon = Display::return_icon( $plugin_name . '.png', Security::remove_XSS($pluginTitle), '', ICON_SIZE_SMALL ); } else { $icon = Display::return_icon( 'plugins.png', Security::remove_XSS($pluginTitle), '', ICON_SIZE_SMALL ); } //$icon = null; $form->addElement('html', '