"TYPO3 4.0.1: typo3_src-4.0.1/typo3/view_help.php Source File", "datetime" => "Sat Dec 2 19:22:35 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

view_help.php

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2005 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('init.php');
require('template.php');
$LANG->includeLLFile('EXT:lang/locallang_view_help.xml');
require_once(PATH_t3lib.'class.t3lib_loadmodules.php');
require_once(PATH_t3lib.'class.t3lib_parsehtml.php');


class local_t3lib_parsehtml extends t3lib_parsehtml {

        function processContent($value,$dir,$conf)      {
                $value = $this->pObj->substituteGlossaryWords_htmlcleaner_callback($value);

                return $value;
        }
}







class SC_view_help {
        var $allowedHTML = '<strong><em><b><i>';

                // For these vars, see init()
        var $limitAccess;       // If set access to fields and tables is checked. Should be done for true database tables.
        var $table;                     // The "table" key
        var $field;                     // The "field" key

                // Internal, static: GPvar:
        var $tfID;                      // Table/FIeld id.
        var $back;                      // Back (previous tfID)
        var $renderALL;         // If set, then in TOC mode the FULL manual will be printed as well!

                // Internal, dynamic:
        var $content;   // Content accumulation.
        var $glossaryWords;             // Glossary words



        function init() {
                global $LANG, $TCA;

                        // Setting GPvars:
                $this->tfID = t3lib_div::_GP('tfID');
                $this->back = t3lib_div::_GP('back');
                $this->renderALL = t3lib_div::_GP('renderALL');

                        // Set internal table/field to the parts of "tfID" incoming var.
                list($this->table,$this->field) = explode('.',$this->tfID);

                        // limitAccess is checked if the $this->table really IS a table (and if the user is NOT a translator who should see all!)
                $showAllToUser = t3lib_BEfunc::isModuleSetInTBE_MODULES('txllxmltranslateM1') && $GLOBALS['BE_USER']->check('modules','txllxmltranslateM1');
                $this->limitAccess = isset($TCA[$this->table]) ? !$showAllToUser : FALSE;
        }

        function main() {
                global $BE_USER,$LANG,$TCA_DESCR,$TCA,$TBE_TEMPLATE;

                        // Start HTML output accumulation:
                $TBE_TEMPLATE->docType = 'xhtml_trans';
                $TBE_TEMPLATE->divClass = 'typo3-view-help';
                $this->content.= $TBE_TEMPLATE->startPage($LANG->getLL('title'));

                if ($this->field=='*')  { // If ALL fields is supposed to be shown:
                        $this->createGlossaryIndex();
                        $this->content.= $this->render_Table($this->table);
                } elseif ($this->tfID) { // ... otherwise show only single field:
                        $this->createGlossaryIndex();
                        $this->content.= $this->render_Single($this->table,$this->field);
                } else {        // Render Table Of Contents if nothing else:
                        $this->content.= $this->render_TOC();
                }

                        // Print close-button:
#               $this->content.='<br /><form action=""><input type="submit" value="'.htmlspecialchars($LANG->getLL('close')).'" onclick="self.close(); return false;" /></form><br/>';

                        // End page:
                $this->content.= '<br/>';
                $this->content.= $TBE_TEMPLATE->endPage();
        }

        function printContent() {
                echo $this->content;
        }









        /************************************
         *
         * Rendering main modes
         *
         ************************************/

