class.browse_links.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2008 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!
***************************************************************/
/**
 * Displays the page/file tree for browsing database records or files.
 * Used from TCEFORMS an other elements
 * In other words: This is the ELEMENT BROWSER!
 *
 * $Id: class.browse_links.php 4450 2008-11-11 19:42:32Z stan $
 * Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj
 * XHTML compliant
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 */
/**
 * [CLASS/FUNCTION INDEX of SCRIPT]
 *
 *
 *
 *  155: class TBE_browser_recordList extends localRecordList
 *  163:     function TBE_browser_recordList ()
 *  175:     function listURL($altId='',$table=-1,$exclList='')
 *  194:     function ext_addP()
 *  211:     function linkWrapItems($table,$uid,$code,$row)
 *  244:     function linkWrapTable($table,$code)
 *
 *
 *  261: class localPageTree extends t3lib_browseTree
 *  268:     function localPageTree()
 *  284:     function wrapTitle($title,$v,$ext_pArrPages='')
 *  299:     function printTree($treeArr='')
 *  350:     function ext_isLinkable($doktype,$uid)
 *  364:     function PM_ATagWrap($icon,$cmd,$bMark='')
 *  381:     function wrapIcon($icon,$row)
 *
 *
 *  400: class rtePageTree extends localPageTree
 *
 *
 *  417: class TBE_PageTree extends localPageTree
 *  426:     function ext_isLinkable($doktype,$uid)
 *  438:     function wrapTitle($title,$v,$ext_pArrPages)
 *
 *
 *  464: class localFolderTree extends t3lib_folderTree
 *  473:     function localFolderTree()
 *  485:     function wrapTitle($title,$v)
 *  500:     function ext_isLinkable($v)
 *  517:     function PM_ATagWrap($icon,$cmd,$bMark='')
 *  532:     function printTree($treeArr='')
 *
 *
 *  599: class rteFolderTree extends localFolderTree
 *
 *
 *  615: class TBE_FolderTree extends localFolderTree
 *  624:     function ext_isLinkable($v)
 *  637:     function wrapTitle($title,$v)
 *
 *
 *  658: class browse_links
 *  764:     function init()
 * 1034:     function processSessionData($data)
 *
 *              SECTION: Main functions
 * 1077:     function main_rte($wiz=0)
 * 1379:     function main_db()
 * 1424:     function main_file()
 *
 *              SECTION: Record listing
 * 1534:     function expandPage()
 * 1615:     function TBE_expandPage($tables)
 *
 *              SECTION: File listing
 * 1708:     function expandFolder($expandFolder=0,$extensionList='')
 * 1778:     function TBE_expandFolder($expandFolder=0,$extensionList='',$noThumbs=0)
 * 1801:     function fileList($files, $folderName='', $noThumbs=0)
 * 1918:     function TBE_dragNDrop($expandFolder=0,$extensionList='')
 *
 *              SECTION: Miscellaneous functions
 * 2046:     function isWebFolder($folder)
 * 2057:     function checkFolder($folder)
 * 2070:     function barheader($str)
 * 2087:     function getMsgBox($in_msg,$icon='icon_note')
 * 2111:     function printCurrentUrl($str)
 * 2131:     function parseCurUrl($href,$siteUrl)
 * 2193:     function uploadForm($path)
 * 2247:     function createFolder($path)
 *
 * TOTAL FUNCTIONS: 39
 * (This index is automatically created/updated by the extension "extdeveval")
 *
 */

require_once (PATH_t3lib.'class.t3lib_browsetree.php');
require_once (PATH_t3lib.'class.t3lib_foldertree.php');
require_once (PATH_t3lib.'class.t3lib_stdgraphic.php');
require_once (PATH_t3lib.'class.t3lib_basicfilefunc.php');


    // Include classes
require_once (PATH_t3lib.'class.t3lib_page.php');
require_once (PATH_t3lib.'class.t3lib_recordlist.php');
require_once (PATH_typo3.'/class.db_list.inc');
require_once (PATH_typo3.'/class.db_list_extra.inc');
require_once (PATH_t3lib.'/class.t3lib_pagetree.php');



















/**
 * Local version of the record list.
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage core
 */
class TBE_browser_recordList extends localRecordList {
    var $thisScript = 'browse_links.php';

    /**
     * Initializes the script path
     *
     * @return  void
     */
    function TBE_browser_recordList () {
        $this->thisScript = t3lib_div::getIndpEnv('SCRIPT_NAME');
    }

    /**
     * Creates the URL for links
     *
     * @param   mixed       If not blank string, this is used instead of $this->id as the id value.
     * @param   string      If this is "-1" then $this->table is used, otherwise the value of the input variable.
     * @param   string      Commalist of fields NOT to pass as parameters (currently "sortField" and "sortRev")
     * @return  string      Query-string for URL
     */
    function listURL($altId='',$table=-1,$exclList='')  {
        return $this->thisScript.
            '?id='.(strcmp($altId,'')?$altId:$this->id).
            '&table='.rawurlencode($table==-1?$this->table:$table).
            ($this->thumbs?'&imagemode='.$this->thumbs:'').
            ($this->searchString?'&search_field='.rawurlencode($this->searchString):'').
            ($this->searchLevels?'&search_levels='.rawurlencode($this->searchLevels):'').
            ((!$exclList || !t3lib_div::inList($exclList,'sortField')) && $this->sortField?'&sortField='.rawurlencode($this->sortField):'').
            ((!$exclList || !t3lib_div::inList($exclList,'sortRev')) && $this->sortRev?'&sortRev='.rawurlencode($this->sortRev):'').
                // extra:
            $this->ext_addP()
            ;
    }

