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