        function render_TOC()   {
                global $TCA_DESCR,$TCA,$LANG,$BE_USER,$TBE_MODULES;

                        // Initialize:
                $CSHkeys = array_flip(array_keys($TCA_DESCR));
                $TCAkeys = array_keys($TCA);

                $outputSections = array();
                $tocArray = array();


                        // TYPO3 Core Features:
                $LANG->loadSingleTableDescription('xMOD_csh_corebe');
                $this->render_TOC_el('xMOD_csh_corebe', 'core', $outputSections, $tocArray, $CSHkeys);

                        // Backend Modules:
                $loadModules = t3lib_div::makeInstance('t3lib_loadModules');
                $loadModules->load($TBE_MODULES);
                foreach($loadModules->modules as $mainMod => $info)     {
                        $cshKey = '_MOD_'.$mainMod;
                        if ($CSHkeys[$cshKey])  {
                                $LANG->loadSingleTableDescription($cshKey);
                                $this->render_TOC_el($cshKey, 'modules', $outputSections, $tocArray, $CSHkeys);
                        }

                        if (is_array($info['sub']))     {
                                foreach($info['sub'] as $subMod => $subInfo)    {
                                        $cshKey = '_MOD_'.$mainMod.'_'.$subMod;
                                        if ($CSHkeys[$cshKey])  {
                                                $LANG->loadSingleTableDescription($cshKey);
                                                $this->render_TOC_el($cshKey, 'modules', $outputSections, $tocArray, $CSHkeys);
                                        }
                                }
                        }
                }

                        // Database Tables:
                foreach($TCAkeys as $table)     {
                                // Load descriptions for table $table
                        $LANG->loadSingleTableDescription($table);
                        if (is_array($TCA_DESCR[$table]['columns']) && $BE_USER->check('tables_select',$table)) {
                                $this->render_TOC_el($table, 'tables', $outputSections, $tocArray, $CSHkeys);
                        }
                }

                        // Extensions
                foreach($CSHkeys as $cshKey => $value)  {
                        if (t3lib_div::isFirstPartOfStr($cshKey, 'xEXT_') && !isset($TCA[$cshKey]))     {
                                $LANG->loadSingleTableDescription($cshKey);
                                $this->render_TOC_el($cshKey, 'extensions', $outputSections, $tocArray, $CSHkeys);
                        }
                }

                        // Glossary
                foreach($CSHkeys as $cshKey => $value)  {
                        if (t3lib_div::isFirstPartOfStr($cshKey, 'xGLOSSARY_') && !isset($TCA[$cshKey]))        {
                                $LANG->loadSingleTableDescription($cshKey);
                                $this->render_TOC_el($cshKey, 'glossary', $outputSections, $tocArray, $CSHkeys);
                        }
                }

                        // Other:
                foreach($CSHkeys as $cshKey => $value)  {
                        if (!t3lib_div::isFirstPartOfStr($cshKey, '_MOD_') && !isset($TCA[$cshKey]))    {
                                $LANG->loadSingleTableDescription($cshKey);
                                $this->render_TOC_el($cshKey, 'other', $outputSections, $tocArray, $CSHkeys);
                        }
                }


                        // COMPILE output:
                $output = '';
                $output.= '

                        <h1>'.$LANG->getLL('manual_title',1).'</h1>
                        <p>'.t3lib_BEfunc::TYPO3_copyRightNotice().'</p>';

                $output.= '

                        <h1>'.$LANG->getLL('introduction',1).'</h1>
                        <p>'.$LANG->getLL('description',1).'</p>';

                $output.= '

                        <h1>'.$LANG->getLL('TOC',1).'</h1>'.
                        $this->render_TOC_makeTocList($tocArray);

                if (!$this->renderALL)  {
                $output.= '
                                <br/>
                                <p class="c-nav"><a href="view_help.php?renderALL=1">'.$LANG->getLL('full_manual',1).'</a></p>';
                }

                if ($this->renderALL)   {
                        $output.= '

                                <h1>'.$LANG->getLL('full_manual_chapters',1).'</h1>'.
                                implode('


                                <!-- NEW SECTION: -->
                                ',$outputSections);
                }

                return $output;
        }

        function render_TOC_el($table, $tocCat, &$outputSections, &$tocArray, &$CSHkeys)        {
                global $LANG;

                if ($this->renderALL)   {       // Render full manual right here!
                        $outputSections[$table] = $this->render_Table($table);

                        if ($outputSections[$table])    {
                                $outputSections[$table] = '

                <!-- New CSHkey/Table: '.$table.' -->
                <p class="c-nav"><a name="ANCHOR_'.$table.'" href="#">'.$LANG->getLL('to_top',1).'</a></p>
                <h2>'.$this->getTableFieldLabel($table).'</h2>

                '.$outputSections[$table];
                                $tocArray[$tocCat][$table] = '<a href="#ANCHOR_'.$table.'">'.$this->getTableFieldLabel($table).'</a>';
                        } else {
                                unset($outputSections[$table]);
                        }
                } else {        // Only TOC:
                        $tocArray[$tocCat][$table] = '<p><a href="view_help.php?tfID='.rawurlencode($table.'.*').'">'.$this->getTableFieldLabel($table).'</a></p>';
                }

                        // Unset CSH key:
                unset($CSHkeys[$table]);
        }

        function render_TOC_makeTocList($tocArray)      {
                global $LANG;

                        // The Various manual sections:
                $keys = explode(',', 'core,modules,tables,extensions,glossary,other');

                        // Create TOC bullet list:
                $output = '';
                foreach($keys as $tocKey)       {
                        if (is_array($tocArray[$tocKey]))       {
                                $output.='
                                        <li>'.$LANG->getLL('TOC_'.$tocKey,1).'
                                                <ul>
                                                        <li>'.implode('</li>
                                                        <li>',$tocArray[$tocKey]).'</li>
                                                </ul>
                                        </li>';
                        }
                }

                        // Compile TOC:
                $output = '

                        <!-- TOC: -->
                        <div class="c-toc">
                                <ul>
                                '.$output.'
                                </ul>
                        </div>';

                return $output;
        }

        function render_Table($table)   {
                global $BE_USER,$TCA_DESCR,$TCA,$LANG;

                $output = '';

                        // Load table TCA
                t3lib_div::loadTCA($table);

                        // Load descriptions for table $table
                $LANG->loadSingleTableDescription($table);

                if (is_array($TCA_DESCR[$table]['columns']) && (!$this->limitAccess || $BE_USER->check('tables_select',$table)))        {
                                // Initialize variables:
                        $parts = array();
                        $parts[0] = ''; // Reserved for header of table

                                // Traverse table columns as listed in TCA_DESCR
                        reset($TCA_DESCR[$table]['columns']);
                        while(list($field) = each($TCA_DESCR[$table]['columns']))       {

                                $fieldValue = isset($TCA[$table]) && strcmp($field,'') ? $TCA[$table]['columns'][$field] : array();

                                if (is_array($fieldValue) && (!$this->limitAccess || !$fieldValue['exclude'] || $BE_USER->check('non_exclude_fields',$table.':'.$field)))       {
                                        if (!$field)    {
                                                $parts[0] = $this->printItem($table,'',1);      // Header
                                        } else {
                                                $parts[] = $this->printItem($table,$field,1);   // Field
                                        }
                                }
                        }

                        if (!strcmp($parts,'')) unset($parts[0]);
                        $output.= implode('<br />',$parts);
                }

                        // Substitute glossary words:
                $output = $this->substituteGlossaryWords($output);

                        // TOC link:
                if (!$this->renderALL)  {
                        $tocLink = '<p class="c-nav"><a href="view_help.php">'.$LANG->getLL('goToToc',1).'</a></p>';

                        $output =
                                $tocLink.'
                                <br/>'.
                                $output.'
                                <br />'.
                                $tocLink;
                }

                return $output;
        }

        function render_Single($table,$field)   {
                global $LANG, $TCA;

                $output = '';

                        // Load descriptions for table $table
                $LANG->loadSingleTableDescription($table);

                        // Render single item:
                $output.= $this->printItem($table,$field);

                        // Substitute glossary words:
                $output = $this->substituteGlossaryWords($output);

                        // Link to Full table description and TOC:
                $getLLKey = $this->limitAccess ? 'fullDescription' : 'fullDescription_module';
                $output.= '<br />
                        <p class="c-nav"><a href="view_help.php?tfID='.rawurlencode($table.'.*').'">'.$LANG->getLL($getLLKey,1).'</a></p>
                        <p class="c-nav"><a href="view_help.php">'.$LANG->getLL('goToToc',1).'</a></p>';

                return $output;
        }











        /************************************
         *
         * Rendering CSH items
         *
         ************************************/

        function make_seeAlso($value,$anchorTable='')   {
                global $TCA,$BE_USER,$TCA_DESCR;

                        // Split references by comma, vert.line or linebreak
                $items = split(',|'.chr(10),$value);
                $lines = array();

                foreach($items as $val) {
                        $val = trim($val);
                        if ($val)       {
                                $iP = explode(':',$val);
                                $iPUrl = t3lib_div::trimExplode('|',$val);
                                        // URL reference:
                                if (substr($iPUrl[1],0,4)=='http')      {
                                        $lines[] = '<a href="'.htmlspecialchars($iPUrl[1]).'" target="_blank"><em>'.htmlspecialchars($iPUrl[0]).'</em></a>';
                                } elseif (substr($iPUrl[1],0,5)=='FILE:')       {
                                        $fileName = t3lib_div::getFileAbsFileName(substr($iPUrl[1],5),1,1);
                                        if ($fileName && @is_file($fileName))   {
                                                $fileName = '../'.substr($fileName,strlen(PATH_site));
                                                $lines[] = '<a href="'.htmlspecialchars($fileName).'" target="_blank"><em>'.htmlspecialchars($iPUrl[0]).'</em></a>';
                                        }
                                } else {
                                        // "table" reference
                                        t3lib_div::loadTCA($iP[0]);

                                        if (!isset($TCA[$iP[0]]) || ((!$iP[1] || is_array($TCA[$iP[0]]['columns'][$iP[1]])) && (!$this->limitAccess || ($BE_USER->check('tables_select',$iP[0]) && (!$iP[1] || !$TCA[$iP[0]]['columns'][$iP[1]]['exclude'] || $BE_USER->check('non_exclude_fields',$iP[0].':'.$iP[1]))))))      {       // Checking read access:

                                                        // Load table descriptions:
                                                #$LANG->loadSingleTableDescription($iP[0]);
                                                if (isset($TCA_DESCR[$iP[0]]))  {
                                                                // Make see-also link:
                                                        $href = ($this->renderALL || ($anchorTable && $iP[0]==$anchorTable) ? '#'.implode('.',$iP) : 'view_help.php?tfID='.rawurlencode(implode('.',$iP)).'&back='.$this->tfID);
                                                        $label = $this->getTableFieldLabel($iP[0],$iP[1],' / ');
                                                        $lines[] = '<a href="'.htmlspecialchars($href).'">'.htmlspecialchars($label).'</a>';
                                                }
                                        }
                                }
                        }
                }
                return implode('<br />',$lines);
        }

        function printImage($images,$descr)     {
                $code = '';
                        // Splitting:
                $imgArray = t3lib_div::trimExplode(',', $images, 1);
                if (count($imgArray))   {
                        $descrArray = explode(chr(10),$descr,count($imgArray));
#debug($descrArray);
                        foreach($imgArray as $k => $image)      {
                                $descr = $descrArray[$k];

                                $absImagePath = t3lib_div::getFileAbsFileName($image,1,1);
                                if ($absImagePath && @is_file($absImagePath))   {
                                        $imgFile = substr($absImagePath,strlen(PATH_site));
                                        $imgInfo = @getimagesize($absImagePath);
                                        if (is_array($imgInfo)) {
                                                $imgFile = '../'.$imgFile;
                                                $code.= '<br /><img src="'.$imgFile.'" '.$imgInfo[3].' class="c-inlineimg" alt="" /><br />
                                                ';
                                                $code.= '<p><em>'.$GLOBALS['LANG']->hscAndCharConv($descr,1).'</em></p>
                                                ';
                                        } else $code.= '<div style="background-color: red; border: 1px solid black; color: white;">NOT AN IMAGE: '.$imgFile.'</div>';
                                } else $code.= '<div style="background-color: red; border: 1px solid black; color: white;">IMAGE FILE NOT FOUND: '.$image.'</div>';
                        }
                }

                return $code;
        }

        function headerLine($str,$type=0)       {
                switch($type)   {
                        case 1:
                                $str='<h3>'.htmlspecialchars($str).'</h3>
                                ';
                        break;
                        case 0:
                                $str='<h4 class="uppercase">'.htmlspecialchars($str).'</h4>
                                ';
                        break;
                }

                return $str;
        }

        function prepareContent($str)   {
                $str = $GLOBALS['LANG']->hscAndCharConv($str,0);
                return '<p>'.nl2br(trim(strip_tags($str,$this->allowedHTML))).'</p>
                ';
        }

        function printItem($table,$field,$anchors=0)    {
                global $TCA_DESCR, $LANG, $TCA, $BE_USER;

                        // Load full table definition in $TCA
                t3lib_div::loadTCA($table);

                if ($table && (!$field || is_array($TCA_DESCR[$table]['columns'][$field])))     {
                                // Make seeAlso references.
                        $seeAlsoRes = $this->make_seeAlso($TCA_DESCR[$table]['columns'][$field]['seeAlso'],$anchors?$table:'');

                                // Making item:
                        $out= '<a name="'.$table.'.'.$field.'"></a>
                                        '.
                                        $this->headerLine($this->getTableFieldLabel($table,$field),1).
                                        $this->prepareContent($TCA_DESCR[$table]['columns'][$field]['description']).
                                        ($TCA_DESCR[$table]['columns'][$field]['details'] ? $this->headerLine($LANG->getLL('details').':').$this->prepareContent($TCA_DESCR[$table]['columns'][$field]['details']) : '').
                                        ($TCA_DESCR[$table]['columns'][$field]['syntax'] ? $this->headerLine($LANG->getLL('syntax').':').$this->prepareContent($TCA_DESCR[$table]['columns'][$field]['syntax']) : '').
                                        ($TCA_DESCR[$table]['columns'][$field]['image'] ? $this->printImage($TCA_DESCR[$table]['columns'][$field]['image'],$TCA_DESCR[$table]['columns'][$field]['image_descr']) : '').
                                        ($TCA_DESCR[$table]['columns'][$field]['seeAlso'] && $seeAlsoRes ? $this->headerLine($LANG->getLL('seeAlso').':').'<p>'.$seeAlsoRes.'</p>' : '').
                                        ($this->back ? '<br /><p><a href="'.htmlspecialchars('view_help.php?tfID='.rawurlencode($this->back)).'" class="typo3-goBack">'.htmlspecialchars($LANG->getLL('goBack')).'</a></p>' : '').
                        '<br />';
                }
                return $out;
        }

        function getTableFieldNames($table,$field)      {
                global $TCA, $TCA_DESCR, $LANG;

                        $LANG->loadSingleTableDescription($table);

                        $tableName = is_array($TCA_DESCR[$table]['columns']['']) && $TCA_DESCR[$table]['columns']['']['alttitle'] ?
                                                        $TCA_DESCR[$table]['columns']['']['alttitle'] :
                                                        (isset($TCA[$table]) ? $TCA[$table]['ctrl']['title'] : ereg_replace('^_MOD_','',$table));
                        $fieldName = is_array($TCA_DESCR[$table]['columns'][$field]) && $TCA_DESCR[$table]['columns'][$field]['alttitle'] ?
                                                        $TCA_DESCR[$table]['columns'][$field]['alttitle'] :
                                                        (isset($TCA[$table])&&isset($TCA[$table]['columns'][$field]) ? $TCA[$table]['columns'][$field]['label'] : $field);
                return array($tableName,$fieldName);
        }

        function getTableFieldLabel($table,$field='',$mergeToken=': ')  {
                global $LANG;

                        // Get table / field parts:
                list($tableName,$fieldName) = $this->getTableFieldNames($table,$field);

                        // Create label:
                $labelStr = $LANG->sL($tableName).
                                        ($field ? $mergeToken.ereg_replace(':$','', trim($LANG->sL($fieldName))):'');

                return $labelStr;
        }











        /******************************
         *
         * Glossary related
         *
         ******************************/

        function createGlossaryIndex()  {
                global $TCA_DESCR,$TCA,$LANG;

                        // Create hash string and try to retrieve glossary array:
                $hash = md5('typo3/view_help.php:glossary');
                list($this->glossaryWords,$this->substWords) = unserialize(t3lib_BEfunc::getHash($hash));

                        // Generate glossary words if not found:
                if (!is_array($this->glossaryWords)) {

                                // Initialize:
                        $this->glossaryWords = array();
                        $this->substWords = array();
                        $CSHkeys = array_flip(array_keys($TCA_DESCR));

                                // Glossary
                        foreach($CSHkeys as $cshKey => $value)  {
                                if (t3lib_div::isFirstPartOfStr($cshKey, 'xGLOSSARY_') && !isset($TCA[$cshKey]))        {
                                        $LANG->loadSingleTableDescription($cshKey);

                                        if (is_array($TCA_DESCR[$cshKey]['columns']))   {

                                                        // Traverse table columns as listed in TCA_DESCR
                                                reset($TCA_DESCR[$cshKey]['columns']);
                                                while(list($field,$data) = each($TCA_DESCR[$cshKey]['columns']))        {
                                                        if ($field)     {
                                                                $this->glossaryWords[$cshKey.'.'.$field] = array(
                                                                        'title' => trim($data['alttitle'] ? $data['alttitle'] : $cshKey),
                                                                        'description' =>  str_replace('%22','%23%23%23', rawurlencode($data['description'])),
                                                                );
                                                        }
                                                }
                                        }
                                }
                        }

                                // First, create unique list of words:
                        foreach($this->glossaryWords as $key => $value) {
                                $word = strtolower($value['title']);    // Making word lowercase in order to filter out same words in different cases.

                                if ($word!=='') {
                                        $this->substWords[$word] = $value;
                                        $this->substWords[$word]['key'] = $key;
                                }
                        }

                        krsort($this->substWords);

                        t3lib_BEfunc::storeHash($hash,serialize(array($this->glossaryWords,$this->substWords)),'Glossary');
                }
        }

        function substituteGlossaryWords($code) {
                $htmlParser = t3lib_div::makeInstance('local_t3lib_parsehtml');
                $htmlParser->pObj = &$this;
                $code = $htmlParser->HTMLcleaner($code, array(), 1);

                return $code;
        }

        function substituteGlossaryWords_htmlcleaner_callback($code)    {
                if (is_array($this->substWords) && count($this->substWords) && strlen(trim($code)))     {

                                // Substitute words:
                        foreach($this->substWords as $wordKey => $wordSet)      {
                                        // quoteMeta used so special chars (which should not occur though) in words will not break the regex. Seemed to work (- kasper)
                                $parts = preg_split('/( |[\(])('.quoteMeta($wordSet['title']).')([\.\!\)\?\:\,]+| )/i', ' '.$code.' ', 2, PREG_SPLIT_DELIM_CAPTURE);
                                if (count($parts) == 5) {
                                        $parts[2] = '<a class="glossary-term" href="'.htmlspecialchars('view_help.php?tfID='.rawurlencode($wordSet['key']).'&back='.$this->tfID).'" title="'.rawurlencode(htmlspecialchars(t3lib_div::fixed_lgd_cs(rawurldecode($wordSet['description']),80))).'">'.
                                                                htmlspecialchars($parts[2]).
                                                                '</a>';
                                        $code = substr(implode('',$parts),1,-1);

                                                // Disable entry so it doesn't get used next time:
                                        unset($this->substWords[$wordKey]);
                                }
                        }
                        $code = str_replace('###', '&quot;',rawurldecode($code));
                }

                return $code;
        }

}


// Include extension?
if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/view_help.php'])     {
        include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/view_help.php']);
}






// Make instance:
$SOBE = t3lib_div::makeInstance('SC_view_help');
$SOBE->init();
$SOBE->main();
$SOBE->printContent();
?>