db_list.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!
***************************************************************/
unset($MCONF);
require ('mod/web/list/conf.php');
require ('init.php');
require ('template.php');
$LANG->includeLLFile('EXT:lang/locallang_mod_web_list.xml');
require_once (PATH_t3lib.'class.t3lib_page.php');
require_once (PATH_t3lib.'class.t3lib_pagetree.php');
require_once (PATH_t3lib.'class.t3lib_recordlist.php');
require_once (PATH_t3lib.'class.t3lib_clipboard.php');
require_once ('class.db_list.inc');
require_once ('class.db_list_extra.inc');
$BE_USER->modAccess($MCONF,1);

t3lib_BEfunc::lockRecords();








class SC_db_list {

      // Internal, GPvars:
   var $id;             // Page Id for which to make the listing
   var $pointer;           // Pointer - for browsing list of records.
   var $imagemode;            // Thumbnails or not
   var $table;             // Which table to make extended listing for
   var $search_field;         // Search-fields
   var $search_levels;        // Search-levels
   var $showLimit;            // Show-limit
   var $returnUrl;            // Return URL

   var $clear_cache;       // Clear-cache flag - if set, clears page cache for current id.
   var $cmd;               // Command: Eg. "delete" or "setCB" (for TCEmain / clipboard operations)
   var $cmd_table;            // Table on which the cmd-action is performed.

      // Internal, static:
   var $perms_clause;         // Page select perms clause
   var $modTSconfig;       // Module TSconfig
   var $pageinfo;          // Current ids page record
   var $doc;               // Document template object

   var $MCONF=array();        // Module configuration
   var $MOD_MENU=array();     // Menu configuration
   var $MOD_SETTINGS=array(); // Module settings (session variable)
   var $include_once=array(); // Array, where files to include is accumulated in the init() function

      // Internal, dynamic:
   var $content;           // Module output accumulation


   function init()   {
      global $BE_USER;

         // Setting module configuration / page select clause
      $this->MCONF = $GLOBALS['MCONF'];
      $this->perms_clause = $BE_USER->getPagePermsClause(1);

         // GPvars:
      $this->id = t3lib_div::_GP('id');
      $this->pointer = t3lib_div::_GP('pointer');
      $this->imagemode = t3lib_div::_GP('imagemode');
      $this->table = t3lib_div::_GP('table');
      $this->search_field = t3lib_div::_GP('search_field');
      $this->search_levels = t3lib_div::_GP('search_levels');
      $this->showLimit = t3lib_div::_GP('showLimit');
      $this->returnUrl = t3lib_div::_GP('returnUrl');

      $this->clear_cache = t3lib_div::_GP('clear_cache');
      $this->cmd = t3lib_div::_GP('cmd');
      $this->cmd_table = t3lib_div::_GP('cmd_table');

         // Initialize menu
      $this->menuConfig();

         // Inclusions?
      if ($this->clear_cache || $this->cmd=='delete') {
         $this->include_once[]=PATH_t3lib.'class.t3lib_tcemain.php';
      }
   }

   function menuConfig()   {

         // MENU-ITEMS:
      $this->MOD_MENU = array(
         'bigControlPanel' => '',
         'clipBoard' => '',
         'localization' => ''
      );

         // Loading module configuration:
      $this->modTSconfig = t3lib_BEfunc::getModTSconfig($this->id,'mod.'.$this->MCONF['name']);

         // Clean up settings:
      $this->MOD_SETTINGS = t3lib_BEfunc::getModuleData($this->MOD_MENU, t3lib_div::_GP('SET'), $this->MCONF['name']);
   }

   function clearCache()   {
      if ($this->clear_cache) {
         $tce = t3lib_div::makeInstance('t3lib_TCEmain');
         $tce->stripslashes_values=0;
         $tce->start(Array(),Array());
         $tce->clear_cacheCmd($this->id);
      }
   }

