chamilo-lms/main/inc/lib/plugin.lib.php

<?php
/* See license terms in /license.txt */
class AppPlugin {
    var $plugin_blocks = array ( 
 //           'loginpage_main',
            'login',
            'menu', 
/*            'campushomepage_main', 
            'campushomepage_menu',
            'mycourses_main', 
            'mycourses_menu',*/
            'content_top',
            'content_bottom',
            'header_main',
            'header_center',
            'header_left',
            'header_right',            
            //'footer',
            'footer_left',
            'footer_center',
            'footer_right',
            'course_tool_plugin'
    );
    
    function __construct() {
        
    }
    
    /*  For each of the possible plugin directories we check whether a file named "plugin.php" exists
        (it contains all the needed information about this plugin).
        This "plugin.php" file looks like:
        $plugin_info['title'] = 'The title of the plugin';
        $plugin_info['comment'] = 'Some comment about the plugin';
        $plugin_info['location'] = array('loginpage_menu', 'campushomepage_menu', 'banner'); // The possible locations where the plugins can be used.
        $plugin_info['version'] = '0.1 alpha'; // The version number of the plugin.
        $plugin_info['author'] = 'Patrick Cool'; // The author of the plugin.
    */
    function read_plugins_from_path() {
        /* We scan the plugin directory. Each folder is a potential plugin. */
        $pluginpath = api_get_path(SYS_PLUGIN_PATH);
        $possible_plugins = array();
        $handle = @opendir($pluginpath);
        while (false !== ($file = readdir($handle))) {
            if ($file != '.' && $file != '..' && is_dir(api_get_path(SYS_PLUGIN_PATH).$file)) {
                $possible_plugins[] = $file;
            }
        }
        @closedir($handle);
        sort($possible_plugins);   
        return $possible_plugins;
    }
    
    
    function get_installed_plugins_by_block(){
        $usedplugins = array();
        /* We retrieve all the active plugins. */    
        $result = api_get_settings('Plugins');    
        foreach ($result as $row) {
            $usedplugins[$row['variable']][] = $row['selected_value'];
        }
        return $usedplugins;
    }
    
    function get_installed_plugins() {
        $installed_plugins = array();
        $result = api_get_settings('Plugins'); 
        if (!empty($result)) {
            foreach ($result as $row) {
                $installed_plugins[$row['selected_value']] = true;
            }
            $installed_plugins = array_keys($installed_plugins);
        }
        return $installed_plugins;
    }
    
    function get_areas_by_plugin($plugin_name) {
        $result = api_get_settings('Plugins');        
        $areas = array();
        foreach ($result as $row) {
            if ($plugin_name == $row['selected_value']) {
                $areas[] = $row['variable'];
            }
        }
        return $areas;
    }
    
    function is_valid_plugin_location($location) {
        return in_array($location, $this->plugin_list);
    }
    
    function is_valid_plugin($plugin_name) {
        if (is_dir(api_get_path(SYS_PLUGIN_PATH).$plugin_name)) {
            if (is_file(api_get_path(SYS_PLUGIN_PATH).$plugin_name.'/index.php')) {
                return true;
            }
        }
        return false;
    }
    
    function get_plugin_blocks() {
        sort($this->plugin_blocks);
        return $this->plugin_blocks;
    }
    
    function load_block($block, $main_template) {
        ob_start();		
        $this->get_all_plugin_contents_by_block($block, $main_template);		
        $block_content = ob_get_contents();
        ob_end_clean();
        return $block_content;
    }
    
    function get_all_plugin_contents_by_block($block, $main_template) {
        global $_plugins;
        if (isset($_plugins[$block]) && is_array($_plugins[$block])) {
            foreach ($_plugins[$block] as $plugin_name) {
                //Load the plugin information
                //
                //The plugin_info variable is available inside the plugin index
                $plugin_info = $this->get_plugin_info($plugin_name);
                //We also where the plugin is
                $plugin_info['current_block'] = $block;                
                
                // Loading the plugin/XXX/index.php file                
                include api_get_path(SYS_PLUGIN_PATH)."$plugin_name/index.php";
                
                //Loading the smarty template files if exists
                $template_list = array();
                if (isset($plugin_info) && isset($plugin_info['templates'])) {
                    $template_list =  $plugin_info['templates'];
                }
                
                //We set the $template variable in order to use smarty
                if (isset($_template) && !empty($_template)) {                    
                    foreach($_template as $key =>$value) {
                        $main_template->assign($key, $value);  
                    }                    
                }
                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";
                            $main_template->display($template_plugin_file);                                                
                        }
                    }                
                }               
            }
        }
        return false;
    }
    
    function get_plugin_info($plugin_name) {
        static $plugin_data = array();
        if (isset($plugin_data[$plugin_name])) {
            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;            
            }
            $plugin_data[$plugin_name] = $plugin_info;
            return $plugin_data;
        }
    }
    
    function get_templates_list($plugin_name) {
        $plugin_info = $this->get_plugin_info($plugin_name);        
        if (isset($plugin_info) && isset($plugin_info['templates'])) {
            return $plugin_info['templates'];
        } else {
            return false;
        }
    }
}