    /**
     * Returns additional, local GET parameters to include in the links of the record list.
     *
     * @return  string
     */
    function ext_addP() {
        $str = '&act='.$GLOBALS['SOBE']->browser->act.
                '&mode='.$GLOBALS['SOBE']->browser->mode.
                '&expandPage='.$GLOBALS['SOBE']->browser->expandPage.
                '&bparams='.rawurlencode($GLOBALS['SOBE']->browser->bparams);
        return $str;
    }

    /**
     * Returns the title (based on $code) of a record (from table $table) with the proper link around (that is for "pages"-records a link to the level of that record...)
     *
     * @param   string      Table name
     * @param   integer     UID (not used here)
     * @param   string      Title string
     * @param   array       Records array (from table name)
     * @return  string
     */
    function linkWrapItems($table,$uid,$code,$row)  {
        global $TCA, $BACK_PATH;

        if (!$code) {
            $code = '<i>['.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.no_title',1).']</i>';
        } else {
            $code = htmlspecialchars(t3lib_div::fixed_lgd_cs($code,$this->fixedL));
        }

        $title = t3lib_BEfunc::getRecordTitle($table,$row,FALSE,TRUE);
        $ficon = t3lib_iconWorks::getIcon($table,$row);
        $aOnClick = "return insertElement('".$table."', '".$row['uid']."', 'db', ".t3lib_div::quoteJSvalue($title).", '', '', '".$ficon."');";
        $ATag = '<a href="#" onclick="'.$aOnClick.'">';
        $ATag_alt = substr($ATag,0,-4).',\'\',1);">';
        $ATag_e = '</a>';

        return $ATag.
                '<img'.t3lib_iconWorks::skinImg($BACK_PATH,'gfx/plusbullet2.gif','width="18" height="16"').' title="'.$GLOBALS['LANG']->getLL('addToList',1).'" alt="" />'.
                $ATag_e.
                $ATag_alt.
                $code.
                $ATag_e;
    }

    /**
     * Local version that sets allFields to true to support userFieldSelect
     *
     * @return  void
     * @see fieldSelectBox
     */
    function generateList() {
        $this->allFields = true;
        parent::generateList();
    }
}






/**
 * Class which generates the page tree
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage core
 */
class localPageTree extends t3lib_browseTree {

    /**
     * Constructor. Just calling init()
     *
     * @return  void
     */
    function localPageTree() {
        $this->thisScript = t3lib_div::getIndpEnv('SCRIPT_NAME');

        $this->init();

        $this->clause = ' AND doktype!=255'.$this->clause;
    }

    /**
     * Wrapping the title in a link, if applicable.
     *
     * @param   string      Title, (must be ready for output, that means it must be htmlspecialchars()'ed).
     * @param   array       The record
     * @param   boolean     (Ignore)
     * @return  string      Wrapping title string.
     */
    function wrapTitle($title,$v,$ext_pArrPages='') {
        if ($this->ext_isLinkable($v['doktype'],$v['uid'])) {
            $aOnClick = "return link_typo3Page('".$v['uid']."');";
            return '<a href="#" onclick="'.htmlspecialchars($aOnClick).'">'.$title.'</a>';
        } else {
            return '<span style="color: #666666;">'.$title.'</span>';
        }
    }

    /**
     * Create the page navigation tree in HTML
     *
     * @param   array       Tree array
     * @return  string      HTML output.
     */
    function printTree($treeArr='') {
        global $BACK_PATH;
        $titleLen=intval($GLOBALS['BE_USER']->uc['titleLen']);
        if (!is_array($treeArr))    $treeArr=$this->tree;

        $out='';
        $c=0;

        foreach($treeArr as $k => $v)   {
            $c++;
            $bgColorClass = ($c+1)%2 ? 'bgColor' : 'bgColor-10';
            if ($GLOBALS['SOBE']->browser->curUrlInfo['act']=='page' && $GLOBALS['SOBE']->browser->curUrlInfo['pageid']==$v['row']['uid'] && $GLOBALS['SOBE']->browser->curUrlInfo['pageid'])   {
                $arrCol='<td><img'.t3lib_iconWorks::skinImg($BACK_PATH,'gfx/blinkarrow_right.gif','width="5" height="9"').' class="c-blinkArrowR" alt="" /></td>';
                $bgColorClass='bgColor4';
            } else {
                $arrCol='<td></td>';
            }

            $aOnClick = 'return jumpToUrl(\''.$this->thisScript.'?act='.$GLOBALS['SOBE']->browser->act.'&mode='.$GLOBALS['SOBE']->browser->mode.'&expandPage='.$v['row']['uid'].'\');';
            $cEbullet = $this->ext_isLinkable($v['row']['doktype'],$v['row']['uid']) ?
                        '<a href="#" onclick="'.htmlspecialchars($aOnClick).'"><img'.t3lib_iconWorks::skinImg($BACK_PATH,'gfx/ol/arrowbullet.gif','width="18" height="16"').' alt="" /></a>' :
                        '';
            $out.='
                <tr class="'.$bgColorClass.'">
                    <td nowrap="nowrap"'.($v['row']['_CSSCLASS'] ? ' class="'.$v['row']['_CSSCLASS'].'"' : '').'>'.
                    $v['HTML'].
                    $this->wrapTitle($this->getTitleStr($v['row'],$titleLen),$v['row'],$this->ext_pArrPages).
                    '</td>'.
                    $arrCol.
                    '<td>'.$cEbullet.'</td>
                </tr>';
        }
        $out='


            <!--
                Navigation Page Tree:
            -->
            <table border="0" cellpadding="0" cellspacing="0" id="typo3-tree">
                '.$out.'
            </table>';
        return $out;
    }

