class.t3lib_foldertree.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2004 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project 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.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script 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.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
require_once (PATH_t3lib.'class.t3lib_treeview.php');














class t3lib_folderTree extends t3lib_treeView  {

   function t3lib_folderTree()   {
      parent::init();

      $this->MOUNTS = $GLOBALS['FILEMOUNTS'];

      $this->treeName='folder';
      $this->titleAttrib=''; //don't apply any title
      $this->domIdPrefix = 'folder';
   }

   function wrapIcon($icon,$row) {
         // Add title attribute to input icon tag
      $theFolderIcon = $this->addTagAttributes($icon,($this->titleAttrib ? $this->titleAttrib.'="'.$this->getTitleAttrib($row).'"' : ''));

         // Wrap icon in click-menu link.
      if (!$this->ext_IconMode)  {
         $theFolderIcon = $GLOBALS['TBE_TEMPLATE']->wrapClickMenuOnIcon($theFolderIcon,$row['path'],'',0);
      } elseif (!strcmp($this->ext_IconMode,'titlelink'))   {
         $aOnClick = 'return jumpTo(\''.$this->getJumpToParam($row).'\',this,\''.$this->domIdPrefix.$this->getId($row).'_'.$this->bank.'\');';
         $theFolderIcon='<a href="#" onclick="'.htmlspecialchars($aOnClick).'">'.$theFolderIcon.'</a>';
      }
      return $theFolderIcon;
   }

   function getId($v) {
      return t3lib_div::md5Int($v['path']);
   }

   function getJumpToParam($v) {
      return rawurlencode($v['path']);
   }

   function getTitleStr($row,$titleLen=30)   {
      return $row['_title'] ? $row['_title'] : parent::getTitleStr($row,$titleLen);
   }

   function getBrowsableTree()   {

         // Get stored tree structure AND updating it if needed according to incoming PM GET var.
      $this->initializePositionSaving();

         // Init done:
      $titleLen=intval($this->BE_USER->uc['titleLen']);
      $treeArr=array();

         // Traverse mounts:
      foreach($this->MOUNTS as $key => $val) {
         $md5_uid = md5($val['path']);
         $specUID=hexdec(substr($md5_uid,0,6));
         $this->specUIDmap[$specUID]=$val['path'];

            // Set first:
         $this->bank=$val['nkey'];
         $isOpen = $this->stored[$val['nkey']][$specUID] || $this->expandFirst;
         $this->reset();

            // Set PM icon:
         $cmd=$this->bank.'_'.($isOpen?'0_':'1_').$specUID.'_'.$this->treeName;
         $icon='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/'.($isOpen?'minus':'plus').'only.gif','width="18" height="16"').' alt="" />';
         $firstHtml= $this->PM_ATagWrap($icon,$cmd);

         switch($val['type']) {
            case 'user':   $icon = 'gfx/i/_icon_ftp_user.gif'; break;
            case 'group':  $icon = 'gfx/i/_icon_ftp_group.gif'; break;
            default:    $icon = 'gfx/i/_icon_ftp.gif'; break;
         }

            // Preparing rootRec for the mount
         $firstHtml.=$this->wrapIcon('<img'.t3lib_iconWorks::skinImg($this->backPath,$icon,'width="18" height="16"').' alt="" />',$val);
            $row=array();
            $row['path']=$val['path'];
            $row['uid']=$specUID;
            $row['title']=$val['name'];

            // Add the root of the mount to ->tree
         $this->tree[]=array('HTML'=>$firstHtml,'row'=>$row,'bank'=>$this->bank);

            // If the mount is expanded, go down:
         if ($isOpen)   {
               // Set depth:
            $depthD='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/blank.gif','width="18" height="16"').' alt="" />';
            $this->getFolderTree($val['path'],999,$depthD);
         }

