classes/class.ilFileExplorer.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2001 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. |
        +-----------------------------------------------------------------------------+
*/


class ilFileExplorer
{
        var $ilias;

        var $output;

        var $format_options;

        var $directory;

        var $target;

        var $target_get;

        var $params_get;

        var $expanded;

        var $order_column;

        var $expand_target;

        var $output_icons;

        function ilFileExplorer($a_directory, $a_target)
        {
                global $ilias;

                if (!isset($a_target) or !is_string($a_target))
                {
                        $this->ilias->raiseError(get_class($this)."::Constructor(): No target given!",$this->ilias->error_obj->WARNING);
                }

                if (!isset($a_directory) or !is_string($a_directory))
                {
                        $this->ilias->raiseError(get_class($this)."::Constructor(): No directory given!",$this->ilias->error_obj->WARNING);
                }

                $this->ilias =& $ilias;
                $this->directory = $a_directory;
                $this->output = array();
                $this->expanded = array();
                $this->target = $a_target;
                $this->target_get = 'ref_id';
                $this->frame_target = "_top";
                $this->order_column = "title";
                $this->expand_target = $_SERVER["PATH_INFO"];
                $this->rbac_check = true;
                $this->output_icons = true;
        }

        function setOrderColumn($a_column)
        {
                $this->order_column = $a_column;
        }

        function setTargetGet($a_target_get)
        {
                if (!isset($a_target_get) or !is_string($a_target_get))
                {
                        $this->ilias->raiseError(get_class($this)."::setTargetGet(): No target given!",$this->ilias->error_obj->WARNING);
                }

                $this->target_get = $a_target_get;
        }

        function setParamsGet($a_params_get)
        {
                if (!isset($a_params_get) or !is_array($a_params_get))
                {
                        $this->ilias->raiseError(get_class($this)."::setTargetGet(): No target given!",$this->ilias->error_obj->WARNING);
                }

                foreach ($a_params_get as $key => $val)
                {
                        $str .= "&".$key."=".$val;
                }

                $this->params_get = $str;
        }


        function setExpandTarget($a_exp_target)
        {
                $this->expand_target = $a_exp_target;
        }

        function checkPermissions($a_check)
        {
                $this->rbac_check = $a_check;
        }

        function outputIcons($a_icons)
        {
                $this->output_icons = $a_icons;
        }


        function setOutput($a_parent_dir, $a_depth = 1)
        {
                static $counter = 0;

                if (!isset($a_parent_id))
                {
                        $this->ilias->raiseError(get_class($this)."::setOutput(): No node_id given!",$this->ilias->error_obj->WARNING);
                }
                $files = $this->getFiles($a_parent_dir, $this->order_column);
                if (count($files) > 0)
                {
                        $tab = ++$a_depth - 2;
                        foreach ($objects as $key => $object)
                        {
                                //ask for FILTER
                                if ($this->filtered == false || $this->checkFilter($object["type"])==true)
                                {
                                        if ($object["child"] != $this->tree->getRootId())
                                        {
                                                $parent_index = $this->getIndex($object);
                                        }
                                        $this->format_options["$counter"]["parent"]             = $object["parent"];
                                        $this->format_options["$counter"]["child"]              = $object["child"];
                                        $this->format_options["$counter"]["title"]              = $object["title"];
                                        $this->format_options["$counter"]["type"]               = $object["type"];
                                        $this->format_options["$counter"]["desc"]               = "obj_".$object["type"];
                                        $this->format_options["$counter"]["depth"]              = $tab;
                                        $this->format_options["$counter"]["container"]  = false;
                                        $this->format_options["$counter"]["visible"]    = true;

                                        // Create prefix array
                                        for ($i = 0; $i < $tab; ++$i)
                                        {
                                                $this->format_options["$counter"]["tab"][] = 'blank';
                                        }

                                        // only if parent is expanded and visible, object is visible
                                        if ($object["child"] != $this->tree->getRootId() and (!in_array($object["parent"],$this->expanded)
                                        or !$this->format_options["$parent_index"]["visible"]))
                                        {
                                                $this->format_options["$counter"]["visible"] = false;
                                        }

                                        // if object exists parent is container
                                        if ($object["child"] != $this->tree->getRootId())
                                        {
                                                $this->format_options["$parent_index"]["container"] = true;

                                                if (in_array($object["parent"],$this->expanded))
                                                {
                                                        $this->format_options["$parent_index"]["tab"][($tab-2)] = 'minus';
                                                }
                                                else
                                                {
                                                        $this->format_options["$parent_index"]["tab"][($tab-2)] = 'plus';
                                                }
                                        }

                                        ++$counter;

                                        // Recursive
                                        $this->setOutput($object["child"],$a_depth);
                                } //if FILTER
                        } //foreach
                } //if
        } //function


