[FEATURE] Add error message for missing TCA
[Packages/TYPO3.CMS.git] / typo3 / class.db_list.inc
1 <?php
2 /***************************************************************
3 *  Copyright notice
4 *
5 *  (c) 1999-2009 Kasper Skårhøj (kasperYYYY@typo3.com)
6 *  All rights reserved
7 *
8 *  This script is part of the TYPO3 project. The TYPO3 project is
9 *  free software; you can redistribute it and/or modify
10 *  it under the terms of the GNU General Public License as published by
11 *  the Free Software Foundation; either version 2 of the License, or
12 *  (at your option) any later version.
13 *
14 *  The GNU General Public License can be found at
15 *  http://www.gnu.org/copyleft/gpl.html.
16 *  A copy is found in the textfile GPL.txt and important notices to the license
17 *  from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 *  This script is distributed in the hope that it will be useful,
21 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
22 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23 *  GNU General Public License for more details.
24 *
25 *  This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28  * Include file extending t3lib_recordList
29  * Shared between Web>List (db_list.php) and Web>Page (sysext/cms/layout/db_layout.php)
30  *
31  * Revised for TYPO3 3.6 December/2003 by Kasper Skårhøj
32  * XHTML compliant
33  *
34  * @author      Kasper Skårhøj <kasperYYYY@typo3.com>
35  */
36
37
38
39
40
41
42
43
44
45
46
47 /**
48  * Child class for rendering of Web > List (not the final class. see class.db_list_extra)
49  *
50  * @author      Kasper Skårhøj <kasperYYYY@typo3.com>
51  * @package TYPO3
52  * @subpackage core
53  * @see localRecordList
54  */
55 class recordList extends t3lib_recordList {
56
57                 // External, static:
58         var $tableList='';                              // Specify a list of tables which are the only ones allowed to be displayed.
59         var $returnUrl='';                              // Return URL
60         var $thumbs = 0;                                // Boolean. Thumbnails on records containing files (pictures)
61         var $itemsLimitPerTable = 20;                   // default Max items shown per table in "multi-table mode", may be overridden by tables.php
62         var $itemsLimitSingleTable = 100;               // default Max items shown per table in "single-table mode", may be overridden by tables.php
63         var $widthGif = '<img src="clear.gif" width="1" height="4" hspace="160" alt="" />';
64         var $script = 'index.php';                      // Current script name
65         var $allFields=0;                               // Indicates if all available fields for a user should be selected or not.
66         var $localizationView=FALSE;                    // Whether to show localization view or not.
67
68                 // Internal, static: GPvar:
69         var $csvOutput=FALSE;                           // If set, csvList is outputted.
70         var $sortField;                                 // Field, to sort list by
71         var $sortRev;                                   // Field, indicating to sort in reverse order.
72         var $displayFields;                             // Array, containing which fields to display in extended mode
73         var $duplicateField;                            // String, can contain the field name from a table which must have duplicate values marked.
74
75                 // Internal, static:
76         var $id;                                        // Page id
77         var $table='';                                  // Tablename if single-table mode
78         var $listOnlyInSingleTableMode=FALSE;           // If TRUE, records are listed only if a specific table is selected.
79         var $firstElementNumber=0;                      // Pointer for browsing list
80         var $searchString='';                           // Search string
81         var $searchLevels='';                           // Levels to search down.
82         var $showLimit=0;                               // Number of records to show
83         var $pidSelect='';                              // List of ids from which to select/search etc. (when search-levels are set high). See start()
84         var $perms_clause='';                           // Page select permissions
85         var $calcPerms=0;                               // Some permissions...
86         var $clickTitleMode = '';                       // Mode for what happens when a user clicks the title of a record.
87         var $modSharedTSconfig = array();               // Shared module configuration, used by localization features
88         var $pageRecord = array();              // Loaded with page record with version overlay if any.
89         var $hideTables = '';                   // Tables which should not get listed
90
91         /**
92          * Tables which should not list their translations
93          * @var $hideTranslations string
94          */
95         public $hideTranslations = '';
96
97         var $tableTSconfigOverTCA = array(); //TSconfig which overwrites TCA-Settings
98         var $tablesCollapsed = array(); // Array of collapsed / uncollapsed tables in multi table view
99
100                 // Internal, dynamic:
101         var $JScode = '';                               // JavaScript code accumulation
102         var $HTMLcode = '';                             // HTML output
103         var $iLimit=0;                                  // "LIMIT " in SQL...
104         var $eCounter=0;                                // Counting the elements no matter what...
105         var $totalItems='';                             // Set to the total number of items for a table when selecting.
106         var $recPath_cache=array();                     // Cache for record path
107         var $setFields=array();                         // Fields to display for the current table
108         var $currentTable = array();                    // Used for tracking next/prev uids
109         var $duplicateStack=array();                    // Used for tracking duplicate values of fields
110
111         var $modTSconfig;                               // module configuratio
112
113
114
115         /**
116          * Initializes the list generation
117          *
118          * @param       integer         Page id for which the list is rendered. Must be >= 0
119          * @param       string          Tablename - if extended mode where only one table is listed at a time.
120          * @param       integer         Browsing pointer.
121          * @param       string          Search word, if any
122          * @param       integer         Number of levels to search down the page tree
123          * @param       integer         Limit of records to be listed.
124          * @return      void
125          */
126         function start($id,$table,$pointer,$search="",$levels="",$showLimit=0)  {
127
128                         // Setting internal variables:
129                 $this->id=intval($id);                                  // sets the parent id
130                 if ($GLOBALS['TCA'][$table]) {
131                                 // Setting single table mode, if table exists:
132                         $this->table = $table;
133                 }
134                 $this->firstElementNumber=$pointer;
135                 $this->searchString=trim($search);
136                 $this->searchLevels=trim($levels);
137                 $this->showLimit=t3lib_utility_Math::forceIntegerInRange($showLimit,0,10000);
138
139                         // Setting GPvars:
140                 $this->csvOutput = t3lib_div::_GP('csv') ? TRUE : FALSE;
141                 $this->sortField = t3lib_div::_GP('sortField');
142                 $this->sortRev = t3lib_div::_GP('sortRev');
143                 $this->displayFields = t3lib_div::_GP('displayFields');
144                 $this->duplicateField = t3lib_div::_GP('duplicateField');
145
146                 if (t3lib_div::_GP('justLocalized'))    {
147                         $this->localizationRedirect(t3lib_div::_GP('justLocalized'));
148                 }
149
150                         // If thumbnails are disabled, set the "notfound" icon as default:
151                 if (!$GLOBALS['TYPO3_CONF_VARS']['GFX']['thumbnails'])  {
152                         $this->thumbScript='gfx/notfound_thumb.gif';
153                 }
154
155                         // Init dynamic vars:
156                 $this->counter=0;
157                 $this->JScode='';
158                 $this->HTMLcode='';
159
160                         // limits
161                 if(isset($this->modTSconfig['properties']['itemsLimitPerTable'])) {
162                         $this->itemsLimitPerTable = t3lib_utility_Math::forceIntegerInRange(intval($this->modTSconfig['properties']['itemsLimitPerTable']), 1, 10000);
163                 }
164                 if(isset($this->modTSconfig['properties']['itemsLimitSingleTable'])) {
165                         $this->itemsLimitSingleTable = t3lib_utility_Math::forceIntegerInRange(intval($this->modTSconfig['properties']['itemsLimitSingleTable']), 1, 10000);
166                 }
167
168                         // Set search levels:
169                 $searchLevels = intval($this->searchLevels);
170                 $this->perms_clause = $GLOBALS['BE_USER']->getPagePermsClause(1);
171
172                         // this will hide records from display - it has nothing todo with user rights!!
173                 if ($pidList = $GLOBALS['BE_USER']->getTSConfigVal('options.hideRecords.pages')) {
174                         if ($pidList = $GLOBALS['TYPO3_DB']->cleanIntList($pidList)) {
175                                 $this->perms_clause .= ' AND pages.uid NOT IN ('.$pidList.')';
176                         }
177                 }
178
179                 // Get configuration of collapsed tables from user uc and merge with sanitized GP vars
180                 $this->tablesCollapsed = is_array($GLOBALS['BE_USER']->uc['moduleData']['list']) ? $GLOBALS['BE_USER']->uc['moduleData']['list'] : array();
181                 $collapseOverride = t3lib_div::_GP('collapse');
182                 if (is_array($collapseOverride)) {
183                         foreach($collapseOverride as $collapseTable => $collapseValue) {
184                                 if (is_array($GLOBALS['TCA'][$collapseTable]) && ($collapseValue == 0 || $collapseValue == 1)) {
185                                         $this->tablesCollapsed[$collapseTable] = $collapseValue;
186                                 }
187                         }
188                         // Save modified user uc
189                         $GLOBALS['BE_USER']->uc['moduleData']['list'] = $this->tablesCollapsed;
190                         $GLOBALS['BE_USER']->writeUC($GLOBALS['BE_USER']->uc);
191                         if (t3lib_div::sanitizeLocalUrl(t3lib_div::_GP('returnUrl'))) {
192                                 $location = t3lib_div::sanitizeLocalUrl(t3lib_div::_GP('returnUrl'));
193                                 t3lib_utility_Http::redirect($location);
194                         }
195                 }
196
197                 if ($searchLevels > 0) {
198                         $tree = $this->getTreeObject($this->id, $searchLevels, $this->perms_clause);
199                         $pidList = implode(',', $GLOBALS['TYPO3_DB']->cleanIntArray($tree->ids));
200                         $this->pidSelect = 'pid IN (' . $pidList . ')';
201                 } elseif ($searchLevels < 0) {
202                                 // Search everywhere
203                         $this->pidSelect = '1=1';
204                 } else {
205                         $this->pidSelect = 'pid=' . intval($id);
206                 }
207
208                         // Initialize languages:
209                 if ($this->localizationView)    {
210                         $this->initializeLanguages();
211                 }
212         }
213
214         /**
215          * Traverses the table(s) to be listed and renders the output code for each:
216          * The HTML is accumulated in $this->HTMLcode
217          * Finishes off with a stopper-gif
218          *
219          * @return      void
220          */
221         function generateList() {
222
223                         // Set page record in header
224                 $this->pageRecord = t3lib_BEfunc::getRecordWSOL('pages',$this->id);
225
226                         // Traverse the TCA table array:
227                 foreach ($GLOBALS['TCA'] as $tableName => $value) {
228
229                                 // Checking if the table should be rendered:
230                         if ((!$this->table || $tableName==$this->table) && (!$this->tableList || t3lib_div::inList($this->tableList,$tableName)) && $GLOBALS['BE_USER']->check('tables_select',$tableName))     {               // Checks that we see only permitted/requested tables:
231
232                                         // Load full table definitions:
233                                 t3lib_div::loadTCA($tableName);
234
235                                         // Don't show table if hidden by TCA ctrl section
236                                 $hideTable = $GLOBALS['TCA'][$tableName]['ctrl']['hideTable'] ? TRUE : FALSE;
237                                         // Don't show table if hidden by pageTSconfig mod.web_list.hideTables
238                                 if (in_array($tableName, t3lib_div::trimExplode(',', $this->hideTables))) {
239                                         $hideTable = TRUE;
240                                 }
241                                         // Override previous selection if table is enabled or hidden by TSconfig TCA override mod.web_list.table
242                                 if (isset($this->tableTSconfigOverTCA[$tableName.'.']['hideTable'])) {
243                                         $hideTable = $this->tableTSconfigOverTCA[$tableName.'.']['hideTable'] ? TRUE : FALSE;
244                                 }
245                                 if ($hideTable) {
246                                         continue;
247                                 }
248
249                                         // iLimit is set depending on whether we're in single- or multi-table mode
250                                 if ($this->table)       {
251                                         $this->iLimit= (isset($GLOBALS['TCA'][$tableName]['interface']['maxSingleDBListItems'])
252                                                 ? intval($GLOBALS['TCA'][$tableName]['interface']['maxSingleDBListItems']) :
253                                                 $this->itemsLimitSingleTable);
254                                 } else {
255                                         $this->iLimit = (isset($GLOBALS['TCA'][$tableName]['interface']['maxDBListItems'])
256                                                 ? intval($GLOBALS['TCA'][$tableName]['interface']['maxDBListItems'])
257                                                 : $this->itemsLimitPerTable);
258                                 }
259                                 if ($this->showLimit)   $this->iLimit = $this->showLimit;
260
261                                         // Setting fields to select:
262                                 if ($this->allFields)   {
263                                         $fields = $this->makeFieldList($tableName);
264                                         $fields[]='tstamp';
265                                         $fields[]='crdate';
266                                         $fields[]='_PATH_';
267                                         $fields[]='_CONTROL_';
268                                         if (is_array($this->setFields[$tableName]))     {
269                                                 $fields = array_intersect($fields,$this->setFields[$tableName]);
270                                         } else {
271                                                 $fields = array();
272                                         }
273                                 } else {
274                                         $fields = array();
275                                 }
276
277                                         // Find ID to use (might be different for "versioning_followPages" tables)
278                                 if (intval($this->searchLevels)==0)     {
279                                         if ($GLOBALS['TCA'][$tableName]['ctrl']['versioning_followPages'] && $this->pageRecord['_ORIG_pid'] == -1
280                                                 && $this->pageRecord['t3ver_swapmode'] == 0) {
281                                                 $this->pidSelect = 'pid='.intval($this->pageRecord['_ORIG_uid']);
282                                         } else {
283                                                 $this->pidSelect = 'pid='.intval($this->id);
284                                         }
285                                 }
286
287                                         // Finally, render the list:
288                                 $this->HTMLcode.=$this->getTable($tableName, $this->id, implode(',',$fields));
289                         }
290                 }
291         }
292
293         /**
294          * Creates the search box
295          *
296          * @param       boolean         If TRUE, the search box is wrapped in its own form-tags
297          * @return      string          HTML for the search box
298          */
299         function getSearchBox($formFields=1)    {
300
301                         // Setting form-elements, if applicable:
302                 $formElements=array('','');
303                 if ($formFields)        {
304                         $formElements = array('<form action="' . htmlspecialchars($this->listURL('', -1, 'firstElementNumber')) . '" method="post">', '</form>');
305                 }
306
307                         // Make level selector:
308                 $opt=array();
309                 $parts = explode('|',$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.enterSearchLevels'));
310                 foreach ($parts as $kv => $label) {
311                         $opt[] = '<option value="'.$kv.'"'.($kv==intval($this->searchLevels)?' selected="selected"':'').'>'.htmlspecialchars($label).'</option>';
312                 }
313                 $lMenu = '<select name="search_levels">'.implode('',$opt).'</select>';
314
315                         // Table with the search box:
316                 $content.= '
317                         '.$formElements[0].'
318
319                                 <!--
320                                         Search box:
321                                 -->
322                                 <table border="0" cellpadding="0" cellspacing="0" id="typo3-dblist-search">
323                                         <tr>
324                                                 <td><label for="search_field">' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.enterSearchString', 1) . '</label><input type="text" name="search_field" id="search_field" value="' . htmlspecialchars($this->searchString) . '"' . $GLOBALS['TBE_TEMPLATE']->formWidth(10) . ' /></td>
325                                                 <td>' . $lMenu . '</td>
326                                                 <td><input type="submit" name="search" value="' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.search', 1) . '" /></td>
327                                         </tr>
328                                         <tr>
329                                                 <td colspan="3"><label for="showLimit">' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.showRecords', 1) . '</label>:<input type="text" name="showLimit" id="showLimit" value="' . htmlspecialchars($this->showLimit ? $this->showLimit : '') . '"' . $GLOBALS['TBE_TEMPLATE']->formWidth(4) . ' /></td>
330                                         </tr>
331                                 </table>
332                         '.$formElements[1];
333                 return $content;
334         }
335
336         /**
337          * Creates the display of sys_notes for the page.
338          * Relies on the "sys_note" extension to be loaded.
339          *
340          * @return      string          HTML for the sys-notes (if any)
341          */
342         function showSysNotesForPage()  {
343                 $out='';
344
345                         // Checking if extension is loaded:
346                 if (!t3lib_extMgm::isLoaded('sys_note'))        return '';
347
348                         // Create query for selecting the notes:
349                 $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*','sys_note','pid IN ('.$this->id.') AND (personal=0 OR cruser='.intval($GLOBALS['BE_USER']->user['uid']).')'.t3lib_BEfunc::deleteClause('sys_note').t3lib_BEfunc::versioningPlaceholderClause('sys_note'));
350
351                         // Executing query:
352                 $dbCount = $GLOBALS['TYPO3_DB']->sql_num_rows($result);
353
354                         // If some notes were found, render them:
355                 if ($dbCount)   {
356                         $cat = array();
357
358                                 // Load full table description:
359                         t3lib_div::loadTCA('sys_note');
360
361                                 // Traverse note-types and get labels:
362                         if ($GLOBALS['TCA']['sys_note'] && $GLOBALS['TCA']['sys_note']['columns']['category']
363                                 && is_array($GLOBALS['TCA']['sys_note']['columns']['category']['config']['items'])) {
364                                 foreach($GLOBALS['TCA']['sys_note']['columns']['category']['config']['items'] as $el) {
365                                         $cat[$el[1]]=$GLOBALS['LANG']->sL($el[0]);
366                                 }
367                         }
368
369                                 // For each note found, make rendering:
370                         while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result))    {
371
372                                         // Create content:
373                                 $iconImg = t3lib_iconWorks::getSpriteIconForRecord('sys_note', $row);
374                                 $subject = htmlspecialchars($row['subject']);
375                                 $fields = array();
376                                 $fields['Author:'] = htmlspecialchars($row['author'].($row['email'] && $row['author'] ? ', ':'').$row['email']);
377                                 $fields['Category:'] = htmlspecialchars($cat[$row['category']]);
378                                 $fields['Note:'] = nl2br(htmlspecialchars($row['message']));
379
380                                         // Compile content:
381                                 $out.='
382
383
384                                 <!--
385                                         Sys-notes for list module:
386                                 -->
387                                         <table border="0" cellpadding="1" cellspacing="1" id="typo3-dblist-sysnotes">
388                                                 <tr><td colspan="2" class="bgColor2">'.$iconImg.'<strong>'.$subject.'</strong></td></tr>
389                                                 <tr><td class="bgColor4">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.category',1).'</td><td class="bgColor4">'.$fields['Category:'].'</td></tr>
390                                                 <tr><td class="bgColor4">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.author',1).'</td><td class="bgColor4">'.$fields['Author:'].'</td></tr>
391                                                 <tr><td class="bgColor4">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.note',1).'</td><td class="bgColor4">'.$fields['Note:'].'</td></tr>
392                                         </table>
393                                 ';
394                         }
395                 }
396                 return $out;
397         }
398
399
400
401
402
403
404
405
406         /******************************
407          *
408          * Various helper functions
409          *
410          ******************************/
411
412         /**
413          * Setting the field names to display in extended list.
414          * Sets the internal variable $this->setFields
415          *
416          * @return      void
417          */
418         function setDispFields()        {
419
420                         // Getting from session:
421                 $dispFields = $GLOBALS['BE_USER']->getModuleData('list/displayFields');
422
423                         // If fields has been inputted, then set those as the value and push it to session variable:
424                 if (is_array($this->displayFields))     {
425                         reset($this->displayFields);
426                         $tKey = key($this->displayFields);
427                         $dispFields[$tKey]=$this->displayFields[$tKey];
428                         $GLOBALS['BE_USER']->pushModuleData('list/displayFields',$dispFields);
429                 }
430
431                         // Setting result:
432                 $this->setFields=$dispFields;
433         }
434
435         /**
436          * Create thumbnail code for record/field
437          *
438          * @param       array           Record array
439          * @param       string          Table (record is from)
440          * @param       string          Field name for which thumbsnail are to be rendered.
441          * @return      string          HTML for thumbnails, if any.
442          */
443         function thumbCode($row,$table,$field)  {
444                 return t3lib_BEfunc::thumbCode($row,$table,$field,$this->backPath,$this->thumbScript);
445         }
446
447         /**
448          * Returns the SQL-query array to select the records from a table $table with pid = $id
449          *
450          * @param       string          Table name
451          * @param       integer         Page id (NOT USED! $this->pidSelect is used instead)
452          * @param       string          Additional part for where clause
453          * @param       string          Field list to select, * for all (for "SELECT [fieldlist] FROM ...")
454          * @return      array           Returns query array
455          */
456         function makeQueryArray($table, $id, $addWhere='', $fieldList='*')      {
457                 $hookObjectsArr = array();
458                 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list.inc']['makeQueryArray'])) {
459                         foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list.inc']['makeQueryArray'] as $classRef) {
460                                 $hookObjectsArr[] = t3lib_div::getUserObj($classRef);
461                         }
462                 }
463
464                         // Set ORDER BY:
465                 $orderBy = ($GLOBALS['TCA'][$table]['ctrl']['sortby']
466                         ? 'ORDER BY ' . $GLOBALS['TCA'][$table]['ctrl']['sortby']
467                         : $GLOBALS['TCA'][$table]['ctrl']['default_sortby']);
468                 if ($this->sortField)   {
469                         if (in_array($this->sortField,$this->makeFieldList($table,1)))  {
470                                 $orderBy = 'ORDER BY '.$this->sortField;
471                                 if ($this->sortRev)     $orderBy.=' DESC';
472                         }
473                 }
474
475                         // Set LIMIT:
476                 $limit = $this->iLimit ? ($this->firstElementNumber ? $this->firstElementNumber.',' : '').($this->iLimit+1) : '';
477
478                         // Filtering on displayable pages (permissions):
479                 $pC = ($table=='pages' && $this->perms_clause)?' AND '.$this->perms_clause:'';
480
481                         // Adding search constraints:
482                 $search = $this->makeSearchString($table, $id);
483
484                         // Compiling query array:
485                 $queryParts = array(
486                         'SELECT' => $fieldList,
487                         'FROM' => $table,
488                         'WHERE' => $this->pidSelect.
489                                                 ' '.$pC.
490                                                 t3lib_BEfunc::deleteClause($table).
491                                                 t3lib_BEfunc::versioningPlaceholderClause($table).
492                                                 ' '.$addWhere.
493                                                 ' '.$search,
494                         'GROUPBY' => '',
495                         'ORDERBY' => $GLOBALS['TYPO3_DB']->stripOrderBy($orderBy),
496                         'LIMIT' => $limit
497                 );
498
499                         // Filter out records that are translated, if TSconfig mod.web_list.hideTranslations is set
500                 if ((in_array($table, t3lib_div::trimExplode(',', $this->hideTranslations)) || $this->hideTranslations === '*')
501                         && !empty($GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'])
502                         && strcmp($table, 'pages_language_overlay')) {
503                         $queryParts['WHERE'] .= ' AND ' . $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'] . '=0 ';
504                 }
505
506                         // Apply hook as requested in http://bugs.typo3.org/view.php?id=4361
507                 foreach ($hookObjectsArr as $hookObj) {
508                         if (method_exists($hookObj, 'makeQueryArray_post')) {
509                                 $_params = array(
510                                         'orderBy' => $orderBy,
511                                         'limit' => $limit,
512                                         'pC' => $pC,
513                                         'search' => $search,
514                                 );
515                                 $hookObj->makeQueryArray_post($queryParts, $this, $table, $id, $addWhere, $fieldList, $_params);
516                         }
517                 }
518
519                         // Return query:
520                 return $queryParts;
521         }
522
523         /**
524          * Based on input query array (query for selecting count(*) from a table) it will select the number of records and set the value in $this->totalItems
525          *
526          * @param       array           Query array
527          * @return      void
528          * @see makeQueryArray()
529          */
530         function setTotalItems($queryParts)     {
531                 $this->totalItems = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows(
532                         '*',
533                         $queryParts['FROM'],
534                         $queryParts['WHERE']
535                 );
536         }
537
538         /**
539          * Creates part of query for searching after a word ($this->searchString)
540          * fields in input table.
541          *
542          * @param string $table Table, in which the fields are being searched.
543          * @param integer $currentPid Page id for the possible search limit. -1 only if called from an old XCLASS.
544          * @return string Returns part of WHERE-clause for searching, if applicable.
545          */
546         function makeSearchString($table, $currentPid = -1) {
547                 $result = '';
548
549                 $currentPid = intval($currentPid);
550                 $tablePidField = ($table == 'pages' ? 'uid' : 'pid');
551
552                         // Make query, only if table is valid and a search string is actually defined:
553                 if ($this->searchString) {
554                         $result = ' AND 0=1';
555                         $searchableFields = $this->getSearchFields($table);
556                         if (count($searchableFields) > 0) {
557                                         // Loading full table description - we need to traverse fields:
558                                 t3lib_div::loadTCA($table);
559
560                                 if (t3lib_utility_Math::canBeInterpretedAsInteger($this->searchString)) {
561                                         $whereParts = array(
562                                                 'uid=' . $this->searchString
563                                         );
564
565                                         foreach($searchableFields as $fieldName)        {
566                                                 if (isset($GLOBALS['TCA'][$table]['columns'][$fieldName])) {
567                                                         $fieldConfig = &$GLOBALS['TCA'][$table]['columns'][$fieldName]['config'];
568                                                         if ($fieldConfig['type'] == 'input' && $fieldConfig['eval'] && t3lib_div::inList($fieldConfig['eval'], 'int')) {
569                                                                 $condition = $fieldName . '=' . $this->searchString;
570                                                                 if (is_array($fieldConfig['search']) && in_array('pidonly', $fieldConfig['search']) && $currentPid > 0) {
571                                                                         $condition = '(' . $condition . ' AND ' . $tablePidField . '=' . $currentPid . ')';
572                                                                 }
573                                                                 $whereParts[] = $condition;
574                                                         }
575                                                 }
576                                         }
577                                 } else {
578                                         $whereParts = array();
579                                         $like = '\'%' .
580                                                 $GLOBALS['TYPO3_DB']->quoteStr($GLOBALS['TYPO3_DB']->escapeStrForLike($this->searchString, $table), $table) .
581                                                 '%\'';
582                                         foreach($searchableFields as $fieldName) {
583                                                 if (isset($GLOBALS['TCA'][$table]['columns'][$fieldName])) {
584                                                         $fieldConfig = &$GLOBALS['TCA'][$table]['columns'][$fieldName]['config'];
585                                                         $format = 'LCASE(%s) LIKE LCASE(%s)';
586                                                         if (is_array($fieldConfig['search'])) {
587                                                                 if (in_array('case', $fieldConfig['search'])) {
588                                                                         $format = '%s LIKE %s';
589                                                                 }
590                                                                 if (in_array('pidonly', $fieldConfig['search']) && $currentPid > 0) {
591                                                                         $format = '(' . $format . ' AND ' . $tablePidField . '=' . $currentPid . ')';
592                                                                 }
593                                                                 if ($fieldConfig['search']['andWhere']) {
594                                                                         $format = '((' . $fieldConfig['search']['andWhere'] . ') AND (' . $format . '))';
595                                                                 }
596                                                         }
597                                                         if ($fieldConfig['type'] == 'text' ||
598                                                                         $fieldConfig['type'] == 'flex' ||
599                                                                         ($fieldConfig['type'] == 'input' && (!$fieldConfig['eval'] || !preg_match('/date|time|int/',$fieldConfig['eval'])))) {
600                                                                 $whereParts[] = sprintf($format, $fieldName, $like);
601                                                         }
602                                                 }
603                                         }
604                                 }
605
606                                         // If search-fields were defined (and there always are) we create the query:
607                                 if (count($whereParts)) {
608                                         $result = ' AND (' . implode(' OR ', $whereParts) . ')';
609                                 }
610                         }
611                 }
612                 return $result;
613         }
614
615         /**
616          * Fetches a list of fields to use in the Backend search for the given table.
617          *
618          * @param string $tableName
619          * @return array
620          */
621         protected function getSearchFields($tableName) {
622                 $fieldArray = array();
623                 $fieldListWasSet = FALSE;
624
625                         // Get fields from ctrl section of TCA first
626                 if (isset($GLOBALS['TCA'][$tableName]['ctrl']['searchFields'])) {
627                         $fieldArray = t3lib_div::trimExplode(',', $GLOBALS['TCA'][$tableName]['ctrl']['searchFields'], TRUE);
628                         $fieldListWasSet = TRUE;
629                 }
630
631                         // Call hook to add or change the list
632                 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['mod_list']['getSearchFieldList']))      {
633                         $hookParameters = array(
634                                 'tableHasSearchConfiguration' => $fieldListWasSet,
635                                 'tableName' => $tableName,
636                                 'searchFields' => &$fieldArray,
637                                 'searchString' => $this->searchString
638                         );
639                         foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['mod_list']['getSearchFieldList'] as $hookFunction)  {
640                                 t3lib_div::callUserFunction($hookFunction, $hookParameters, $this);
641                         }
642                 }
643
644                 return $fieldArray;
645         }
646
647         /**
648          * Returns the title (based on $code) of a table ($table) with the proper link around. For headers over tables.
649          * The link will cause the display of all extended mode or not for the table.
650          *
651          * @param       string          Table name
652          * @param       string          Table label
653          * @return      string          The linked table label
654          */
655         function linkWrapTable($table,$code)    {
656                 if ($this->table!=$table)       {
657                         return '<a href="' . htmlspecialchars($this->listURL('', $table, 'firstElementNumber')) . '">' . $code . '</a>';
658                 } else {
659                         return '<a href="' . htmlspecialchars($this->listURL('', '', 'sortField,sortRev,table,firstElementNumber')) . '">' . $code . '</a>';
660                 }
661         }
662
663         /**
664          * 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...)
665          *
666          * @param       string          Table name
667          * @param       integer         Item uid
668          * @param       string          Item title (not htmlspecialchars()'ed yet)
669          * @param       array           Item row
670          * @return      string          The item title. Ready for HTML output (is htmlspecialchars()'ed)
671          */
672         function linkWrapItems($table,$uid,$code,$row)  {
673                 $origCode = $code;
674
675                         // If the title is blank, make a "no title" label:
676                 if (!strcmp($code,'')) {
677                         $code = '<i>['.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.no_title',1).']</i> - '.htmlspecialchars(t3lib_div::fixed_lgd_cs(t3lib_BEfunc::getRecordTitle($table,$row),$GLOBALS['BE_USER']->uc['titleLen']));
678                 } else {
679                         $code = htmlspecialchars(t3lib_div::fixed_lgd_cs($code, $this->fixedL));
680                         if ($code != htmlspecialchars($origCode)) {
681                                 $code = '<span title="'.htmlspecialchars($origCode).'">'.$code.'</span>';
682                         }
683                 }
684
685                 switch((string)$this->clickTitleMode)   {
686                         case 'edit':
687                                         // If the listed table is 'pages' we have to request the permission settings for each page:
688                                 if ($table=='pages')    {
689                                         $localCalcPerms = $GLOBALS['BE_USER']->calcPerms(t3lib_BEfunc::getRecord('pages',$row['uid']));
690                                         $permsEdit = $localCalcPerms&2;
691                                 } else {
692                                         $permsEdit = $this->calcPerms&16;
693                                 }
694
695                                         // "Edit" link: ( Only if permissions to edit the page-record of the content of the parent page ($this->id)
696                                 if ($permsEdit) {
697                                         $params='&edit['.$table.']['.$row['uid'].']=edit';
698                                         $code = '<a href="#" onclick="' . htmlspecialchars(t3lib_BEfunc::editOnClick($params, $this->backPath, -1)) .
699                                                 '" title="' . $GLOBALS['LANG']->getLL('edit', 1) . '">' .
700                                                         $code .
701                                                         '</a>';
702                                 }
703                         break;
704                         case 'show':
705                                         // "Show" link (only pages and tt_content elements)
706                                 if ($table=='pages' || $table=='tt_content')    {
707                                         $code = '<a href="#" onclick="'. htmlspecialchars(t3lib_BEfunc::viewOnClick(
708                                                         $table == 'tt_content' ? $this->id . '#' . $row['uid'] : $row['uid'])
709                                                 ) . '" title="'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.showPage', 1) . '">'.
710                                                 $code. '</a>';
711                                 }
712                         break;
713                         case 'info':
714                                 // "Info": (All records)
715                                 $code = '<a href="#" onclick="'.htmlspecialchars('top.launchView(\'' . $table . '\', \'' . $row['uid'] .
716                                         '\'); return false;') . '" title="'.$GLOBALS['LANG']->getLL('showInfo', 1) . '">' .
717                                         $code.
718                                         '</a>';
719                         break;
720                         default:
721                                         // Output the label now:
722                                 if ($table=='pages')    {
723                                         $code = '<a href="' . htmlspecialchars($this->listURL($uid, '', 'firstElementNumber')) . '" onclick="setHighlight(' . $uid . ')">' . $code . '</a>';
724                                 } else {
725                                         $code = $this->linkUrlMail($code,$origCode);
726                                 }
727                         break;
728                 }
729
730                 return $code;
731         }
732
733         /**
734          * Wrapping input code in link to URL or email if $testString is either.
735          *
736          * @param       string          code to wrap
737          * @param       string          String which is tested for being a URL or email and which will be used for the link if so.
738          * @return      string          Link-Wrapped $code value, if $testString was URL or email.
739          */
740         function linkUrlMail($code,$testString) {
741
742                         // Check for URL:
743                 $schema = parse_url($testString);
744                 if ($schema['scheme'] && t3lib_div::inList('http,https,ftp',$schema['scheme'])) {
745                         return '<a href="'.htmlspecialchars($testString).'" target="_blank">'.$code.'</a>';
746                 }
747
748                         // Check for email:
749                 if (t3lib_div::validEmail($testString)) {
750                         return '<a href="mailto:'.htmlspecialchars($testString).'" target="_blank">'.$code.'</a>';
751                 }
752
753                         // Return if nothing else...
754                 return $code;
755         }
756
757         /**
758          * Creates the URL to this script, including all relevant GPvars
759          * Fixed GPvars are id, table, imagemode, returlUrl, search_field, search_levels and showLimit
760          * The GPvars "sortField" and "sortRev" are also included UNLESS they are found in the $exclList variable.
761          *
762          * @param       string          Alternative id value. Enter blank string for the current id ($this->id)
763          * @param       string          Tablename to display. Enter "-1" for the current table.
764          * @param       string          Commalist of fields NOT to include ("sortField", "sortRev" or "firstElementNumber")
765          * @return      string          URL
766          */
767         function listURL($altId='',$table=-1,$exclList='')      {
768                 $urlParameters = array();
769                 if (strcmp($altId, '')) {
770                         $urlParameters['id'] = $altId;
771                 } else {
772                         $urlParameters['id'] = $this->id;
773                 }
774                 if ($table === -1) {
775                         $urlParameters['table'] = $this->table;
776                 } else {
777                         $urlParameters['table'] = $table;
778                 }
779                 if ($this->thumbs) {
780                         $urlParameters['imagemode'] = $this->thumbs;
781                 }
782                 if ($this->returnUrl) {
783                         $urlParameters['returnUrl'] = $this->returnUrl;
784                 }
785                 if ($this->searchString) {
786                         $urlParameters['search_field'] = $this->searchString;
787                 }
788                 if ($this->searchLevels) {
789                         $urlParameters['search_levels'] = $this->searchLevels;
790                 }
791                 if ($this->showLimit) {
792                         $urlParameters['showLimit'] = $this->showLimit;
793                 }
794                 if ((!$exclList || !t3lib_div::inList($exclList, 'firstElementNumber')) && $this->firstElementNumber) {
795                         $urlParameters['pointer'] = $this->firstElementNumber;
796                 }
797                 if ((!$exclList || !t3lib_div::inList($exclList, 'sortField')) && $this->sortField) {
798                         $urlParameters['sortField'] = $this->sortField;
799                 }
800                 if ((!$exclList || !t3lib_div::inList($exclList, 'sortRev')) && $this->sortRev) {
801                         $urlParameters['sortRev'] = $this->sortRev;
802                 }
803
804                 return t3lib_BEfunc::getModuleUrl('web_list', $urlParameters);
805         }
806
807         /**
808          * Returns "requestUri" - which is basically listURL
809          *
810          * @return      string          Content of ->listURL()
811          */
812         function requestUri()   {
813                 return $this->listURL();
814         }
815
816         /**
817          * Makes the list of fields to select for a table
818          *
819          * @param       string          Table name
820          * @param       boolean         If set, users access to the field (non-exclude-fields) is NOT checked.
821          * @param       boolean         If set, also adds crdate and tstamp fields (note: they will also be added if user is admin or dontCheckUser is set)
822          * @return      array           Array, where values are fieldnames to include in query
823          */
824         function makeFieldList($table,$dontCheckUser=0,$addDateFields=0)        {
825
826                         // Init fieldlist array:
827                 $fieldListArr = array();
828
829                         // Check table:
830                 if (is_array($GLOBALS['TCA'][$table])
831                         && isset($GLOBALS['TCA'][$table]['columns'])
832                         && is_array($GLOBALS['TCA'][$table]['columns'])
833                 ) {
834                         t3lib_div::loadTCA($table);
835
836                                 // Traverse configured columns and add them to field array, if available for user.
837                         foreach($GLOBALS['TCA'][$table]['columns'] as $fN => $fieldValue) {
838                                 if ($dontCheckUser ||
839                                         ((!$fieldValue['exclude'] || $GLOBALS['BE_USER']->check('non_exclude_fields', $table . ':' . $fN))
840                                         && $fieldValue['config']['type']!='passthrough')) {
841                                         $fieldListArr[]=$fN;
842                                 }
843                         }
844
845                                 // Add special fields:
846                         if ($dontCheckUser || $GLOBALS['BE_USER']->isAdmin()) {
847                                 $fieldListArr[]='uid';
848                                 $fieldListArr[]='pid';
849                         }
850
851                                 // Add date fields
852                         if ($dontCheckUser || $GLOBALS['BE_USER']->isAdmin() || $addDateFields) {
853                                 if ($GLOBALS['TCA'][$table]['ctrl']['tstamp']) {
854                                         $fieldListArr[]=$GLOBALS['TCA'][$table]['ctrl']['tstamp'];
855                                 }
856                                 if ($GLOBALS['TCA'][$table]['ctrl']['crdate']) {
857                                         $fieldListArr[]=$GLOBALS['TCA'][$table]['ctrl']['crdate'];
858                                 }
859                         }
860
861                                 // Add more special fields:
862                         if ($dontCheckUser || $GLOBALS['BE_USER']->isAdmin()) {
863                                 if ($GLOBALS['TCA'][$table]['ctrl']['cruser_id']) {
864                                         $fieldListArr[]=$GLOBALS['TCA'][$table]['ctrl']['cruser_id'];
865                                 }
866                                 if ($GLOBALS['TCA'][$table]['ctrl']['sortby']) {
867                                         $fieldListArr[]=$GLOBALS['TCA'][$table]['ctrl']['sortby'];
868                                 }
869                                 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
870                                         $fieldListArr[]='t3ver_id';
871                                         $fieldListArr[]='t3ver_state';
872                                         $fieldListArr[]='t3ver_wsid';
873                                         if ($table==='pages')   {
874                                                 $fieldListArr[]='t3ver_swapmode';
875                                         }
876                                 }
877                         }
878                 }
879                 return $fieldListArr;
880         }
881
882         /**
883          * Creates an instance of t3lib_pageTree which will select a page tree to $depth and return the object. In that object we will find the ids of the tree.
884          *
885          * @param       integer         Page id.
886          * @param       integer         Depth to go down.
887          * @param       string          Select clause
888          * @return      object          t3lib_pageTree instance with created list of ids.
889          */
890         function getTreeObject($id,$depth,$perms_clause)        {
891                 $tree = t3lib_div::makeInstance('t3lib_pageTree');
892                 $tree->init('AND '.$perms_clause);
893                 $tree->makeHTML=0;
894                 $tree->fieldArray = Array('uid','php_tree_stop');
895                 if ($depth)     {
896                         $tree->getTree($id, $depth, '');
897                 }
898                 $tree->ids[]=$id;
899                 return $tree;
900         }
901
902         /**
903          * Redirects to TCEforms (alt_doc) if a record is just localized.
904          *
905          * @param       string          string with table, orig uid and language separated by ":"
906          * @return      void
907          */
908         function localizationRedirect($justLocalized)   {
909                 list($table,$orig_uid,$language) = explode(':',$justLocalized);
910
911                 if ($GLOBALS['TCA'][$table] && $GLOBALS['TCA'][$table]['ctrl']['languageField']
912                         && $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']) {
913                         $localizedRecord = $GLOBALS['TYPO3_DB']->exec_SELECTgetSingleRow(
914                                         'uid',
915                                         $table,
916                                         $GLOBALS['TCA'][$table]['ctrl']['languageField'] . '=' . intval($language) . ' AND ' .
917                                                 $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'] . '=' . intval($orig_uid) .
918                                                 t3lib_BEfunc::deleteClause($table).
919                                                 t3lib_BEfunc::versioningPlaceholderClause($table)
920                                 );
921
922                         if (is_array($localizedRecord)) {
923                                         // Create parameters and finally run the classic page module for creating a new page translation
924                                 $url = substr($this->listURL(), strlen($this->backPath));
925                                 $params = '&edit['.$table.']['.$localizedRecord['uid'].']=edit';
926                                 $returnUrl = '&returnUrl='.rawurlencode($url);
927                                 $location = $GLOBALS['BACK_PATH'].'alt_doc.php?'.$params.$returnUrl;
928
929                                 t3lib_utility_Http::redirect($location);
930                         }
931                 }
932         }
933 }
934
935
936 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/class.db_list.inc'])) {
937         include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/class.db_list.inc']);
938 }
939
940 ?>