class.ilParagraphPlugins.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

include_once("./classes/class.ilDOMXML.php");
include_once("./Services/COPage/classes/class.ilParagraphPlugin.php");

class ilParagraphPlugins {
        var $plugins;

        var $pluginDirectory;
        var $skipDirectories;

        function ilParagraphPlugins () {
                $this->plugins = array();
                $this->pluginDirectory = ILIAS_ABSOLUTE_PATH."/Services/COPage/plugins";
                $this->skipDirectories = array ();
                $this->skipDirectories [$this->pluginDirectory."/classes"] = "skip";
                $this->skipDirectories [$this->pluginDirectory."/resources"]= "skip";
                $this->skipDirectories [$this->pluginDirectory."/CVS"]= "skip";
        }

        function getRegisteredPluginsAsArray () {
                return $this->plugins;
        }


        function getParagraphPlugin ($pluginDir) {
            foreach ($this->plugins as $plugin) {
                if (strcasecmp($pluginDir, $plugin->getDirectory()) == 0)
                   return $plugin;
            }
            return null;
        }

        function registerPlugin ($plugin) {
                //echo "registered Plugin ".$plugin->getTitle();
                $this->plugins[$plugin->serializeToString()] = $plugin;
        }


        function isRegistered ($pluginClassname) {
            foreach ($this->plugins as $plugin) {
                if (strcasecmp(get_class($plugin), $pluginClassname) == 0)
                   return true;
            }
            return false;
        }
        function serializeToString (){
                return implode ("|", array_keys($this->plugins));
        }

        function initialize () {
                if (file_exists($this->pluginDirectory))
                {
                    $pluginDirs = glob($this->pluginDirectory."/*",GLOB_ONLYDIR);
                    if (is_array($pluginDirs))
                    {
                        foreach ($pluginDirs as $pluginDir) {
                            // if there is no plugin xml file, or we are in a skipping directory then continue loop
                                if (array_key_exists($pluginDir,$this->skipDirectories) || !file_exists($pluginDir."/plugin.xml")) {
                                        continue;
                                }


                                // load plugin xml, to retrieve plugin node (see dtd)
                                $pluginDOM = new ilDOMXML();
                                $pluginDOM->loadDocument("plugin.xml", $pluginDir, false);
                                $pluginNodes = $pluginDOM->getElementsByTagname("plugin");

                                if ( count ($pluginNodes)>0 )
                                {
                                    // found plugin node
                                    $pluginNode = $pluginNodes[0];
                                    //print_r($pluginNode) ;
                                        //this is the subdirectory of the plugin
                                    $pluginSubDir = str_replace($this->pluginDirectory."/","",$pluginDir);

                                        // class file containing class which inherits from paragraph plugin
                                    $classfile = $pluginNode->get_attribute ("classfile");
                                    // according classname
                                        $classname = $pluginNode->get_attribute ("classname");

                                        // filter filetype, refers to sourcecode directory, hfile, e.g. java122 affects, that this plugin is for this paragraph type only
                                        $filetype  = $pluginNode->get_attribute ("filetype");

                                        // enable/disable plugin
                                        $active    = strcasecmp($pluginNode->get_attribute ("active"),"true") == 0;

                                        // title is alt text for image
                                        $title       = $this->getTextContent($pluginNode,"title");

                                        // link
                                        $link        = $this->getTextContent($pluginNode,"link");

                                        // description, not shown at the momemnt
                                        $description = $this->getTextContent($pluginNode,"description");


                                        // prepare class file for include, must reside in classes directory
                                        $classfile = $pluginDir . "/classes/".$classfile;

                        /*            echo $classfile."<br>";
                                        echo $classname."<br>";
                                        echo $filetype."<br>";
                                        echo $active."<br>";
                                        echo $title."<br>";
                                        echo $description."<br>";*/

                                        if (file_exists($classfile) && $active && !$this->isRegistered($classname))
                                        {
                                                include_once ($classfile);
                                                $plugin = new $classname($pluginSubDir, $title, $filetype, $link, $description, $active);

                                                //print_r($plugin);

                                                if (is_a($plugin,"ilParagraphPlugin") && $plugin->isActive()) {
                                                        $this->registerPlugin($plugin);

                                                        unset ($plugin);
                                                }
                                        }

                                }
                        }
                        }
                }
        }


        function getTextContent ($a_element, $nodename) {
            $elems = $a_element -> get_elements_by_tagname ( $nodename );
            if (count ($elems) > 0)
            {
                return $elems[0]->get_content();
            }
        return "";
        }
}
?>