    /**
     * Returns true if a doktype can be linked.
     *
     * @param   integer     Doktype value to test
     * @param   integer     uid to test.
     * @return  boolean
     */
    function ext_isLinkable($doktype,$uid)  {
        if ($uid && $doktype<199)   {
            return true;
        }
    }

    /**
     * Wrap the plus/minus icon in a link
     *
     * @param   string      HTML string to wrap, probably an image tag.
     * @param   string      Command for 'PM' get var
     * @param   boolean     If set, the link will have a anchor point (=$bMark) and a name attribute (=$bMark)
     * @return  string      Link-wrapped input string
     */
    function PM_ATagWrap($icon,$cmd,$bMark='')  {
        if ($bMark) {
            $anchor = '#'.$bMark;
            $name=' name="'.$bMark.'"';
        }
        $aOnClick = "return jumpToUrl('".$this->thisScript.'?PM='.$cmd."','".$anchor."');";

        return '<a href="#"'.$name.' onclick="'.htmlspecialchars($aOnClick).'">'.$icon.'</a>';
    }

    /**
     * Wrapping the image tag, $icon, for the row, $row
     *
     * @param   string      The image tag for the icon
     * @param   array       The row for the current element
     * @return  string      The processed icon input value.
     */
    function wrapIcon($icon,$row)   {
        return $this->addTagAttributes($icon,' title="id='.$row['uid'].'"');
    }
}








/**
 * Page tree for the RTE - totally the same, no changes needed. (Just for the sake of beauty - or confusion... :-)
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage core
 */
class rtePageTree extends localPageTree {
}








/**
 * For TBE record browser
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage core
 */
class TBE_PageTree extends localPageTree {

    /**
     * Returns true if a doktype can be linked (which is always the case here).
     *
     * @param   integer     Doktype value to test
     * @param   integer     uid to test.
     * @return  boolean
     */
    function ext_isLinkable($doktype,$uid)  {
        return true;
    }

    /**
     * Wrapping the title in a link, if applicable.
     *
     * @param   string      Title, ready for output.
     * @param   array       The record
     * @param   boolean     If set, pages clicked will return immediately, otherwise reload page.
     * @return  string      Wrapping title string.
     */
    function wrapTitle($title,$v,$ext_pArrPages)    {
        if ($ext_pArrPages) {
            $ficon=t3lib_iconWorks::getIcon('pages',$v);
            $onClick = "return insertElement('pages', '".$v['uid']."', 'db', ".t3lib_div::quoteJSvalue($v['title']).", '', '', '".$ficon."','',1);";
        } else {
            $onClick = htmlspecialchars('return jumpToUrl(\''.$this->thisScript.'?act='.$GLOBALS['SOBE']->browser->act.'&mode='.$GLOBALS['SOBE']->browser->mode.'&expandPage='.$v['uid'].'\');');
        }
        return '<a href="#" onclick="'.$onClick.'">'.$title.'</a>';
    }
}








/**
 * Base extension class which generates the folder tree.
 * Used directly by the RTE.
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage core
 */
class localFolderTree extends t3lib_folderTree {
    var $ext_IconMode=1;


    /**
     * Initializes the script path
     *
     * @return  void
     */
    function localFolderTree() {
        $this->thisScript = t3lib_div::getIndpEnv('SCRIPT_NAME');
        $this->t3lib_folderTree();
    }

    /**
     * Wrapping the title in a link, if applicable.
     *
     * @param   string      Title, ready for output.
     * @param   array       The "record"
     * @return  string      Wrapping title string.
     */
    function wrapTitle($title,$v)   {
        if ($this->ext_isLinkable($v))  {
            $aOnClick = 'return jumpToUrl(\''.$this->thisScript.'?act='.$GLOBALS['SOBE']->browser->act.'&mode='.$GLOBALS['SOBE']->browser->mode.'&expandFolder='.rawurlencode($v['path']).'\');';
            return '<a href="#" onclick="'.htmlspecialchars($aOnClick).'">'.$title.'</a>';
        } else {
            return '<span class="typo3-dimmed">'.$title.'</span>';
        }
    }

    /**
     * Returns true if the input "record" contains a folder which can be linked.
     *
     * @param   array       Array with information about the folder element. Contains keys like title, uid, path, _title
     * @return  boolean     True is returned if the path is found in the web-part of the server and is NOT a recycler or temp folder
     */
    function ext_isLinkable($v) {
        $webpath=t3lib_BEfunc::getPathType_web_nonweb($v['path']);  // Checking, if the input path is a web-path.
        if (strstr($v['path'],'_recycler_') || strstr($v['path'],'_temp_') || $webpath!='web')  {
            return 0;
        }
        return 1;
    }

    /**
     * Wrap the plus/minus icon in a link
     *
     * @param   string      HTML string to wrap, probably an image tag.
     * @param   string      Command for 'PM' get var
     * @param   boolean     If set, the link will have a anchor point (=$bMark) and a name attribute (=$bMark)
     * @return  string      Link-wrapped input string
     * @access private
     */
    function PM_ATagWrap($icon,$cmd,$bMark='')  {
        if ($bMark) {
            $anchor = '#'.$bMark;
            $name=' name="'.$bMark.'"';
        }
        $aOnClick = 'return jumpToUrl(\''.$this->thisScript.'?PM='.$cmd.'\',\''.$anchor.'\');';
        return '<a href="#"'.$name.' onclick="'.htmlspecialchars($aOnClick).'">'.$icon.'</a>';
    }

