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