   function main()   {
      global $BE_USER,$LANG,$BACK_PATH,$CLIENT;

         // Start document template object:
      $this->doc = t3lib_div::makeInstance('template');
      $this->doc->backPath = $BACK_PATH;
      $this->doc->docType='xhtml_trans';

         // Loading current page record and checking access:
      $this->pageinfo = t3lib_BEfunc::readPageAccess($this->id,$this->perms_clause);
      $access = is_array($this->pageinfo) ? 1 : 0;

         // Initialize the dblist object:
      $dblist = t3lib_div::makeInstance('localRecordList');
      $dblist->backPath = $BACK_PATH;
      $dblist->calcPerms = $BE_USER->calcPerms($this->pageinfo);
      $dblist->thumbs = $BE_USER->uc['thumbnailsByDefault'];
      $dblist->returnUrl=$this->returnUrl;
      $dblist->allFields = ($this->MOD_SETTINGS['bigControlPanel'] || $this->table) ? 1 : 0;
      $dblist->localizationView = $this->MOD_SETTINGS['localization'];
      $dblist->showClipboard = 1;
      $dblist->disableSingleTableView = $this->modTSconfig['properties']['disableSingleTableView'];
      $dblist->listOnlyInSingleTableMode = $this->modTSconfig['properties']['listOnlyInSingleTableView'];
      $dblist->clickTitleMode = $this->modTSconfig['properties']['clickTitleMode'];
      $dblist->alternateBgColors=$this->modTSconfig['properties']['alternateBgColors']?1:0;
      $dblist->allowedNewTables = t3lib_div::trimExplode(',',$this->modTSconfig['properties']['allowedNewTables'],1);
      $dblist->newWizards=$this->modTSconfig['properties']['newWizards']?1:0;



         // Clipboard is initialized:
      $dblist->clipObj = t3lib_div::makeInstance('t3lib_clipboard');    // Start clipboard
      $dblist->clipObj->initializeClipboard();  // Initialize - reads the clipboard content from the user session

         // Clipboard actions are handled:
      $CB = t3lib_div::_GET('CB');  // CB is the clipboard command array
      if ($this->cmd=='setCB') {
            // CBH is all the fields selected for the clipboard, CBC is the checkbox fields which were checked. By merging we get a full array of checked/unchecked elements
            // This is set to the 'el' array of the CB after being parsed so only the table in question is registered.
         $CB['el'] = $dblist->clipObj->cleanUpCBC(array_merge(t3lib_div::_POST('CBH'),t3lib_div::_POST('CBC')),$this->cmd_table);
      }
      if (!$this->MOD_SETTINGS['clipBoard']) $CB['setP']='normal';   // If the clipboard is NOT shown, set the pad to 'normal'.
      $dblist->clipObj->setCmd($CB);      // Execute commands.
      $dblist->clipObj->cleanCurrent();   // Clean up pad
      $dblist->clipObj->endClipboard();   // Save the clipboard content

         // This flag will prevent the clipboard panel in being shown.
         // It is set, if the clickmenu-layer is active AND the extended view is not enabled.
      $dblist->dontShowClipControlPanels = $CLIENT['FORMSTYLE'] && !$this->MOD_SETTINGS['bigControlPanel'] && $dblist->clipObj->current=='normal' && !$BE_USER->uc['disableCMlayers'] && !$this->modTSconfig['properties']['showClipControlPanelsDespiteOfCMlayers'];



         // If there is access to the page, then render the list contents and set up the document template object:
      if ($access)   {

            // Deleting records...:
            // Has not to do with the clipboard but is simply the delete action. The clipboard object is used to clean up the submitted entries to only the selected table.
         if ($this->cmd=='delete')  {
            $items = $dblist->clipObj->cleanUpCBC(t3lib_div::_POST('CBC'),$this->cmd_table,1);
            if (count($items))   {
               $cmd=array();
               reset($items);
               while(list($iK)=each($items)) {
                  $iKParts = explode('|',$iK);
                  $cmd[$iKParts[0]][$iKParts[1]]['delete']=1;
               }
               $tce = t3lib_div::makeInstance('t3lib_TCEmain');
               $tce->stripslashes_values=0;
               $tce->start(array(),$cmd);
               $tce->process_cmdmap();

               if (isset($cmd['pages']))  {
                  t3lib_BEfunc::getSetUpdateSignal('updatePageTree');
               }

               $tce->printLogErrorMessages(t3lib_div::getIndpEnv('REQUEST_URI'));
            }
         }

            // Initialize the listing object, dblist, for rendering the list:
         $this->pointer = t3lib_div::intInRange($this->pointer,0,100000);
         $dblist->start($this->id,$this->table,$this->pointer,$this->search_field,$this->search_levels,$this->showLimit);
         $dblist->setDispFields();

            // Render the page header:
         $dblist->writeTop($this->pageinfo);

            // Render versioning selector:
         $dblist->HTMLcode.= $this->doc->getVersionSelector($this->id);

            // Render the list of tables:
         $dblist->generateList($this->id,$this->table);

            // Write the bottom of the page:
         $dblist->writeBottom();

            // Add JavaScript functions to the page:
         $this->doc->JScode=$this->doc->wrapScriptTags('
            function jumpToUrl(URL) {  //
               document.location = URL;
               return false;
            }
            function jumpExt(URL,anchor)  {  //
               var anc = anchor?anchor:"";
               document.location = URL+(T3_THIS_LOCATION?"&returnUrl="+T3_THIS_LOCATION:"")+anc;
               return false;
            }
            function jumpSelf(URL)  {  //
               document.location = URL+(T3_RETURN_URL?"&returnUrl="+T3_RETURN_URL:"");
               return false;
            }
            '.$this->doc->redirectUrls($dblist->listURL()).'
            '.$dblist->CBfunctions().'
            function editRecords(table,idList,addParams,CBflag)   {  //
               document.location="'.$backPath.'alt_doc.php?returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI')).
                  '&edit["+table+"]["+idList+"]=edit"+addParams;
            }
            function editList(table,idList)  {  //
               var list="";

                  // Checking how many is checked, how many is not
               var pointer=0;
               var pos = idList.indexOf(",");
               while (pos!=-1)   {
                  if (cbValue(table+"|"+idList.substr(pointer,pos-pointer))) {
                     list+=idList.substr(pointer,pos-pointer)+",";
                  }
                  pointer=pos+1;
                  pos = idList.indexOf(",",pointer);
               }
               if (cbValue(table+"|"+idList.substr(pointer))) {
                  list+=idList.substr(pointer)+",";
               }

               return list ? list : idList;
            }

            if (top.fsMod) top.fsMod.recentIds["web"] = '.intval($this->id).';
         ');

            // Setting up the context sensitive menu:
         $CMparts=$this->doc->getContextMenuCode();
         $this->doc->bodyTagAdditions = $CMparts[1];
         $this->doc->JScode.=$CMparts[0];
         $this->doc->postCode.= $CMparts[2];
      } // access



         // Begin to compile the whole page, starting out with page header:
      $this->content='';
      $this->content.=$this->doc->startPage('DB list');
      $this->content.= '<form action="'.htmlspecialchars($dblist->listURL()).'" method="post" name="dblistForm">';

         // List Module CSH:
      if (!strlen($this->id)) {
         $this->content.= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'list_module_noId', $GLOBALS['BACK_PATH'],'<br/>|');
      } elseif (!$this->id)   {  // zero...:
         $this->content.= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'list_module_root', $GLOBALS['BACK_PATH'],'<br/>|');
      }