    /**
     * Create the folder navigation tree in HTML
     *
     * @param   mixed       Input tree array. If not array, then $this->tree is used.
     * @return  string      HTML output of the tree.
     */
    function printTree($treeArr='') {
        global $BACK_PATH;
        $titleLen=intval($GLOBALS['BE_USER']->uc['titleLen']);

        if (!is_array($treeArr))    $treeArr=$this->tree;

        $out='';
        $c=0;

            // Preparing the current-path string (if found in the listing we will see a red blinking arrow).
        if (!$GLOBALS['SOBE']->browser->curUrlInfo['value'])    {
            $cmpPath='';
        } else if (substr(trim($GLOBALS['SOBE']->browser->curUrlInfo['info']),-1)!='/') {
            $cmpPath=PATH_site.dirname($GLOBALS['SOBE']->browser->curUrlInfo['info']).'/';
        } else {
            $cmpPath=PATH_site.$GLOBALS['SOBE']->browser->curUrlInfo['info'];
        }

            // Traverse rows for the tree and print them into table rows:
        foreach($treeArr as $k => $v)   {
            $c++;
            $bgColorClass=($c+1)%2 ? 'bgColor' : 'bgColor-10';

                // Creating blinking arrow, if applicable:
            if (($GLOBALS['SOBE']->browser->curUrlInfo['act'] == 'file' || $GLOBALS['SOBE']->browser->curUrlInfo['act'] == 'folder') && $cmpPath == $v['row']['path']) {
                $arrCol='<td><img'.t3lib_iconWorks::skinImg($BACK_PATH,'gfx/blinkarrow_right.gif','width="5" height="9"').' class="c-blinkArrowR" alt="" /></td>';
                $bgColorClass='bgColor4';
            } else {
                $arrCol='<td></td>';
            }
                // Create arrow-bullet for file listing (if folder path is linkable):
            $aOnClick = 'return jumpToUrl(\''.$this->thisScript.'?act='.$GLOBALS['SOBE']->browser->act.'&mode='.$GLOBALS['SOBE']->browser->mode.'&expandFolder='.rawurlencode($v['row']['path']).'\');';
            $cEbullet = $this->ext_isLinkable($v['row']) ? '<a href="#" onclick="'.htmlspecialchars($aOnClick).'"><img'.t3lib_iconWorks::skinImg($BACK_PATH,'gfx/ol/arrowbullet.gif','width="18" height="16"').' alt="" /></a>' : '';

                // Put table row with folder together:
            $out.='
                <tr class="'.$bgColorClass.'">
                    <td nowrap="nowrap">'.$v['HTML'].$this->wrapTitle(t3lib_div::fixed_lgd_cs($v['row']['title'],$titleLen),$v['row']).'</td>
                    '.$arrCol.'
                    <td>'.$cEbullet.'</td>
                </tr>';
        }

        $out='

            <!--
                Folder tree:
            -->
            <table border="0" cellpadding="0" cellspacing="0" id="typo3-tree">
                '.$out.'
            </table>';
        return $out;
    }
}






/**
 * Folder tree for the RTE - totally the same, no changes needed. (Just for the sake of beauty - or confusion... :-)
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage core
 */
class rteFolderTree extends localFolderTree {
}







/**
 * For TBE File Browser
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage core
 */
class TBE_FolderTree extends localFolderTree {
    var $ext_noTempRecyclerDirs=0;      // If file-drag mode is set, temp and recycler folders are filtered out.

    /**
     * Returns true if the input "record" contains a folder which can be linked.
     *
     * @param   array       Array with information about the folder element. Contains keys like title, uid, path, _title
     * @return  boolean     True is returned if the path is NOT a recycler or temp folder AND if ->ext_noTempRecyclerDirs is not set.
     */
    function ext_isLinkable($v) {
        if ($this->ext_noTempRecyclerDirs && (substr($v['path'],-7)=='_temp_/' || substr($v['path'],-11)=='_recycler_/'))   {
            return 0;
        } return 1;
    }

    /**
     * Wrapping the title in a link, if applicable.
     *
     * @param   string      Title, ready for output.
     * @param   array       The 'record'
     * @return  string      Wrapping title string.
     */
    function wrapTitle($title,$v)   {
        if ($this->ext_isLinkable($v))  {
            $aOnClick = 'return jumpToUrl(\''.$this->thisScript.'?act='.$GLOBALS['SOBE']->browser->act.'&mode='.$GLOBALS['SOBE']->browser->mode.'&expandFolder='.rawurlencode($v['path']).'\');';
            return '<a href="#" onclick="'.htmlspecialchars($aOnClick).'">'.$title.'</a>';
        } else {
            return '<span class="typo3-dimmed">'.$title.'</span>';
        }
    }
}





/**
 * class for the Element Browser window.
 *
 * @author  Kasper Skaarhoj <kasperYYYY@typo3.com>
 * @package TYPO3
 * @subpackage core
 */
class browse_links {

        // Internal, static:
    var $siteURL;           // Current site URL (Frontend)
    var $thisScript;        // the script to link to
    var $thisConfig;        // RTE specific TSconfig
    var $setTarget;         // Target (RTE specific)
    var $setClass;          // CSS Class (RTE specific)
    var $setTitle;              // title (RTE specific)
    var $doc;           // Backend template object
    var $elements = array();    // Holds information about files