        function getFiles($a_parent_dir, $a_order)
        {
                $files = array();
                $handle = opendir($a_parent_dir);
                while (false !== ($file = readdir($handle)))
                {
                if (!is_dir($file))
                        {
                                $files[] = array("type" => "file", "name" => $file);
                        }
                        else
                        {
                                $files[] = array("type" => "dir", "name" => $file);
                        }
        }
                return $files;
        }

        function getOutput()
        {
                $this->format_options[0]["tab"] = array();

                /* ???
                $depth = $this->tree->getMaximumDepth();

                for ($i=0;$i<$depth;++$i)
                {
                        $this->createLines($i);
                }*/

                foreach ($this->format_options as $key => $options)
                {
                        if ($options["visible"] and $key != 0)
                        {
                                $this->formatObject($options["child"],$options);
                        }
                        if ($key == 0)
                        {
                                $this->formatHeader($options["child"],$options);
                        }
                }

                return implode('',$this->output);
        }

        function formatHeader($a_obj_id,$a_option)
        {
        }

        function formatObject($a_node_id,$a_option)
        {
                global $lng;

                if (!isset($a_node_id) or !is_array($a_option))
                {
                        $this->ilias->raiseError(get_class($this)."::formatObject(): Missing parameter or wrong datatype! ".
                                                                        "node_id: ".$a_node_id." options:".var_dump($a_option),$this->ilias->error_obj->WARNING);
                }

                $tpl = new ilTemplate("tpl.tree.html", true, true);

                foreach ($a_option["tab"] as $picture)
                {
                        if ($picture == 'plus')
                        {
                                $target = $this->createTarget('+',$a_node_id);
                                $tpl->setCurrentBlock("expander");
                                $tpl->setVariable("LINK_TARGET", $target);
                                $tpl->setVariable("IMGPATH", ilUtil::getImagePath("browser/plus.gif"));
                                $tpl->parseCurrentBlock();
                        }

                        if ($picture == 'minus')
                        {
                                $target = $this->createTarget('-',$a_node_id);
                                $tpl->setCurrentBlock("expander");
                                $tpl->setVariable("LINK_TARGET", $target);
                                $tpl->setVariable("IMGPATH", ilUtil::getImagePath("browser/minus.gif"));
                                $tpl->parseCurrentBlock();
                        }

                        if ($picture == 'blank' or $picture == 'winkel'
                           or $picture == 'hoch' or $picture == 'quer' or $picture == 'ecke')
                        {
                                $tpl->setCurrentBlock("expander");
                                $tpl->setVariable("IMGPATH", ilUtil::getImagePath("browser/".$picture.".gif"));
                                $tpl->setVariable("TXT_ALT_IMG", $lng->txt($a_option["desc"]));
                                $tpl->parseCurrentBlock();
                        }
                }

                if ($this->output_icons)
                {
                        $tpl->setCurrentBlock("icon");
                        $tpl->setVariable("ICON_IMAGE" ,ilUtil::getImagePath("icon_".$a_option["type"].".gif"));
                        $tpl->setVariable("TXT_ALT_IMG", $lng->txt($a_option["desc"]));
                        $tpl->parseCurrentBlock();
                }
                $tpl->setCurrentBlock("row");
                $target = (strpos($this->target, "?") === false) ?
                        $this->target."?" : $this->target."&";
                $tpl->setVariable("LINK_TARGET", $target.$this->target_get."=".$a_node_id.$this->params_get);
                $tpl->setVariable("TITLE", $a_option["title"]);

                if ($this->frame_target != "")
                {
                        $tpl->setVariable("TARGET", " target=\"".$this->frame_target."\"");
                }

                $tpl->parseCurrentBlock();

                $this->output[] = $tpl->get();
        }

