Changed lots of stuff...
[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 * 193: function main()
52 * 402: 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->alternateBgColors=$this->modTSconfig['properties']['alternateBgColors']?1:0;
216 $dblist->allowedNewTables = t3lib_div::trimExplode(',',$this->modTSconfig['properties']['allowedNewTables'],1);
217 $dblist->newWizards=$this->modTSconfig['properties']['newWizards']?1:0;
218
219
220
221 // Clipboard is initialized:
222 $dblist->clipObj = t3lib_div::makeInstance('t3lib_clipboard'); // Start clipboard
223 $dblist->clipObj->initializeClipboard(); // Initialize - reads the clipboard content from the user session
224
225 // Clipboard actions are handled:
226 $CB = t3lib_div::_GET('CB'); // CB is the clipboard command array
227 if ($this->cmd=='setCB') {
228 // 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
229 // This is set to the 'el' array of the CB after being parsed so only the table in question is registered.
230 $CB['el'] = $dblist->clipObj->cleanUpCBC(array_merge(t3lib_div::_POST('CBH'),t3lib_div::_POST('CBC')),$this->cmd_table);
231 }
232 if (!$this->MOD_SETTINGS['clipBoard']) $CB['setP']='normal'; // If the clipboard is NOT shown, set the pad to 'normal'.
233 $dblist->clipObj->setCmd($CB); // Execute commands.
234 $dblist->clipObj->cleanCurrent(); // Clean up pad
235 $dblist->clipObj->endClipboard(); // Save the clipboard content
236
237 // This flag will prevent the clipboard panel in being shown.
238 // It is set, if the clickmenu-layer is active AND the extended view is not enabled.
239 $dblist->dontShowClipControlPanels = $CLIENT['FORMSTYLE'] && !$this->MOD_SETTINGS['bigControlPanel'] && $dblist->clipObj->current=='normal' && !$BE_USER->uc['disableCMlayers'] && !$this->modTSconfig['properties']['showClipControlPanelsDespiteOfCMlayers'];
240
241
242
243 // If there is access to the page, then render the list contents and set up the document template object:
244 if ($access) {
245
246 // Deleting records...:
247 // 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.
248 if ($this->cmd=='delete') {
249 $items = $dblist->clipObj->cleanUpCBC(t3lib_div::_POST('CBC'),$this->cmd_table,1);
250 if (count($items)) {
251 $cmd=array();
252 reset($items);
253 while(list($iK)=each($items)) {
254 $iKParts = explode('|',$iK);
255 $cmd[$iKParts[0]][$iKParts[1]]['delete']=1;
256 }
257 $tce = t3lib_div::makeInstance('t3lib_TCEmain');
258 $tce->stripslashes_values=0;
259 $tce->start(array(),$cmd);
260 $tce->process_cmdmap();
261
262 if (isset($cmd['pages'])) {
263 t3lib_BEfunc::getSetUpdateSignal('updatePageTree');
264 }
265
266 $tce->printLogErrorMessages(t3lib_div::getIndpEnv('REQUEST_URI'));
267 }
268 }
269
270 // Initialize the listing object, dblist, for rendering the list:
271 $this->pointer = t3lib_div::intInRange($this->pointer,0,100000);
272 $dblist->start($this->id,$this->table,$this->pointer,$this->search_field,$this->search_levels,$this->showLimit);
273 $dblist->setDispFields();
274
275 // Render the page header:
276 $dblist->writeTop($this->pageinfo,t3lib_BEfunc::getRecordPath (intval($this->pageinfo['uid']),$this->perms_clause,15));
277
278 // Render the list of tables:
279 $dblist->generateList($this->id,$this->table);
280
281 // Write the bottom of the page:
282 $dblist->writeBottom();
283
284 // Add JavaScript functions to the page:
285 $this->doc->JScode=$this->doc->wrapScriptTags('
286 function jumpToUrl(URL) { //
287 document.location = URL;
288 return false;
289 }
290 function jumpExt(URL,anchor) { //
291 var anc = anchor?anchor:"";
292 document.location = URL+(T3_THIS_LOCATION?"&returnUrl="+T3_THIS_LOCATION:"")+anc;
293 return false;
294 }
295 function jumpSelf(URL) { //
296 document.location = URL+(T3_RETURN_URL?"&returnUrl="+T3_RETURN_URL:"");
297 return false;
298 }
299 '.$this->doc->redirectUrls($dblist->listURL()).'
300 '.$dblist->CBfunctions().'
301 function editRecords(table,idList,addParams,CBflag) { //
302 document.location="'.$backPath.'alt_doc.php?returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI')).
303 '&edit["+table+"]["+idList+"]=edit"+addParams;
304 }
305 function editList(table,idList) { //
306 var list="";
307
308 // Checking how many is checked, how many is not
309 var pointer=0;
310 var pos = idList.indexOf(",");
311 while (pos!=-1) {
312 if (cbValue(table+"|"+idList.substr(pointer,pos-pointer))) {
313 list+=idList.substr(pointer,pos-pointer)+",";
314 }
315 pointer=pos+1;
316 pos = idList.indexOf(",",pointer);
317 }
318 if (cbValue(table+"|"+idList.substr(pointer))) {
319 list+=idList.substr(pointer)+",";
320 }
321
322 return list ? list : idList;
323 }
324
325 if (top.fsMod) top.fsMod.recentIds["web"] = '.intval($this->id).';
326 ');
327
328 // Setting up the context sensitive menu:
329 $CMparts=$this->doc->getContextMenuCode();
330 $this->doc->bodyTagAdditions = $CMparts[1];
331 $this->doc->JScode.=$CMparts[0];
332 $this->doc->postCode.= $CMparts[2];
333 } // access
334
335
336
337 // Begin to compile the whole page, starting out with page header:
338 $this->content='';
339 $this->content.=$this->doc->startPage('DB list');
340 $this->content.= '<form action="'.htmlspecialchars($dblist->listURL()).'" method="post" name="dblistForm">';
341
342 // Add listing HTML code:
343 $this->content.= $dblist->HTMLcode;
344 $this->content.= '<input type="hidden" name="cmd_table" /><input type="hidden" name="cmd" /></form>';
345
346
347 // If a listing was produced, create the page footer with search form etc:
348 if ($dblist->HTMLcode) {
349
350 // Making field select box (when extended view for a single table is enabled):
351 if ($dblist->table) {
352 $this->content.=$dblist->fieldSelectBox($dblist->table);
353 }
354
355 // Adding checkbox options for extended listing and clipboard display:
356 $this->content.='
357
358 <!--
359 Listing options for clipboard and thumbnails
360 -->
361 <div id="typo3-listOptions">
362 <form action="" method="post">';
363 $this->content.=t3lib_BEfunc::getFuncCheck($this->id,'SET[bigControlPanel]',$this->MOD_SETTINGS['bigControlPanel'],'db_list.php','').' '.$LANG->getLL('largeControl',1).'<br />';
364 if ($dblist->showClipboard) {
365 $this->content.=t3lib_BEfunc::getFuncCheck($this->id,'SET[clipBoard]',$this->MOD_SETTINGS['clipBoard'],'db_list.php','').' '.$LANG->getLL('showClipBoard',1);
366 }
367 $this->content.='
368 </form>
369 </div>';
370
371 // Printing clipboard if enabled:
372 if ($this->MOD_SETTINGS['clipBoard'] && $dblist->showClipboard) {
373 $this->content.=$dblist->clipObj->printClipboard();
374 }
375
376 // Link for creating new records:
377 if (!$this->modTSconfig['properties']['noCreateRecordsLink']) {
378 $this->content.='
379
380 <!--
381 Link for creating a new record:
382 -->
383 <div id="typo3-newRecordLink">
384 <a href="'.htmlspecialchars('db_new.php?id='.$this->id.'&returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'))).'">'.
385 '<img'.t3lib_iconWorks::skinImg($this->doc->backPath,'gfx/new_el.gif','width="11" height="12"').' alt="" />'.
386 $LANG->getLL('newRecordGeneral',1).
387 '</a>
388 </div>';
389 }
390
391 // Search box:
392 $this->content.=$dblist->getSearchBox();
393
394 // Display sys-notes, if any are found:
395 $this->content.=$dblist->showSysNotesForPage();
396
397 // ShortCut:
398 if ($BE_USER->mayMakeShortcut()) {
399 $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']);
400 }
401 }
402
403 // Finally, close off the page:
404 $this->content.= $this->doc->endPage();
405 }
406
407 /**
408 * Outputting the accumulated content to screen
409 *
410 * @return void
411 */
412 function printContent() {
413 echo $this->content;
414 }
415 }
416
417 // Include extension?
418 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/db_list.php']) {
419 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/db_list.php']);
420 }
421
422
423
424
425
426
427
428
429
430
431
432
433 // Make instance:
434 $SOBE = t3lib_div::makeInstance('SC_db_list');
435 $SOBE->init();
436
437 // Include files?
438 foreach($SOBE->include_once as $INC_FILE) include_once($INC_FILE);
439
440 $SOBE->clearCache();
441 $SOBE->main();
442 $SOBE->printContent();
443 ?>