            // Add tree:
         $treeArr=array_merge($treeArr,$this->tree);
      }
      return $this->printTree($treeArr);
   }

   function getFolderTree($files_path, $depth=999, $depthData='') {

         // This generates the directory tree
      $dirs = t3lib_div::get_dirs($files_path);

      $c=0;
      if (is_array($dirs)) {
         $depth=intval($depth);
         $HTML='';
         $a=0;
         $c=count($dirs);
         sort($dirs);

         foreach($dirs as $key => $val)   {
            $a++;
            $this->tree[]=array();     // Reserve space.
            end($this->tree);
            $treeKey = key($this->tree);  // Get the key for this space
            $LN = ($a==$c)?'blank':'line';

            $val = ereg_replace('^\./','',$val);
            $title = $val;
            $path = $files_path.$val.'/';
            $webpath=t3lib_BEfunc::getPathType_web_nonweb($path);

            $md5_uid = md5($path);
            $specUID=hexdec(substr($md5_uid,0,6));
            $this->specUIDmap[$specUID]=$path;
            $row=array();
            $row['path']=$path;
            $row['uid']=$specUID;
            $row['title']=$title;

            if ($depth>1 && $this->expandNext($specUID)) {
               $nextCount=$this->getFolderTree(
                  $path,
                  $depth-1,
                  $this->makeHTML ? $depthData.'<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/'.$LN.'.gif','width="18" height="16"').' alt="" />' : ''
               );
               $exp=1;     // Set "did expand" flag
            } else {
               $nextCount=$this->getCount($path);
               $exp=0;     // Clear "did expand" flag
            }

               // Set HTML-icons, if any:
            if ($this->makeHTML) {
               $HTML=$depthData.$this->PMicon($row,$a,$c,$nextCount,$exp);

               $icon = 'gfx/i/_icon_'.$webpath.'folders.gif';
               if ($val=='_temp_')  {
                  $icon = 'gfx/i/sysf.gif';
                  $row['title']='TEMP';
                  $row['_title']='<b>TEMP</b>';
               }
               if ($val=='_recycler_') {
                  $icon = 'gfx/i/recycler.gif';
                  $row['title']='RECYCLER';
                  $row['_title']='<b>RECYCLER</b>';
               }
               $HTML.=$this->wrapIcon('<img'.t3lib_iconWorks::skinImg($this->backPath,$icon,'width="18" height="16"').' alt="" />',$row);
            }

               // Finally, add the row/HTML content to the ->tree array in the reserved key.
            $this->tree[$treeKey] = Array(
               'row'=>$row,
               'HTML'=>$HTML,
               'bank'=>$this->bank
            );
         }
      }
      return $c;
   }

   function getCount($files_path)   {
         // This generates the directory tree
      $dirs = t3lib_div::get_dirs($files_path);
      $c=0;
      if (is_array($dirs)) {
         $c=count($dirs);
      }
      return $c;
   }

   function initializePositionSaving() {
         // Get stored tree structure:
      $this->stored=unserialize($this->BE_USER->uc['browseTrees'][$this->treeName]);

         // Mapping md5-hash to shorter number:
      $hashMap=array();
      foreach($this->MOUNTS as $key => $val) {
         $nkey = hexdec(substr($key,0,4));
         $hashMap[$nkey]=$key;
         $this->MOUNTS[$key]['nkey']=$nkey;
      }

         // PM action:
         // (If an plus/minus icon has been clicked, the PM GET var is sent and we must update the stored positions in the tree):
      $PM = explode('_',t3lib_div::_GP('PM'));  // 0: mount key, 1: set/clear boolean, 2: item ID (cannot contain "_"), 3: treeName
      if (count($PM)==4 && $PM[3]==$this->treeName)   {
         if (isset($this->MOUNTS[$hashMap[$PM[0]]]))  {
            if ($PM[1]) {  // set
               $this->stored[$PM[0]][$PM[2]]=1;
               $this->savePosition($this->treeName);
            } else { // clear
               unset($this->stored[$PM[0]][$PM[2]]);
               $this->savePosition($this->treeName);
            }
         }
      }
   }
}

if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_foldertree.php']) {
   include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_foldertree.php']);
}
?>

---