        // GPvars:  (Input variables from outside)
    /**
     * The mode determines the main kind of output from the element browser.
     * There are these options for values: rte, db, file, filedrag, wizard.
     * "rte" will show the link selector for the Rich Text Editor (see main_rte())
     * "db" will allow you to browse for pages or records in the page tree (for TCEforms, see main_db())
     * "file"/"filedrag" will allow you to browse for files or folders in the folder mounts (for TCEforms, main_file())
     * "wizard" will allow you to browse for links (like "rte") which are passed back to TCEforms (see main_rte(1))
     *
     * @see main()
     */
    var $mode;

    /**
     * Link selector action.
     * page,file,url,mail,spec are allowed values.
     * These are only important with the link selector function and in that case they switch between the various menu options.
     */
    var $act;

    /**
     * When you click a page title/expand icon to see the content of a certain page, this value will contain that value (the ID of the expanded page). If the value is NOT set, then it will be restored from the module session data (see main(), mode="db")
     */
    var $expandPage;

    /**
     * When you click a folder name/expand icon to see the content of a certain file folder, this value will contain that value (the path of the expanded file folder). If the value is NOT set, then it will be restored from the module session data (see main(), mode="file"/"filedrag"). Example value: "/www/htdocs/typo3/32/3dsplm/fileadmin/css/"
     */
    var $expandFolder;



    /**
     * TYPO3 Element Browser, wizard mode parameters. There is a heap of parameters there, better debug() them out if you need something... :-)
     */
    var $P;

    /**
     * Active with TYPO3 Element Browser: Contains the name of the form field for which this window opens - thus allows us to make references back to the main window in which the form is.
     * Example value: "data[pages][39][bodytext]|||tt_content|" or "data[tt_content][NEW3fba56fde763d][image]|||gif,jpg,jpeg,tif,bmp,pcx,tga,png,pdf,ai|"
     *
     * Values:
     * 0: form field name reference, eg. "data[tt_content][123][image]"
     * 1: htlmArea RTE parameters: editorNo:contentTypo3Language:contentTypo3Charset
     * 2: RTE config parameters: RTEtsConfigParams
     * 3: allowed types. Eg. "tt_content" or "gif,jpg,jpeg,tif,bmp,pcx,tga,png,pdf,ai"
     * 4: IRRE uniqueness: target level object-id to perform actions/checks on, eg. "data[79][tt_address][1][<field>][<foreign_table>]"
     * 5: IRRE uniqueness: name of function in opener window that checks if element is already used, eg. "inline.checkUniqueElement"
     * 6: IRRE uniqueness: name of function in opener window that performs some additional(!) action, eg. "inline.setUniqueElement"
     * 7: IRRE uniqueness: name of function in opener window that performs action instead of using addElement/insertElement, eg. "inline.importElement"
     *
     * $pArr = explode('|',$this->bparams);
     * $formFieldName = $pArr[0];
     * $allowedTablesOrFileTypes = $pArr[3];
     */
    var $bparams;

    /**
     * Used with the Rich Text Editor.
     * Example value: "tt_content:NEW3fba58c969f5c:bodytext:23:text:23:"
     */
    var $RTEtsConfigParams;




    /**
     * Plus/Minus icon value. Used by the tree class to open/close notes on the trees.
     */
    var $PM;

    /**
     * Pointer, used when browsing a long list of records etc.
     */
    var $pointer;




    /**
     * Used with the link selector: Contains the GET input information about the CURRENT link in the RTE/TCEform field. This consists of "href", "target" and "title" keys. This information is passed around in links.
     */
    var $curUrlArray;

    /**
     * Used with the link selector: Contains a processed version of the input values from curUrlInfo. This is splitted into pageid, content element id, label value etc. This is used for the internal processing of that information.
     */
    var $curUrlInfo;

    /**
     * array which holds hook objects (initialised in init() )
     */
    protected $hookObjects = array();


    /**
     * object for t3lib_basicFileFunctions
     */
    public $fileProcessor;


