Followup to #11148: Remove static require_once() to t3lib and tslib and use autoloadi...
[Packages/TYPO3.CMS.git] / typo3 / db_list.php
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 * Module: Web>List
29 *
30 * Listing database records from the tables configured in $TCA as they are related to the current page or root.
31 *
32 * Notice: This module and Web>Page (db_layout.php) module has a special status since they
33 * are NOT located in their actual module directories (fx. mod/web/list/) but in the
34 * backend root directory. This has some historical and practical causes.
35 *
36 * $Id$
37 * Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj
38 * XHTML compliant
39 *
40 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
41 */
42 /**
43 * [CLASS/FUNCTION INDEX of SCRIPT]
44 *
45 *
46 *
47 * 89: class SC_db_list
48 * 125: function init()
49 * 160: function menuConfig()
50 * 181: function clearCache()
51 * 195: function main()
52 * 451: function printContent()
53 *
54 * TOTAL FUNCTIONS: 5
55 * (This index is automatically created/updated by the extension "extdeveval")
56 *
57 */
58
59
60 unset($MCONF);
61 require ('mod/web/list/conf.php');
62 require ('init.php');
63 require ('template.php');
64 $LANG->includeLLFile('EXT:lang/locallang_mod_web_list.xml');
65 require_once ($BACK_PATH.'class.db_list.inc');
66 require_once ($BACK_PATH.'class.db_list_extra.inc');
67 $BE_USER->modAccess($MCONF,1);
68
69 t3lib_BEfunc::lockRecords();
70
71
72
73
74
75
76
77
78 /**
79 * Script Class for the Web > List module; rendering the listing of records on a page
80 *
81 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
82 * @package TYPO3
83 * @subpackage core
84 */
85 class SC_db_list {
86
87 // Internal, GPvars:
88 var $id; // Page Id for which to make the listing
89 var $pointer; // Pointer - for browsing list of records.
90 var $imagemode; // Thumbnails or not
91 var $table; // Which table to make extended listing for
92 var $search_field; // Search-fields
93 var $search_levels; // Search-levels
94 var $showLimit; // Show-limit
95 var $returnUrl; // Return URL
96
97 var $clear_cache; // Clear-cache flag - if set, clears page cache for current id.
98 var $cmd; // Command: Eg. "delete" or "setCB" (for TCEmain / clipboard operations)
99 var $cmd_table; // Table on which the cmd-action is performed.
100
101 // Internal, static:
102 var $perms_clause; // Page select perms clause
103 var $modTSconfig; // Module TSconfig
104 var $pageinfo; // Current ids page record
105
106 /**
107 * Document template object
108 *
109 * @var template
110 */
111 var $doc;
112
113 var $MCONF=array(); // Module configuration
114 var $MOD_MENU=array(); // Menu configuration
115 var $MOD_SETTINGS=array(); // Module settings (session variable)
116 var $include_once=array(); // Array, where files to include is accumulated in the init() function
117
118 // Internal, dynamic:
119 var $content; // Module output accumulation
120
121
122 /**
123 * Initializing the module
124 *
125 * @return void
126 */
127 function init() {
128 global $BE_USER;
129
130 // Setting module configuration / page select clause
131 $this->MCONF = $GLOBALS['MCONF'];
132 $this->perms_clause = $BE_USER->getPagePermsClause(1);
133
134 // GPvars:
135 $this->id = t3lib_div::_GP('id');
136 $this->pointer = t3lib_div::_GP('pointer');
137 $this->imagemode = t3lib_div::_GP('imagemode');
138 $this->table = t3lib_div::_GP('table');
139 $this->search_field = t3lib_div::_GP('search_field');
140 $this->search_levels = t3lib_div::_GP('search_levels');
141 $this->showLimit = t3lib_div::_GP('showLimit');
142 $this->returnUrl = t3lib_div::_GP('returnUrl');
143
144 $this->clear_cache = t3lib_div::_GP('clear_cache');
145 $this->cmd = t3lib_div::_GP('cmd');
146 $this->cmd_table = t3lib_div::_GP('cmd_table');
147
148 // Initialize menu
149 $this->menuConfig();
150
151 // Inclusions?
152 if ($this->clear_cache || $this->cmd=='delete') {
153 $this->include_once[]=PATH_t3lib.'class.t3lib_tcemain.php';
154 }
155 }
156
157 /**
158 * Initialize function menu array
159 *
160 * @return void
161 */
162 function menuConfig() {
163
164 // MENU-ITEMS:
165 $this->MOD_MENU = array(
166 'bigControlPanel' => '',
167 'clipBoard' => '',
168 'localization' => ''
169 );
170
171 // Loading module configuration:
172 $this->modTSconfig = t3lib_BEfunc::getModTSconfig($this->id,'mod.'.$this->MCONF['name']);
173
174 // Clean up settings:
175 $this->MOD_SETTINGS = t3lib_BEfunc::getModuleData($this->MOD_MENU, t3lib_div::_GP('SET'), $this->MCONF['name']);
176 }
177
178 /**
179 * Clears page cache for the current id, $this->id
180 *
181 * @return void
182 */
183 function clearCache() {
184 if ($this->clear_cache) {
185 $tce = t3lib_div::makeInstance('t3lib_TCEmain');
186 $tce->stripslashes_values=0;
187 $tce->start(Array(),Array());
188 $tce->clear_cacheCmd($this->id);
189 }
190 }
191
192 /**
193 * Main function, starting the rendering of the list.
194 *
195 * @return void
196 */
197 function main() {
198 global $BE_USER,$LANG,$BACK_PATH,$CLIENT;
199
200 // Start document template object:
201 $this->doc = t3lib_div::makeInstance('template');
202 $this->doc->backPath = $BACK_PATH;
203 $this->doc->setModuleTemplate('templates/db_list.html');
204
205 // Loading current page record and checking access:
206 $this->pageinfo = t3lib_BEfunc::readPageAccess($this->id,$this->perms_clause);
207 $access = is_array($this->pageinfo) ? 1 : 0;
208
209 // Initialize the dblist object:
210 $dblist = t3lib_div::makeInstance('localRecordList');
211 $dblist->backPath = $BACK_PATH;
212 $dblist->calcPerms = $BE_USER->calcPerms($this->pageinfo);
213 $dblist->thumbs = $BE_USER->uc['thumbnailsByDefault'];
214 $dblist->returnUrl=$this->returnUrl;
215 $dblist->allFields = ($this->MOD_SETTINGS['bigControlPanel'] || $this->table) ? 1 : 0;
216 $dblist->localizationView = $this->MOD_SETTINGS['localization'];
217 $dblist->showClipboard = 1;
218 $dblist->disableSingleTableView = $this->modTSconfig['properties']['disableSingleTableView'];
219 $dblist->listOnlyInSingleTableMode = $this->modTSconfig['properties']['listOnlyInSingleTableView'];
220 $dblist->hideTables = $this->modTSconfig['properties']['hideTables'];
221 $dblist->tableTSconfigOverTCA = $this->modTSconfig['properties']['table.'];
222 $dblist->clickTitleMode = $this->modTSconfig['properties']['clickTitleMode'];
223 $dblist->alternateBgColors=$this->modTSconfig['properties']['alternateBgColors']?1:0;
224 $dblist->allowedNewTables = t3lib_div::trimExplode(',', $this->modTSconfig['properties']['allowedNewTables'], 1);
225 $dblist->deniedNewTables = t3lib_div::trimExplode(',', $this->modTSconfig['properties']['deniedNewTables'], 1);
226 $dblist->newWizards=$this->modTSconfig['properties']['newWizards']?1:0;
227 $dblist->pageRow = $this->pageinfo;
228 $dblist->counter++;
229 $dblist->MOD_MENU = array('bigControlPanel' => '', 'clipBoard' => '', 'localization' => '');
230 $dblist->modTSconfig = $this->modTSconfig;
231
232 // Clipboard is initialized:
233 $dblist->clipObj = t3lib_div::makeInstance('t3lib_clipboard'); // Start clipboard
234 $dblist->clipObj->initializeClipboard(); // Initialize - reads the clipboard content from the user session
235
236 // Clipboard actions are handled:
237 $CB = t3lib_div::_GET('CB'); // CB is the clipboard command array
238 if ($this->cmd=='setCB') {
239 // 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
240 // This is set to the 'el' array of the CB after being parsed so only the table in question is registered.
241 $CB['el'] = $dblist->clipObj->cleanUpCBC(array_merge((array)t3lib_div::_POST('CBH'),(array)t3lib_div::_POST('CBC')),$this->cmd_table);
242 }
243 if (!$this->MOD_SETTINGS['clipBoard']) $CB['setP']='normal'; // If the clipboard is NOT shown, set the pad to 'normal'.
244 $dblist->clipObj->setCmd($CB); // Execute commands.
245 $dblist->clipObj->cleanCurrent(); // Clean up pad
246 $dblist->clipObj->endClipboard(); // Save the clipboard content
247
248 // This flag will prevent the clipboard panel in being shown.
249 // It is set, if the clickmenu-layer is active AND the extended view is not enabled.
250 $dblist->dontShowClipControlPanels = $CLIENT['FORMSTYLE'] && !$this->MOD_SETTINGS['bigControlPanel'] && $dblist->clipObj->current=='normal' && !$BE_USER->uc['disableCMlayers'] && !$this->modTSconfig['properties']['showClipControlPanelsDespiteOfCMlayers'];
251
252
253
254 // If there is access to the page, then render the list contents and set up the document template object:
255 if ($access) {
256
257 // Deleting records...:
258 // 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.
259 if ($this->cmd=='delete') {
260 $items = $dblist->clipObj->cleanUpCBC(t3lib_div::_POST('CBC'),$this->cmd_table,1);
261 if (count($items)) {
262 $cmd=array();
263 reset($items);
264 while(list($iK)=each($items)) {
265 $iKParts = explode('|',$iK);
266 $cmd[$iKParts[0]][$iKParts[1]]['delete']=1;
267 }
268 $tce = t3lib_div::makeInstance('t3lib_TCEmain');
269 $tce->stripslashes_values=0;
270 $tce->start(array(),$cmd);
271 $tce->process_cmdmap();
272
273 if (isset($cmd['pages'])) {
274 t3lib_BEfunc::getSetUpdateSignal('updatePageTree');
275 }
276
277 $tce->printLogErrorMessages(t3lib_div::getIndpEnv('REQUEST_URI'));
278 }
279 }
280
281 // Initialize the listing object, dblist, for rendering the list:
282 $this->pointer = t3lib_div::intInRange($this->pointer,0,100000);
283 $dblist->start($this->id,$this->table,$this->pointer,$this->search_field,$this->search_levels,$this->showLimit);
284 $dblist->setDispFields();
285
286 // Render versioning selector:
287 $dblist->HTMLcode.= $this->doc->getVersionSelector($this->id);
288
289 // Render the list of tables:
290 $dblist->generateList();
291
292 // Write the bottom of the page:
293 $dblist->writeBottom();
294
295 // Add JavaScript functions to the page:
296 $this->doc->JScode=$this->doc->wrapScriptTags('
297 function jumpToUrl(URL) { //
298 window.location.href = URL;
299 return false;
300 }
301 function jumpExt(URL,anchor) { //
302 var anc = anchor?anchor:"";
303 window.location.href = URL+(T3_THIS_LOCATION?"&returnUrl="+T3_THIS_LOCATION:"")+anc;
304 return false;
305 }
306 function jumpSelf(URL) { //
307 window.location.href = URL+(T3_RETURN_URL?"&returnUrl="+T3_RETURN_URL:"");
308 return false;
309 }
310
311 function setHighlight(id) { //
312 top.fsMod.recentIds["web"]=id;
313 top.fsMod.navFrameHighlightedID["web"]="pages"+id+"_"+top.fsMod.currentBank; // For highlighting
314
315 if (top.content && top.content.nav_frame && top.content.nav_frame.refresh_nav) {
316 top.content.nav_frame.refresh_nav();
317 }
318 }
319 '.$this->doc->redirectUrls($dblist->listURL()).'
320 '.$dblist->CBfunctions().'
321 function editRecords(table,idList,addParams,CBflag) { //
322 window.location.href="'.$BACK_PATH.'alt_doc.php?returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI')).
323 '&edit["+table+"]["+idList+"]=edit"+addParams;
324 }
325 function editList(table,idList) { //
326 var list="";
327
328 // Checking how many is checked, how many is not
329 var pointer=0;
330 var pos = idList.indexOf(",");
331 while (pos!=-1) {
332 if (cbValue(table+"|"+idList.substr(pointer,pos-pointer))) {
333 list+=idList.substr(pointer,pos-pointer)+",";
334 }
335 pointer=pos+1;
336 pos = idList.indexOf(",",pointer);
337 }
338 if (cbValue(table+"|"+idList.substr(pointer))) {
339 list+=idList.substr(pointer)+",";
340 }
341
342 return list ? list : idList;
343 }
344
345 if (top.fsMod) top.fsMod.recentIds["web"] = '.intval($this->id).';
346 ');
347
348 // Setting up the context sensitive menu:
349 $this->doc->getContextMenuCode();
350 } // access
351
352 // Begin to compile the whole page, starting out with page header:
353 $this->body='';
354 $this->body.= '<form action="'.htmlspecialchars($dblist->listURL()).'" method="post" name="dblistForm">';
355 $this->body.= $dblist->HTMLcode;
356 $this->body.= '<input type="hidden" name="cmd_table" /><input type="hidden" name="cmd" /></form>';
357
358 // If a listing was produced, create the page footer with search form etc:
359 if ($dblist->HTMLcode) {
360
361 // Making field select box (when extended view for a single table is enabled):
362 if ($dblist->table) {
363 $this->body.=$dblist->fieldSelectBox($dblist->table);
364 }
365
366 // Adding checkbox options for extended listing and clipboard display:
367 $this->body.='
368
369 <!--
370 Listing options for clipboard and thumbnails
371 -->
372 <div id="typo3-listOptions">
373 <form action="" method="post">';
374
375 $this->body.=t3lib_BEfunc::getFuncCheck($this->id,'SET[bigControlPanel]',$this->MOD_SETTINGS['bigControlPanel'],'db_list.php',($this->table?'&table='.$this->table:''),'id="checkLargeControl"').' <label for="checkLargeControl">'.$LANG->getLL('largeControl',1).'</label><br />';
376 if ($dblist->showClipboard) {
377 $this->body.=t3lib_BEfunc::getFuncCheck($this->id,'SET[clipBoard]',$this->MOD_SETTINGS['clipBoard'],'db_list.php',($this->table?'&table='.$this->table:''),'id="checkShowClipBoard"').' <label for="checkShowClipBoard">'.$LANG->getLL('showClipBoard',1).'</label><br />';
378 }
379 $this->body.=t3lib_BEfunc::getFuncCheck($this->id,'SET[localization]',$this->MOD_SETTINGS['localization'],'db_list.php',($this->table?'&table='.$this->table:''),'id="checkLocalization"').' <label for="checkLocalization">'.$LANG->getLL('localization',1).'</label><br />';
380 $this->body.='
381 </form>
382 </div>';
383 $this->body.= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'list_options', $GLOBALS['BACK_PATH']);
384
385 // Printing clipboard if enabled:
386 if ($this->MOD_SETTINGS['clipBoard'] && $dblist->showClipboard) {
387 $this->body.= $dblist->clipObj->printClipboard();
388 $this->body.= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'list_clipboard', $GLOBALS['BACK_PATH']);
389 }
390
391 // Search box:
392 $this->body.=$dblist->getSearchBox();
393
394 // Display sys-notes, if any are found:
395 $this->body.=$dblist->showSysNotesForPage();
396 }
397
398 // Setting up the buttons and markers for docheader
399 $docHeaderButtons = $dblist->getButtons();
400 $markers = array(
401 'CSH' => $docHeaderButtons['csh'],
402 'CONTENT' => $this->body
403 );
404
405 // Build the <body> for the module
406 $this->content = $this->doc->startPage('DB list');
407 $this->content.= $this->doc->moduleBody($this->pageinfo, $docHeaderButtons, $markers);
408 $this->content.= $this->doc->endPage();
409 $this->content = $this->doc->insertStylesAndJS($this->content);
410 }
411
412 /**
413 * Outputting the accumulated content to screen
414 *
415 * @return void
416 */
417 function printContent() {
418 echo $this->content;
419 }
420 }
421
422
423 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/db_list.php']) {
424 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/db_list.php']);
425 }
426
427
428
429 // Make instance:
430 $SOBE = t3lib_div::makeInstance('SC_db_list');
431 $SOBE->init();
432
433 // Include files?
434 foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE);
435
436 $SOBE->clearCache();
437 $SOBE->main();
438 $SOBE->printContent();
439
440 ?>