        function createTarget($a_type,$a_node_id)
        {
                if (!isset($a_type) or !is_string($a_type) or !isset($a_node_id))
                {
                        $this->ilias->raiseError(get_class($this)."::createTarget(): Missing parameter or wrong datatype! ".
                                                                        "type: ".$a_type." node_id:".$a_node_id,$this->ilias->error_obj->WARNING);
                }

                // SET expand parameter:
                //     positive if object is expanded
                //     negative if object is compressed
                $a_node_id = $a_type == '+' ? $a_node_id : -(int) $a_node_id;

                $sep = (is_int(strpos($this->expand_target, "?")))
                        ? "&"
                        : "?";
                return $this->expand_target.$sep."expand=".$a_node_id.$this->params_get;
        }

        function setFrameTarget($a_target)
        {
                $this->frame_target = $a_target;
        }

        function createLines($a_depth)
        {
                for ($i = 0; $i < count($this->format_options); ++$i)
                {
                        if ($this->format_options[$i]["depth"] == $a_depth+1
                           and !$this->format_options[$i]["container"]
                                and $this->format_options[$i]["depth"] != 1)
                        {
                                $this->format_options[$i]["tab"]["$a_depth"] = "quer";
                        }

                        if ($this->format_options[$i]["depth"] == $a_depth+2)
                        {
                                if ($this->is_in_array($i+1,$this->format_options[$i]["depth"]))
                                {
                                        $this->format_options[$i]["tab"]["$a_depth"] = "winkel";
                                }
                                else
                                {
                                        $this->format_options[$i]["tab"]["$a_depth"] = "ecke";
                                }
                        }

                        if ($this->format_options[$i]["depth"] > $a_depth+2)
                        {
                                if ($this->is_in_array($i+1,$a_depth+2))
                                {
                                        $this->format_options[$i]["tab"]["$a_depth"] = "hoch";
                                }
                        }
                }
        }

        function is_in_array($a_start,$a_depth)
        {
                for ($i=$a_start;$i<count($this->format_options);++$i)
                {
                        if ($this->format_options[$i]["depth"] < $a_depth)
                        {
                                break;
                        }

                        if ($this->format_options[$i]["depth"] == $a_depth)
                        {
                                return true;
                        }
                }
                return false;
        }

        function getIndex($a_data)
        {
                foreach ($this->format_options as $key => $value)
                {
                        if (($value["child"] == $a_data["parent"]))
                        {
                                return $key;
                        }
                }

                // exit on error
                $this->ilias->raiseError(get_class($this)."::getIndex(): Error in tree. No index found!",$this->ilias->error_obj->FATAL);
        }

        function addFilter($a_item)
        {
                $ispresent = 0;
                
                if (is_array($this->filter))
                {
                        //run through filter
                    foreach ($this->filter as $item)
                        {
                                if ($item == $a_item)
                                {
                                    $is_present = 1;

                                        return false;
                                }
                        }
                }
                else
                {
                        $this->filter = array();
                }
                
                if ($is_present == 0)
                {
                        $this->filter[] = $a_item;

                }

                return true;
        }
        
        function delFilter($a_item)
        {
                //check if a filter exists
                if (is_array($this->filter))
                {
                        //build copy of the existing filter without the given item
                        $tmp = array();

                        foreach ($this->filter as $item)
                    {
                                if ($item != $a_item)
                                {
                                    $tmp[] = $item;
                                }
                                else
                                {
                                        $deleted = 1;
                                }
                        }
                        $this->filter = $tmp;
                }
                else
                {
                        return false;
                }

                if ($deleted == 1)
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

        function setExpand($a_node_id)
        {
                // IF ISN'T SET CREATE SESSION VARIABLE
                if(!is_array($_SESSION["expand"]))
                {
                        $_SESSION["expand"] = array($this->tree->getRootId());
                }
                // IF $_GET["expand"] is positive => expand this node
                if ($a_node_id > 0 && !in_array($a_node_id,$_SESSION["expand"]))
                {
                        array_push($_SESSION["expand"],$a_node_id);
                }
                // IF $_GET["expand"] is negative => compress this node
                if ($a_node_id < 0)
                {
                        $key = array_keys($_SESSION["expand"],-(int) $a_node_id);
                        unset($_SESSION["expand"][$key[0]]);
                }
                $this->expanded = $_SESSION["expand"];
        }

        function setFiltered($a_bool)
        {
                $this->filtered = $a_bool;
                return true;
        }

        function checkFilter($a_item)
        {
                if (is_array($this->filter))
                {
                        return in_array($a_item, $this->filter);
                }
                else
                {
                        return false;
                }
        }
} // END class.ilExplorer
?>