    /**
     * Constructor:
     * Initializes a lot of variables, setting JavaScript functions in header etc.
     *
     * @return  void
     */
    function init() {
        global $BE_USER,$BACK_PATH;

            // Main GPvars:
        $this->pointer           = t3lib_div::_GP('pointer');
        $this->bparams           = t3lib_div::_GP('bparams');
        $this->P                 = t3lib_div::_GP('P');
        $this->RTEtsConfigParams = t3lib_div::_GP('RTEtsConfigParams');
        $this->expandPage        = t3lib_div::_GP('expandPage');
        $this->expandFolder      = t3lib_div::_GP('expandFolder');
        $this->PM                = t3lib_div::_GP('PM');

            // Find "mode"
        $this->mode = t3lib_div::_GP('mode');
        if (!$this->mode)   {
            $this->mode = 'rte';
        }
            // Creating backend template object:
        $this->doc = t3lib_div::makeInstance('template');
        $this->doc->backPath = $GLOBALS['BACK_PATH'];
            // Load the Prototype library and browse_links.js
        $this->doc->loadJavascriptLib('contrib/prototype/prototype.js');
        $this->doc->loadJavascriptLib('js/browse_links.js');

            // init hook objects:
        $this->hookObjects = array();
        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.browse_links.php']['browseLinksHook'])) {
            foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.browse_links.php']['browseLinksHook'] as $classData) {
                $processObject = &t3lib_div::getUserObj($classData);

                if(!($processObject instanceof t3lib_browseLinksHook)) {
                    throw new UnexpectedValueException('$processObject must implement interface t3lib_browseLinksHook', 1195039394);
                }

                $parameters = array();
                $processObject->init($this, $parameters);
                $this->hookObjects[] = $processObject;
            }
        }

            // Site URL
        $this->siteURL = t3lib_div::getIndpEnv('TYPO3_SITE_URL');   // Current site url

            // the script to link to
        $this->thisScript = t3lib_div::getIndpEnv('SCRIPT_NAME');

            // init fileProcessor
        $this->fileProcessor = t3lib_div::makeInstance('t3lib_basicFileFunctions');
        $this->fileProcessor->init($GLOBALS['FILEMOUNTS'], $GLOBALS['TYPO3_CONF_VARS']['BE']['fileExtensions']);


            // CurrentUrl - the current link url must be passed around if it exists
        if ($this->mode == 'wizard')    {
            $currentLinkParts = t3lib_div::trimExplode(' ',$this->P['currentValue']);
            $initialCurUrlArray = array (
                'href'   => $currentLinkParts[0],
                'target' => $currentLinkParts[1],
                'class'  => $currentLinkParts[2],
                'title'  => $currentLinkParts[3],
            );
            $this->curUrlArray = (is_array(t3lib_div::_GP('curUrl'))) ?
                array_merge($initialCurUrlArray, t3lib_div::_GP('curUrl')) :
                $initialCurUrlArray;
            $this->curUrlInfo = $this->parseCurUrl($this->siteURL.'?id='.$this->curUrlArray['href'], $this->siteURL);
            if ($this->curUrlInfo['pageid'] == 0 && $this->curUrlArray['href']) { // pageid == 0 means that this is not an internal (page) link
                if (file_exists(PATH_site.rawurldecode($this->curUrlArray['href'])))    { // check if this is a link to a file
                    if (t3lib_div::isFirstPartOfStr($this->curUrlArray['href'], PATH_site)) {
                        $currentLinkParts[0] = substr($this->curUrlArray['href'], strlen(PATH_site));
                    }
                    $this->curUrlInfo = $this->parseCurUrl($this->siteURL.$this->curUrlArray['href'], $this->siteURL);
                } elseif (strstr($this->curUrlArray['href'], '@')) { // check for email link
                    if (t3lib_div::isFirstPartOfStr($this->curUrlArray['href'], 'mailto:')) {
                        $currentLinkParts[0] = substr($this->curUrlArray['href'], 7);
                    }
                    $this->curUrlInfo = $this->parseCurUrl('mailto:'.$this->curUrlArray['href'], $this->siteURL);
                } else { // nothing of the above. this is an external link
                    if(strpos($this->curUrlArray['href'], '://') === false) {
                        $currentLinkParts[0] = 'http://' . $this->curUrlArray['href'];
                    }
                    $this->curUrlInfo = $this->parseCurUrl($currentLinkParts[0], $this->siteURL);
                }
            } elseif (!$this->curUrlArray['href']) {
                $this->curUrlInfo = array();
                $this->act = 'page';
            } else {
                $this->curUrlInfo = $this->parseCurUrl($this->siteURL.'?id='.$this->curUrlArray['href'], $this->siteURL);
            }
        } else {
            $this->curUrlArray = t3lib_div::_GP('curUrl');
            if ($this->curUrlArray['all'])  {
                $this->curUrlArray=t3lib_div::get_tag_attributes($this->curUrlArray['all']);
            }
            $this->curUrlInfo=$this->parseCurUrl($this->curUrlArray['href'],$this->siteURL);
        }

            // Determine nature of current url:
        $this->act=t3lib_div::_GP('act');
        if (!$this->act)    {
            $this->act=$this->curUrlInfo['act'];
        }

            // Rich Text Editor specific configuration:
        $addPassOnParams='';
        if ((string)$this->mode == 'rte')   {
            $RTEtsConfigParts = explode(':',$this->RTEtsConfigParams);
            $addPassOnParams.='&RTEtsConfigParams='.rawurlencode($this->RTEtsConfigParams);
            $RTEsetup = $GLOBALS['BE_USER']->getTSConfig('RTE',t3lib_BEfunc::getPagesTSconfig($RTEtsConfigParts[5]));
            $this->thisConfig = t3lib_BEfunc::RTEsetup($RTEsetup['properties'],$RTEtsConfigParts[0],$RTEtsConfigParts[2],$RTEtsConfigParts[4]);
        }

            // Initializing the target value (RTE)
        $this->setTarget = ($this->curUrlArray['target'] != '-') ? $this->curUrlArray['target'] : '';
        if ($this->thisConfig['defaultLinkTarget'] && !isset($this->curUrlArray['target'])) {
            $this->setTarget=$this->thisConfig['defaultLinkTarget'];
        }

            // Initializing the class value (RTE)
        $this->setClass = ($this->curUrlArray['class'] != '-') ? $this->curUrlArray['class'] : '';

            // Initializing the title value (RTE)
        $this->setTitle = ($this->curUrlArray['title'] != '-') ? $this->curUrlArray['title'] : '';

            // BEGIN accumulation of header JavaScript:
        $JScode = '
                // This JavaScript is primarily for RTE/Link. jumpToUrl is used in the other cases as well...
            var add_href="'.($this->curUrlArray['href']?'&curUrl[href]='.rawurlencode($this->curUrlArray['href']):'').'";
            var add_target="'.($this->setTarget?'&curUrl[target]='.rawurlencode($this->setTarget):'').'";
            var add_class="'.($this->setClass ? '&curUrl[class]='.rawurlencode($this->setClass) : '').'";
            var add_title="'.($this->setTitle?'&curUrl[title]='.rawurlencode($this->setTitle):'').'";
            var add_params="'.($this->bparams?'&bparams='.rawurlencode($this->bparams):'').'";

            var cur_href="'.($this->curUrlArray['href']?$this->curUrlArray['href']:'').'";
            var cur_target="'.($this->setTarget?$this->setTarget:'').'";
            var cur_class = "'.($this->setClass ? $this->setClass : '-').'";
            var cur_title="'.($this->setTitle?$this->setTitle:'').'";

            function browse_links_setTarget(target) {   //
                cur_target=target;
                add_target="&curUrl[target]="+escape(target);
            }
            function browse_links_setClass(cssClass) {   //
                cur_class = cssClass;
                add_class = "&curUrl[class]=" + escape(cssClass);
            }
            function browse_links_setTitle(title)   {   //
                cur_title=title;
                add_title="&curUrl[title]="+escape(title);
            }
            function browse_links_setValue(value) { //
                cur_href=value;
                add_href="&curUrl[href]="+value;
            }
        ';

        if ($this->mode == 'wizard')    {   // Functions used, if the link selector is in wizard mode (= TCEforms fields)
            unset($this->P['fieldChangeFunc']['alert']);
            reset($this->P['fieldChangeFunc']);
            $update='';
            while(list($k,$v)=each($this->P['fieldChangeFunc']))    {
                $update.= '
                window.opener.'.$v;
            }

            $P2=array();
            $P2['itemName']=$this->P['itemName'];
            $P2['formName']=$this->P['formName'];
            $P2['fieldChangeFunc']=$this->P['fieldChangeFunc'];
            $P2['params']['allowedExtensions']=$this->P['params']['allowedExtensions'];
            $P2['params']['blindLinkOptions']=$this->P['params']['blindLinkOptions'];
            $addPassOnParams.=t3lib_div::implodeArrayForUrl('P',$P2);

            $JScode.='
                function link_typo3Page(id,anchor)  {   //
                    updateValueInMainForm(id + (anchor ? anchor : ""));
                    close();
                    return false;
                }
                function link_folder(folder)    {   //
                    updateValueInMainForm(folder);
                    close();
                    return false;
                }
                function link_current() {   //
                    if (cur_href!="http://" && cur_href!="mailto:") {
                        returnBeforeCleaned = cur_href;
                        if (returnBeforeCleaned.substr(0, 7) == "http://") {
                            returnToMainFormValue = returnBeforeCleaned.substr(7);
                        } else if (returnBeforeCleaned.substr(0, 7) == "mailto:") {
                            if (returnBeforeCleaned.substr(0, 14) == "mailto:mailto:") {
                                returnToMainFormValue = returnBeforeCleaned.substr(14);
                            } else {
                                returnToMainFormValue = returnBeforeCleaned.substr(7);
                            }
                        } else {
                            returnToMainFormValue = returnBeforeCleaned;
                        }
                        updateValueInMainForm(returnToMainFormValue);
                        close();
                    }
                    return false;
                }
                function checkReference()   {   //
                    if (window.opener && window.opener.document && window.opener.document.'.$this->P['formName'].' && window.opener.document.'.$this->P['formName'].'["'.$this->P['itemName'].'"] ) {
                        return window.opener.document.'.$this->P['formName'].'["'.$this->P['itemName'].'"];
                    } else {
                        close();
                    }
                }
                function updateValueInMainForm(input)   {   //
                    var field = checkReference();
                    if (field)  {
                        if (cur_target == "" && (cur_title != "" || cur_class != "-")) {
                            cur_target = "-";
                        }
                        if (cur_title == "" && cur_class == "-") {
                            cur_class = "";
                        }
                        input = input + " " + cur_target + " " + cur_class + " " + cur_title;
                        field.value = input;
                        '.$update.'
                    }
                }
            ';
        } else {    // Functions used, if the link selector is in RTE mode:
            $JScode.='
                function link_typo3Page(id,anchor)  {   //
                    var theLink = \''.$this->siteURL.'?id=\'+id+(anchor?anchor:"");
                    self.parent.parent.renderPopup_addLink(theLink, cur_target, cur_class, cur_title);
                    return false;
                }
                function link_folder(folder)    {   //
                    var theLink = \''.$this->siteURL.'\'+folder;
                    self.parent.parent.renderPopup_addLink(theLink, cur_target, cur_class, cur_title);
                    return false;
                }
                function link_spec(theLink) {   //
                    self.parent.parent.renderPopup_addLink(theLink, cur_target, cur_class, cur_title);
                    return false;
                }
                function link_current() {   //
                    if (cur_href!="http://" && cur_href!="mailto:") {
                        self.parent.parent.renderPopup_addLink(cur_href, cur_target, cur_class, cur_title);
                    }
                    return false;
                }
            ';
        }

            // General "jumpToUrl" function:
        $JScode.='
            function jumpToUrl(URL,anchor)  {   //
                var add_act = URL.indexOf("act=")==-1 ? "&act='.$this->act.'" : "";
                var add_mode = URL.indexOf("mode=")==-1 ? "&mode='.$this->mode.'" : "";
                var theLocation = URL + add_act + add_mode + add_href + add_target + add_class + add_title + add_params'.($addPassOnParams?'+"'.$addPassOnParams.'"':'').'+(anchor?anchor:"");
                window.location.href = theLocation;
                return false;
            }
        ';


        /**
         * Splits parts of $this->bparams
         * @see $bparams
         */
        $pArr = explode('|',$this->bparams);

            // This is JavaScript especially for the TBE Element Browser!
        $formFieldName = 'data['.$pArr[0].']['.$pArr[1].']['.$pArr[2].']';

            // insertElement - Call check function (e.g. for uniqueness handling):
        if ($pArr[4] && $pArr[5]) {
            $JScodeCheck = '
                    // Call a check function in the opener window (e.g. for uniqueness handling):
                if (parent.window.opener) {
                    var res = parent.window.opener.'.$pArr[5].'("'.addslashes($pArr[4]).'",table,uid,type);
                    if (!res.passed) {
                        if (res.message) alert(res.message);
                        performAction = false;
                    }
                } else {
                    alert("Error - reference to main window is not set properly!");
                    parent.close();
                }
            ';
        }
            // insertElement - Call helper function:
        if ($pArr[4] && $pArr[6]) {
            $JScodeHelper = '
                        // Call helper function to manage data in the opener window:
                    if (parent.window.opener) {
                        parent.window.opener.'.$pArr[6].'("'.addslashes($pArr[4]).'",table,uid,type,"'.addslashes($pArr[0]).'");
                    } else {
                        alert("Error - reference to main window is not set properly!");
                        parent.close();
                    }
            ';
        }
            // insertElement - perform action commands:
        if ($pArr[4] && $pArr[7]) {
                // Call user defined action function:
            $JScodeAction = '
                    if (parent.window.opener) {
                        parent.window.opener.'.$pArr[7].'("'.addslashes($pArr[4]).'",table,uid,type);
                        focusOpenerAndClose(close);
                    } else {
                        alert("Error - reference to main window is not set properly!");
                        parent.close();
                    }
            ';
        } else if ($pArr[0] && !$pArr[1] && !$pArr[2]) {
            $JScodeAction = '
                    addElement(filename,table+"_"+uid,fp,close);
            ';
        } else {
            $JScodeAction = '
                    if (setReferences()) {
                        parent.window.opener.group_change("add","'.$pArr[0].'","'.$pArr[1].'","'.$pArr[2].'",elRef,targetDoc);
                    } else {
                        alert("Error - reference to main window is not set properly!");
                    }
                    focusOpenerAndClose(close);
            ';
        }

        $JScode.='
            var elRef="";
            var targetDoc="";

            function launchView(url)    {   //
                var thePreviewWindow="";
                thePreviewWindow = window.open("'.$BACK_PATH.'show_item.php?table="+url,"ShowItem","height=300,width=410,status=0,menubar=0,resizable=0,location=0,directories=0,scrollbars=1,toolbar=0");
                if (thePreviewWindow && thePreviewWindow.focus) {
                    thePreviewWindow.focus();
                }
            }
            function setReferences()    {   //
                if (parent.window.opener && parent.window.opener.content && parent.window.opener.content.document.editform && parent.window.opener.content.document.editform["'.$formFieldName.'"]) {
                    targetDoc = parent.window.opener.content.document;
                    elRef = targetDoc.editform["'.$formFieldName.'"];
                    return true;
                } else {
                    return false;
                }
            }
            function insertElement(table, uid, type, filename,fp,filetype,imagefile,action, close)  {   //
                var performAction = true;
                '.$JScodeCheck.'
                    // Call performing function and finish this action:
                if (performAction) {
                        '.$JScodeHelper.$JScodeAction.'
                }
                return false;
            }
            function addElement(elName,elValue,altElValue,close)    {   //
                if (parent.window.opener && parent.window.opener.setFormValueFromBrowseWin) {
                    parent.window.opener.setFormValueFromBrowseWin("'.$pArr[0].'",altElValue?altElValue:elValue,elName);
                    focusOpenerAndClose(close);
                } else {
                    alert("Error - reference to main window is not set properly!");
                    parent.close();
                }
            }
            function focusOpenerAndClose(close) {   //
                BrowseLinks.focusOpenerAndClose(close);
            }
        ';

            // Finally, add the accumulated JavaScript to the template object:
        $this->doc->JScode.= $this->doc->wrapScriptTags($JScode);

            // Debugging:
        if (FALSE) debug(array(
            'pointer' => $this->pointer,
            'act' => $this->act,
            'mode' => $this->mode,
            'curUrlInfo' => $this->curUrlInfo,
            'curUrlArray' => $this->curUrlArray,
            'P' => $this->P,
            'bparams' => $this->bparams,
            'RTEtsConfigParams' => $this->RTEtsConfigParams,
            'expandPage' => $this->expandPage,
            'expandFolder' => $this->expandFolder,
            'PM' => $this->PM,
        ),'Internal variables of Script Class:');
    }


    /**
     * Session data for this class can be set from outside with this method.
     * Call after init()
     *
     * @param   array       Session data array
     * @return  array       Session data and boolean which indicates that data needs to be stored in session because it's changed
     */
    function processSessionData($data) {
        $store = false;

        switch((string)$this->mode) {
            case 'db':
                if (isset($this->expandPage))   {
                    $data['expandPage']=$this->expandPage;
                    $store = true;
                } else {
                    $this->expandPage=$data['expandPage'];
                }
            break;
            case 'file':
            case 'filedrag':
            case 'folder':
                if (isset($this->expandFolder)) {
                    $data['expandFolder']=$this->expandFolder;
                    $store = true;
                } else {
                    $this->expandFolder=$data['expandFolder'];
                }
            break;
        }

        return array($data, $store);
    }




    /******************************************************************
     *