         // Add listing HTML code:
      $this->content.= $dblist->HTMLcode;
      $this->content.= '<input type="hidden" name="cmd_table" /><input type="hidden" name="cmd" /></form>';

         // List Module CSH:
      if ($this->id) {
         $this->content.= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'list_module', $GLOBALS['BACK_PATH'],'<br/>|');
      }


         // If a listing was produced, create the page footer with search form etc:
      if ($dblist->HTMLcode)  {

            // Making field select box (when extended view for a single table is enabled):
         if ($dblist->table)  {
            $this->content.=$dblist->fieldSelectBox($dblist->table);
         }

            // Adding checkbox options for extended listing and clipboard display:
         $this->content.='

               <!--
                  Listing options for clipboard and thumbnails
               -->
               <div id="typo3-listOptions">
                  <form action="" method="post">';

         $this->content.=t3lib_BEfunc::getFuncCheck($this->id,'SET[bigControlPanel]',$this->MOD_SETTINGS['bigControlPanel'],'db_list.php','').' '.$LANG->getLL('largeControl',1).'<br />';
         if ($dblist->showClipboard)   {
            $this->content.=t3lib_BEfunc::getFuncCheck($this->id,'SET[clipBoard]',$this->MOD_SETTINGS['clipBoard'],'db_list.php','').' '.$LANG->getLL('showClipBoard',1).'<br />';
         }
         $this->content.=t3lib_BEfunc::getFuncCheck($this->id,'SET[localization]',$this->MOD_SETTINGS['localization'],'db_list.php','').' '.$LANG->getLL('localization',1).'<br />';
         $this->content.='
                  </form>
               </div>';
         $this->content.= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'list_options', $GLOBALS['BACK_PATH']);

            // Printing clipboard if enabled:
         if ($this->MOD_SETTINGS['clipBoard'] && $dblist->showClipboard)   {
            $this->content.= $dblist->clipObj->printClipboard();
            $this->content.= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'list_clipboard', $GLOBALS['BACK_PATH']);
         }

            // Link for creating new records:
         if (!$this->modTSconfig['properties']['noCreateRecordsLink'])  {
            $this->content.='

               <!--
                  Link for creating a new record:
               -->
               <div id="typo3-newRecordLink">
               <a href="'.htmlspecialchars('db_new.php?id='.$this->id.'&returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'))).'">'.
                        '<img'.t3lib_iconWorks::skinImg($this->doc->backPath,'gfx/new_el.gif','width="11" height="12"').' alt="" />'.
                        $LANG->getLL('newRecordGeneral',1).
                        '</a>
               </div>';
         }

            // Search box:
         $this->content.=$dblist->getSearchBox();

            // Display sys-notes, if any are found:
         $this->content.=$dblist->showSysNotesForPage();

            // ShortCut:
         if ($BE_USER->mayMakeShortcut()) {
            $this->content.='<br/>'.$this->doc->makeShortcutIcon('id,imagemode,pointer,table,search_field,search_levels,showLimit,sortField,sortRev',implode(',',array_keys($this->MOD_MENU)),$this->MCONF['name']);
         }
      }

         // Finally, close off the page:
      $this->content.= $this->doc->endPage();
   }

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

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












// Make instance:
$SOBE = t3lib_div::makeInstance('SC_db_list');
$SOBE->init();

// Include files?
foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE);

$SOBE->clearCache();
$SOBE->main();
$SOBE->printContent();
?>

---