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