Fixed bug #12508: Log usage of XLLfile to deprecation log (thanks to Steffen Gebert)
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_clipboard.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 * Contains class for TYPO3 clipboard for records and files
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
32 * XHTML compliant
33 *
34 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 97: class t3lib_clipboard
42 *
43 * SECTION: Initialize
44 * 150: function initializeClipboard()
45 * 179: function lockToNormal()
46 * 196: function setCmd($cmd)
47 * 243: function setCurrentPad($padIdent)
48 * 258: function endClipboard()
49 * 271: function cleanUpCBC($CBarr,$table,$removeDeselected=0)
50 *
51 * SECTION: Clipboard HTML renderings
52 * 306: function printClipboard()
53 * 413: function printContentFromTab($pad)
54 * 487: function padTitleWrap($str,$pad)
55 * 504: function linkItemText($str,$rec,$table='')
56 * 531: function selUrlDB($table,$uid,$copy=0,$deselect=0,$baseArray=array())
57 * 547: function selUrlFile($path,$copy=0,$deselect=0,$baseArray=array())
58 * 564: function pasteUrl($table,$uid,$setRedirect=1)
59 * 581: function deleteUrl($setRedirect=1,$file=0)
60 * 598: function editUrl()
61 * 619: function removeUrl($table,$uid)
62 * 632: function confirmMsg($table,$rec,$type,$clElements)
63 * 680: function clLabel($key,$Akey='labels')
64 * 689: function exportClipElementParameters()
65 *
66 * SECTION: Helper functions
67 * 739: function removeElement($el)
68 * 751: function saveClipboard()
69 * 761: function currentMode()
70 * 771: function cleanCurrent()
71 * 798: function elFromTable($matchTable='',$pad='')
72 * 829: function isSelected($table,$uid)
73 * 843: function getSelectedRecord($table='',$uid='')
74 * 861: function isElements()
75 *
76 * SECTION: FOR USE IN tce_db.php:
77 * 902: function makePasteCmdArray($ref,$CMD)
78 * 931: function makeDeleteCmdArray($CMD)
79 *
80 * SECTION: FOR USE IN tce_file.php:
81 * 974: function makePasteCmdArray_file($ref,$FILE)
82 * 996: function makeDeleteCmdArray_file($FILE)
83 *
84 * TOTAL FUNCTIONS: 31
85 * (This index is automatically created/updated by the extension "extdeveval")
86 *
87 */
88
89
90 /**
91 * TYPO3 clipboard for records and files
92 *
93 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
94 * @package TYPO3
95 * @subpackage t3lib
96 */
97 class t3lib_clipboard {
98 var $numberTabs = 3;
99
100 /**
101 * Clipboard data kept here
102 *
103 * Keys:
104 * 'normal'
105 * 'tab_[x]' where x is >=1 and denotes the pad-number
106 * \ 'mode' : 'copy' means copy-mode, default = moving ('cut')
107 * \ 'el' : Array of elements:
108 * DB: keys = '[tablename]|[uid]' eg. 'tt_content:123'
109 * DB: values = 1 (basically insignificant)
110 * FILE: keys = '_FILE|[shortmd5 of path]' eg. '_FILE|9ebc7e5c74'
111 * FILE: values = The full filepath, eg. '/www/htdocs/typo3/32/dummy/fileadmin/sem1_3_examples/alternative_index.php' or 'C:/www/htdocs/typo3/32/dummy/fileadmin/sem1_3_examples/alternative_index.php'
112 *
113 * 'current' pointer to current tab (among the above...)
114 * '_setThumb' boolean: If set, file thumbnails are shown.
115 *
116 * The virtual tablename '_FILE' will always indicate files/folders. When checking for elements from eg. 'all tables' (by using an empty string) '_FILE' entries are excluded (so in effect only DB elements are counted)
117 *
118 */
119 var $clipData=array();
120
121 var $changed=0;
122 var $current='';
123 var $backPath='';
124 var $lockToNormal=0;
125 var $fileMode=0; // If set, clipboard is displaying files.
126
127
128
129
130
131
132
133
134
135
136
137
138
139 /*****************************************
140 *
141 * Initialize
142 *
143 ****************************************/
144
145 /**
146 * Initialize the clipboard from the be_user session
147 *
148 * @return void
149 */
150 function initializeClipboard() {
151 global $BE_USER;
152
153 // Get data
154 $clipData = $BE_USER->getModuleData('clipboard',$BE_USER->getTSConfigVal('options.saveClipboard')?'':'ses');
155
156 // NumberTabs
157 $clNP = $BE_USER->getTSConfigVal('options.clipboardNumberPads');
158 if (t3lib_div::testInt($clNP) && $clNP>=0) {
159 $this->numberTabs = t3lib_div::intInRange($clNP,0,20);
160 }
161
162 // Resets/reinstates the clipboard pads
163 $this->clipData['normal'] = is_array($clipData['normal']) ? $clipData['normal'] : array();
164 for ($a=1;$a<=$this->numberTabs;$a++) {
165 $this->clipData['tab_'.$a] = is_array($clipData['tab_'.$a]) ? $clipData['tab_'.$a] : array();
166 }
167
168 // Setting the current pad pointer ($this->current) and _setThumb (which determines whether or not do show file thumbnails)
169 $this->clipData['current'] = $this->current = isset($this->clipData[$clipData['current']]) ? $clipData['current'] : 'normal';
170 $this->clipData['_setThumb'] = $clipData['_setThumb'];
171 }
172
173 /**
174 * Call this method after initialization if you want to lock the clipboard to operate on the normal pad only. Trying to switch pad through ->setCmd will not work
175 * This is used by the clickmenu since it only allows operation on single elements at a time (that is the "normal" pad)
176 *
177 * @return void
178 */
179 function lockToNormal() {
180 $this->lockToNormal = 1;
181 $this->current = 'normal';
182 }
183
184 /**
185 * The array $cmd may hold various keys which notes some action to take.
186 * Normally perform only one action at a time.
187 * In scripts like db_list.php / file_list.php the GET-var CB is used to control the clipboard.
188 *
189 * Selecting / Deselecting elements
190 * Array $cmd['el'] has keys = element-ident, value = element value (see description of clipData array in header)
191 * Selecting elements for 'copy' should be done by simultaneously setting setCopyMode.
192 *
193 * @param array Array of actions, see function description
194 * @return void
195 */
196 function setCmd($cmd) {
197 if (is_array($cmd['el'])) {
198 reset($cmd['el']);
199 while(list($k,$v)=each($cmd['el'])) {
200 if ($this->current=='normal') {
201 unset($this->clipData['normal']);
202 }
203 if ($v) {
204 $this->clipData[$this->current]['el'][$k]=$v;
205 } else {
206 $this->removeElement($k);
207 }
208 $this->changed=1;
209 }
210 }
211 // Change clipboard pad (if not locked to normal)
212 if ($cmd['setP']) {
213 $this->setCurrentPad($cmd['setP']);
214 }
215 // Remove element (value = item ident: DB; '[tablename]|[uid]' FILE: '_FILE|[shortmd5 hash of path]'
216 if ($cmd['remove']) {
217 $this->removeElement($cmd['remove']);
218 $this->changed=1;
219 }
220 // Remove all on current pad (value = pad-ident)
221 if ($cmd['removeAll']) {
222 $this->clipData[$cmd['removeAll']]=array();
223 $this->changed=1;
224 }
225 // Set copy mode of the tab
226 if (isset($cmd['setCopyMode'])) {
227 $this->clipData[$this->current]['mode']=$this->isElements()?($cmd['setCopyMode']?'copy':''):'';
228 $this->changed=1;
229 }
230 // Toggle thumbnail display for files on/off
231 if (isset($cmd['setThumb'])) {
232 $this->clipData['_setThumb']=$cmd['setThumb'];
233 $this->changed=1;
234 }
235 }
236
237 /**
238 * Setting the current pad on clipboard
239 *
240 * @param string Key in the array $this->clipData
241 * @return void
242 */
243 function setCurrentPad($padIdent) {
244 // Change clipboard pad (if not locked to normal)
245 if (!$this->lockToNormal && $this->current!=$padIdent) {
246 if (isset($this->clipData[$padIdent])) $this->clipData['current'] = $this->current = $padIdent;
247 if ($this->current!='normal' || !$this->isElements()) $this->clipData[$this->current]['mode']=''; // Setting mode to default (move) if no items on it or if not 'normal'
248 $this->changed=1;
249 }
250 }
251
252 /**
253 * Call this after initialization and setCmd in order to save the clipboard to the user session.
254 * The function will check if the internal flag ->changed has been set and if so, save the clipboard. Else not.
255 *
256 * @return void
257 */
258 function endClipboard() {
259 if ($this->changed) $this->saveClipboard();
260 $this->changed=0;
261 }
262
263 /**
264 * Cleans up an incoming element array $CBarr (Array selecting/deselecting elements)
265 *
266 * @param array Element array from outside ("key" => "selected/deselected")
267 * @param string $table is the 'table which is allowed'. Must be set.
268 * @param boolean $removeDeselected can be set in order to remove entries which are marked for deselection.
269 * @return array Processed input $CBarr
270 */
271 function cleanUpCBC($CBarr,$table,$removeDeselected=0) {
272 if (is_array($CBarr)) {
273 reset($CBarr);
274 while(list($k,$v)=each($CBarr)) {
275 $p=explode('|',$k);
276 if ((string)$p[0]!=(string)$table || ($removeDeselected && !$v)) {
277 unset($CBarr[$k]);
278 }
279 }
280 }
281 return $CBarr;
282 }
283
284
285
286
287
288
289
290
291
292
293
294
295 /*****************************************
296 *
297 * Clipboard HTML renderings
298 *
299 ****************************************/
300
301 /**
302 * Prints the clipboard
303 *
304 * @return string HTML output
305 */
306 function printClipboard() {
307 global $TBE_TEMPLATE,$LANG;
308
309 $out=array();
310 $elCount = count($this->elFromTable($this->fileMode?'_FILE':''));
311
312 // Upper header
313 $out[]='
314 <tr class="bgColor2">
315 <td colspan="3" nowrap="nowrap" align="center"><span class="uppercase"><strong>'.$this->clLabel('clipboard','buttons').'</strong></span></td>
316 </tr>';
317
318 // Button/menu header:
319 $thumb_url = t3lib_div::linkThisScript(array('CB'=>array('setThumb'=>$this->clipData['_setThumb']?0:1)));
320 $rmall_url = t3lib_div::linkThisScript(array('CB'=>array('removeAll'=>$this->current)));
321
322 // Copymode Selector menu
323 $copymode_url = t3lib_div::linkThisScript();
324 $moveLabel = htmlspecialchars($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.php:moveElements'));
325 $copyLabel = htmlspecialchars($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.php:copyElements'));
326 $opt=array();
327 $opt[]='<option style="padding-left: 20px; background-image: url(\''.t3lib_iconWorks::skinImg($this->backPath, 'gfx/clip_cut.gif', '', 1).'\'); background-repeat: no-repeat;" value="" '.(($this->currentMode()=='copy')?'':'selected="selected"').'>'.$moveLabel .'</option>';
328 $opt[]='<option style="padding-left: 20px; background-image: url(\''.t3lib_iconWorks::skinImg($this->backPath, 'gfx/clip_copy.gif', '', 1).'\'); background-repeat: no-repeat;" value="1" '.(($this->currentMode()=='copy')?'selected="selected"':'').'>'.$copyLabel .'</option>';
329
330 $copymode_selector = ' <select name="CB[setCopyMode]" onchange="this.form.method=\'POST\'; this.form.action=\''.$copymode_url.'&CB[setCopyMode]=\'+(this.options[this.selectedIndex].value); this.form.submit(); return true;" >'.implode('',$opt).'</select>';
331
332 // Selector menu + clear button
333 $opt=array();
334 $opt[]='<option value="" selected="selected">'.$this->clLabel('menu','rm').'</option>';
335 // Import / Export link:
336 if ($elCount && t3lib_extMgm::isLoaded('impexp')) {
337 $opt[] = '<option value="'.htmlspecialchars("window.location.href='".$this->backPath.'mod.php?M=xMOD_tximpexp'.$this->exportClipElementParameters().'\';').'">'.$this->clLabel('export','rm').'</option>';
338 }
339 // Edit:
340 if (!$this->fileMode && $elCount) {
341 $opt[]='<option value="' . htmlspecialchars("window.location.href='" . $this->editUrl() . "&returnUrl='+top.rawurlencode(window.location.href);") . '">' . $this->clLabel('edit', 'rm') . '</option>';
342 }
343 // Delete:
344 if ($elCount) {
345 if($GLOBALS['BE_USER']->jsConfirmation(4)) {
346 $js = "
347 if(confirm(".$GLOBALS['LANG']->JScharCode(sprintf($LANG->sL('LLL:EXT:lang/locallang_core.php:mess.deleteClip'),$elCount)).")){
348 window.location.href='" . $this->deleteUrl(0, $this->fileMode ? 1 : 0) . "&redirect='+top.rawurlencode(window.location.href);
349 }
350 ";
351 } else {
352 $js = " window.location.href='" . $this->deleteUrl(0, $this->fileMode ? 1 : 0) . "&redirect='+top.rawurlencode(window.location.href); ";
353 }
354 $opt[]='<option value="'.htmlspecialchars($js).'">'.$this->clLabel('delete','rm').'</option>';
355 }
356 $selector_menu = '<select name="_clipMenu" onchange="eval(this.options[this.selectedIndex].value);this.selectedIndex=0;">'.implode('',$opt).'</select>';
357
358 $out[]='
359 <tr class="typo3-clipboard-head">
360 <td nowrap="nowrap">'.
361 '<a href="'.htmlspecialchars($thumb_url).'#clip_head">'.
362 '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/thumb_'.($this->clipData['_setThumb']?'s':'n').'.gif','width="21" height="16"').' vspace="2" border="0" title="'.$this->clLabel('thumbmode_clip').'" alt="" />'.
363 '</a>'.
364 '</td>
365 <td width="95%" nowrap="nowrap">'.
366 $copymode_selector.' '.
367 $selector_menu.
368 '</td>
369 <td>'.
370 '<a href="'.htmlspecialchars($rmall_url).'#clip_head">'.
371 '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/closedok_2.gif','width="21" height="16"').' vspace="2" border="0" title="'.$LANG->sL('LLL:EXT:lang/locallang_core.php:buttons.clear',1).'" alt="" />'.
372 '</a></td>
373 </tr>';
374
375
376 // Print header and content for the NORMAL tab:
377 $out[]='
378 <tr class="bgColor5">
379 <td colspan="3"><a href="'.htmlspecialchars(t3lib_div::linkThisScript(array('CB'=>array('setP'=>'normal')))).'#clip_head">'.
380 '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/'.($this->current=='normal'?'minus':'plus').'bullet.gif','width="18" height="16"').' border="0" align="top" alt="" />'.
381 $this->padTitleWrap('Normal','normal').
382 '</a></td>
383 </tr>';
384 if ($this->current=='normal') $out=array_merge($out,$this->printContentFromTab('normal'));
385
386 // Print header and content for the NUMERIC tabs:
387 for ($a=1;$a<=$this->numberTabs;$a++) {
388 $out[]='
389 <tr class="bgColor5">
390 <td colspan="3"><a href="'.htmlspecialchars(t3lib_div::linkThisScript(array('CB'=>array('setP'=>'tab_'.$a)))).'#clip_head">'.
391 '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/'.($this->current=='tab_'.$a?'minus':'plus').'bullet.gif','width="18" height="16"').' border="0" align="top" alt="" />'.
392 $this->padTitleWrap($this->clLabel('cliptabs').$a,'tab_'.$a).
393 '</a></td>
394 </tr>';
395 if ($this->current=='tab_'.$a) $out=array_merge($out,$this->printContentFromTab('tab_'.$a));
396 }
397
398 // Wrap accumulated rows in a table:
399 $output = '<a name="clip_head"></a>
400
401 <!--
402 TYPO3 Clipboard:
403 -->
404 <table cellpadding="0" cellspacing="1" border="0" width="290" id="typo3-clipboard">
405 '.implode('',$out).'
406 </table>';
407
408 // Wrap in form tag:
409 $output = '<form action="">'.$output.'</form>';
410
411 // Return the accumulated content:
412 return $output;
413 }
414
415 /**
416 * Print the content on a pad. Called from ->printClipboard()
417 *
418 * @param string Pad reference
419 * @return array Array with table rows for the clipboard.
420 * @access private
421 */
422 function printContentFromTab($pad) {
423 global $TBE_TEMPLATE;
424
425 $lines=array();
426 if (is_array($this->clipData[$pad]['el'])) {
427 reset($this->clipData[$pad]['el']);
428 while(list($k,$v)=each($this->clipData[$pad]['el'])) {
429 if ($v) {
430 list($table,$uid) = explode('|',$k);
431 $bgColClass = ($table=='_FILE'&&$this->fileMode)||($table!='_FILE'&&!$this->fileMode) ? 'bgColor4-20' : 'bgColor4';
432
433 if ($table=='_FILE') { // Rendering files/directories on the clipboard:
434 if (file_exists($v) && t3lib_div::isAllowedAbsPath($v)) {
435 $fI = pathinfo($v);
436 $icon = is_dir($v) ? 'folder.gif' : t3lib_BEfunc::getFileIcon(strtolower($fI['extension']));
437 $size = ' ('.t3lib_div::formatSize(filesize($v)).'bytes)';
438 $icon = '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/fileicons/'.$icon,'width="18" height="16"').' border="0" hspace="20" class="absmiddle" title="'.htmlspecialchars($fI['basename'].$size).'" alt="" />';
439 $thumb = $this->clipData['_setThumb'] ? (t3lib_div::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'],$fI['extension']) ? t3lib_BEfunc::getThumbNail($this->backPath.'thumbs.php',$v,' vspace="4"') : '') :'';
440
441 $lines[]='
442 <tr>
443 <td class="'.$bgColClass.'">'.$icon.'</td>
444 <td class="'.$bgColClass.'" nowrap="nowrap" width="95%">&nbsp;'.$this->linkItemText(htmlspecialchars(t3lib_div::fixed_lgd_cs(basename($v),$GLOBALS['BE_USER']->uc['titleLen'])),$v).
445 ($pad=='normal'?(' <strong>('.($this->clipData['normal']['mode']=='copy'?$this->clLabel('copy','cm'):$this->clLabel('cut','cm')).')</strong>'):'').'&nbsp;'.($thumb?'<br />'.$thumb:'').'</td>
446 <td class="'.$bgColClass.'" align="center" nowrap="nowrap">'.
447 '<a href="#" onclick="'.htmlspecialchars('top.launchView(\''.$v.'\', \'\'); return false;').'"><img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/zoom2.gif','width="12" height="12"').' hspace="2" border="0" title="'.$this->clLabel('info','cm').'" alt="" /></a>'.
448 '<a href="'.htmlspecialchars($this->removeUrl('_FILE',t3lib_div::shortmd5($v))).'#clip_head"><img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/close_12h.gif','width="11" height="12"').' border="0" title="'.$this->clLabel('removeItem').'" alt="" /></a>'.
449 '</td>
450 </tr>';
451 } else {
452 // If the file did not exist (or is illegal) then it is removed from the clipboard immediately:
453 unset($this->clipData[$pad]['el'][$k]);
454 $this->changed=1;
455 }
456 } else { // Rendering records:
457 $rec=t3lib_BEfunc::getRecordWSOL($table,$uid);
458 if (is_array($rec)) {
459 $lines[]='
460 <tr>
461 <td class="'.$bgColClass.'">'.$this->linkItemText(t3lib_iconWorks::getIconImage($table,$rec,$this->backPath,'hspace="20" title="'.htmlspecialchars(t3lib_BEfunc::getRecordIconAltText($rec,$table)).'"'),$rec,$table).'</td>
462 <td class="'.$bgColClass.'" nowrap="nowrap" width="95%">&nbsp;'.$this->linkItemText(htmlspecialchars(t3lib_div::fixed_lgd_cs(t3lib_BEfunc::getRecordTitle($table,$rec),$GLOBALS['BE_USER']->uc['titleLen'])),$rec,$table).
463 ($pad=='normal'?(' <strong>('.($this->clipData['normal']['mode']=='copy'?$this->clLabel('copy','cm'):$this->clLabel('cut','cm')).')</strong>'):'').'&nbsp;</td>
464 <td class="'.$bgColClass.'" align="center" nowrap="nowrap">'.
465 '<a href="#" onclick="'.htmlspecialchars('top.launchView(\''.$table.'\', \''.intval($uid).'\'); return false;').'"><img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/zoom2.gif','width="12" height="12"').' hspace="2" border="0" title="'.$this->clLabel('info','cm').'" alt="" /></a>'.
466 '<a href="'.htmlspecialchars($this->removeUrl($table,$uid)).'#clip_head"><img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/close_12h.gif','width="11" height="12"').' border="0" title="'.$this->clLabel('removeItem').'" alt="" /></a>'.
467 '</td>
468 </tr>';
469
470 $localizationData = $this->getLocalizations($table, $rec, $bgColClass, $pad);
471 if ($localizationData) {
472 $lines[] = $localizationData;
473 }
474
475 } else {
476 unset($this->clipData[$pad]['el'][$k]);
477 $this->changed=1;
478 }
479 }
480 }
481 }
482 }
483 if (!count($lines)) {
484 $lines[]='
485 <tr>
486 <td class="bgColor4"><img src="clear.gif" width="56" height="1" alt="" /></td>
487 <td colspan="2" class="bgColor4" nowrap="nowrap" width="95%">&nbsp;<em>('.$this->clLabel('clipNoEl').')</em>&nbsp;</td>
488 </tr>';
489 }
490
491 $this->endClipboard();
492 return $lines;
493 }
494
495
496 /**
497 * Gets all localizations of the current record.
498 *
499 * @param string the table
500 * @param array the current record
501 * @return string HTML table rows
502 */
503 function getLocalizations($table, $parentRec, $bgColClass, $pad) {
504 $lines = array();
505 $tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
506
507 if ($table != 'pages' && t3lib_BEfunc::isTableLocalizable($table) && !$tcaCtrl['transOrigPointerTable']) {
508 $where = array();
509 $where[] = $tcaCtrl['transOrigPointerField'] . '=' . intval($parentRec['uid']);
510 $where[] = $tcaCtrl['languageField'] . '!=0';
511
512 if (isset($tcaCtrl['delete']) && $tcaCtrl['delete']) {
513 $where[] = $tcaCtrl['delete'] . '=0';
514 }
515
516 if (isset($tcaCtrl['versioningWS']) && $tcaCtrl['versioningWS']) {
517 $where[] = 't3ver_wsid=' . $parentRec['t3ver_wsid'];
518 }
519
520 $rows = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('*', $table, implode(' AND ', $where));
521
522 if (is_array($rows)) {
523 $modeData = '';
524 if ($pad == 'normal') {
525 $mode = ($this->clipData['normal']['mode'] == 'copy' ? 'copy' : 'cut');
526 $modeData = ' <strong>(' . $this->clLabel($mode, 'cm') . ')</strong>';
527 }
528
529 foreach ($rows as $rec) {
530 $lines[]='
531 <tr>
532 <td class="' . $bgColClass . '">' .
533 t3lib_iconWorks::getIconImage($table, $rec, $this->backPath,' style="margin-left: 38px;"') . '</td>
534 <td class="' . $bgColClass . '" nowrap="nowrap" width="95%">&nbsp;' . htmlspecialchars(
535 t3lib_div::fixed_lgd_cs(t3lib_BEfunc::getRecordTitle($table, $rec), $GLOBALS['BE_USER']->uc['titleLen'])) .
536 $modeData . '&nbsp;</td>
537 <td class="' . $bgColClass . '" align="center" nowrap="nowrap">&nbsp;</td>
538 </tr>';
539 }
540 }
541 }
542 return implode('',$lines);
543 }
544
545
546
547 /**
548 * Wraps title of pad in bold-tags and maybe the number of elements if any.
549 *
550 * @param string String (already htmlspecialchars()'ed)
551 * @param string Pad reference
552 * @return string HTML output (htmlspecialchar'ed content inside of tags.)
553 */
554 function padTitleWrap($str,$pad) {
555 $el = count($this->elFromTable($this->fileMode?'_FILE':'',$pad));
556 if ($el) {
557 return '<strong>'.$str.'</strong> ('.($pad=='normal'?($this->clipData['normal']['mode']=='copy'?$this->clLabel('copy','cm'):$this->clLabel('cut','cm')):htmlspecialchars($el)).')';
558 } else {
559 return $GLOBALS['TBE_TEMPLATE']->dfw($str);
560 }
561 }
562
563 /**
564 * Wraps the title of the items listed in link-tags. The items will link to the page/folder where they originate from
565 *
566 * @param string Title of element - must be htmlspecialchar'ed on beforehand.
567 * @param mixed If array, a record is expected. If string, its a path
568 * @param string Table name
569 * @return string
570 */
571 function linkItemText($str,$rec,$table='') {
572 if (is_array($rec) && $table) {
573 if ($this->fileMode) {
574 $str=$GLOBALS['TBE_TEMPLATE']->dfw($str);
575 } else {
576 $str='<a href="'.htmlspecialchars($this->backPath.'db_list.php?id='.$rec['pid']).'">'.$str.'</a>';
577 }
578 } elseif (file_exists($rec)) {
579 if (!$this->fileMode) {
580 $str=$GLOBALS['TBE_TEMPLATE']->dfw($str);
581 } else {
582 $str='<a href="'.htmlspecialchars($this->backPath.'file_list.php?id='.dirname($rec)).'">'.$str.'</a>';
583 }
584 }
585 return $str;
586 }
587
588 /**
589 * Returns the select-url for database elements
590 *
591 * @param string Table name
592 * @param integer Uid of record
593 * @param boolean If set, copymode will be enabled
594 * @param boolean If set, the link will deselect, otherwise select.
595 * @param array The base array of GET vars to be sent in addition. Notice that current GET vars WILL automatically be included.
596 * @return string URL linking to the current script but with the CB array set to select the element with table/uid
597 */
598 function selUrlDB($table,$uid,$copy=0,$deselect=0,$baseArray=array()) {
599 $CB = array('el'=>array(rawurlencode($table.'|'.$uid)=>$deselect?0:1));
600 if ($copy) $CB['setCopyMode'] = 1;
601 $baseArray['CB'] = $CB;
602 return t3lib_div::linkThisScript($baseArray);
603 }
604
605 /**
606 * Returns the select-url for files
607 *
608 * @param string Filepath
609 * @param boolean If set, copymode will be enabled
610 * @param boolean If set, the link will deselect, otherwise select.
611 * @param array The base array of GET vars to be sent in addition. Notice that current GET vars WILL automatically be included.
612 * @return string URL linking to the current script but with the CB array set to select the path
613 */
614 function selUrlFile($path,$copy=0,$deselect=0,$baseArray=array()) {
615 $CB=array('el'=>array(rawurlencode('_FILE|'.t3lib_div::shortmd5($path))=>$deselect?'':$path));
616 if ($copy) $CB['setCopyMode']=1;
617 $baseArray['CB']=$CB;
618 return t3lib_div::linkThisScript($baseArray);
619 }
620
621 /**
622 * pasteUrl of the element (database and file)
623 * For the meaning of $table and $uid, please read from ->makePasteCmdArray!!!
624 * The URL will point to tce_file or tce_db depending in $table
625 *
626 * @param string Tablename (_FILE for files)
627 * @param mixed "destination": can be positive or negative indicating how the paste is done (paste into / paste after)
628 * @param boolean If set, then the redirect URL will point back to the current script, but with CB reset.
629 * @return string
630 */
631 function pasteUrl($table,$uid,$setRedirect=1) {
632 $rU = $this->backPath.($table=='_FILE'?'tce_file.php':'tce_db.php').'?'.
633 ($setRedirect ? 'redirect='.rawurlencode(t3lib_div::linkThisScript(array('CB'=>''))) : '').
634 '&vC='.$GLOBALS['BE_USER']->veriCode().
635 '&prErr=1&uPT=1'.
636 '&CB[paste]='.rawurlencode($table.'|'.$uid).
637 '&CB[pad]='.$this->current;
638 return $rU;
639 }
640
641 /**
642 * deleteUrl for current pad
643 *
644 * @param boolean If set, then the redirect URL will point back to the current script, but with CB reset.
645 * @param boolean If set, then the URL will link to the tce_file.php script in the typo3/ dir.
646 * @return string
647 */
648 function deleteUrl($setRedirect=1,$file=0) {
649 $rU = $this->backPath.($file?'tce_file.php':'tce_db.php').'?'.
650 ($setRedirect ? 'redirect='.rawurlencode(t3lib_div::linkThisScript(array('CB'=>''))) : '').
651 '&vC='.$GLOBALS['BE_USER']->veriCode().
652 '&prErr=1&uPT=1'.
653 '&CB[delete]=1'.
654 '&CB[pad]='.$this->current;
655 return $rU;
656 }
657
658 /**
659 * editUrl of all current elements
660 * ONLY database
661 * Links to alt_doc.php
662 *
663 * @return string The URL to alt_doc.php with parameters.
664 */
665 function editUrl() {
666 $elements = $this->elFromTable(''); // all records
667 reset($elements);
668 $editCMDArray=array();
669 while(list($tP)=each($elements)) {
670 list($table,$uid) = explode('|',$tP);
671 $editCMDArray[] = '&edit['.$table.']['.$uid.']=edit';
672 }
673
674 $rU = $this->backPath.'alt_doc.php?'.implode('',$editCMDArray);
675 return $rU;
676 }
677
678 /**
679 * Returns the remove-url (file and db)
680 * for file $table='_FILE' and $uid = shortmd5 hash of path
681 *
682 * @param string Tablename
683 * @param string uid integer/shortmd5 hash
684 * @return string URL
685 */
686 function removeUrl($table,$uid) {
687 return t3lib_div::linkThisScript(array('CB'=>array('remove'=>$table.'|'.$uid)));
688 }
689
690 /**
691 * Returns confirm JavaScript message
692 *
693 * @param string Table name
694 * @param mixed For records its an array, for files its a string (path)
695 * @param string Type-code
696 * @param array Array of selected elements
697 * @return string JavaScript "confirm" message
698 */
699 function confirmMsg($table,$rec,$type,$clElements) {
700 if($GLOBALS['BE_USER']->jsConfirmation(2)) {
701 $labelKey = 'LLL:EXT:lang/locallang_core.php:mess.'.($this->currentMode()=='copy'?'copy':'move').($this->current=='normal'?'':'cb').'_'.$type;
702 $msg = $GLOBALS['LANG']->sL($labelKey);
703
704 if ($table=='_FILE') {
705 $thisRecTitle = basename($rec);
706 if ($this->current=='normal') {
707 reset($clElements);
708 $selItem = current($clElements);
709 $selRecTitle = basename($selItem);
710 } else {
711 $selRecTitle=count($clElements);
712 }
713 } else {
714 $thisRecTitle = (
715 $table=='pages' && !is_array($rec) ?
716 $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] :
717 t3lib_BEfunc::getRecordTitle($table,$rec)
718 );
719
720 if ($this->current=='normal') {
721 $selItem = $this->getSelectedRecord();
722 $selRecTitle=$selItem['_RECORD_TITLE'];
723 } else {
724 $selRecTitle=count($clElements);
725 }
726 }
727
728 // Message:
729 $conf='confirm('.$GLOBALS['LANG']->JScharCode(sprintf(
730 $msg,
731 t3lib_div::fixed_lgd_cs($selRecTitle,30),
732 t3lib_div::fixed_lgd_cs($thisRecTitle,30)
733 )).')';
734 } else {
735 $conf = '';
736 }
737 return $conf;
738 }
739
740 /**
741 * Clipboard label - getting from "EXT:lang/locallang_core.php:"
742 *
743 * @param string Label Key
744 * @param string Alternative key to "labels"
745 * @return string
746 */
747 function clLabel($key,$Akey='labels') {
748 return htmlspecialchars($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:'.$Akey.'.'.$key));
749 }
750
751 /**
752 * Creates GET parameters for linking to the export module.
753 *
754 * @return string GET parameters for current clipboard content to be exported.
755 */
756 function exportClipElementParameters() {
757
758 // Init:
759 $pad = $this->current;
760 $params = array();
761 $params[] = 'tx_impexp[action]=export';
762
763 // Traverse items:
764 if (is_array($this->clipData[$pad]['el'])) {
765 reset($this->clipData[$pad]['el']);
766 while(list($k,$v)=each($this->clipData[$pad]['el'])) {
767 if ($v) {
768 list($table,$uid) = explode('|',$k);
769
770 if ($table=='_FILE') { // Rendering files/directories on the clipboard:
771 if (file_exists($v) && t3lib_div::isAllowedAbsPath($v)) {
772 $params[] = 'tx_impexp['.(is_dir($v) ? 'dir' : 'file').'][]='.rawurlencode($v);
773 }
774 } else { // Rendering records:
775 $rec = t3lib_BEfunc::getRecord($table,$uid);
776 if (is_array($rec)) {
777 $params[] = 'tx_impexp[record][]='.rawurlencode($table.':'.$uid);
778 }
779 }
780 }
781 }
782 }
783
784 return '&'.implode('&', $params);
785 }
786
787
788
789
790
791
792
793
794 /*****************************************
795 *
796 * Helper functions
797 *
798 ****************************************/
799
800 /**
801 * Removes element on clipboard
802 *
803 * @param string Key of element in ->clipData array
804 * @return void
805 */
806 function removeElement($el) {
807 unset($this->clipData[$this->current]['el'][$el]);
808 $this->changed=1;
809 }
810
811 /**
812 * Saves the clipboard, no questions asked.
813 * Use ->endClipboard normally (as it checks if changes has been done so saving is necessary)
814 *
815 * @return void
816 * @access private
817 */
818 function saveClipboard() {
819 global $BE_USER;
820 $BE_USER->pushModuleData('clipboard',$this->clipData);
821 }
822
823 /**
824 * Returns the current mode, 'copy' or 'cut'
825 *
826 * @return string "copy" or "cut"
827 */
828 function currentMode() {
829 return $this->clipData[$this->current]['mode']=='copy' ? 'copy' : 'cut';
830 }
831
832 /**
833 * This traverses the elements on the current clipboard pane
834 * and unsets elements which does not exist anymore or are disabled.
835 *
836 * @return void
837 */
838 function cleanCurrent() {
839 if (is_array($this->clipData[$this->current]['el'])) {
840 reset($this->clipData[$this->current]['el']);
841 while(list($k,$v)=each($this->clipData[$this->current]['el'])) {
842 list($table,$uid) = explode('|',$k);
843 if ($table!='_FILE') {
844 if (!$v || !is_array(t3lib_BEfunc::getRecord($table,$uid,'uid'))) {
845 unset($this->clipData[$this->current]['el'][$k]);
846 $this->changed=1;
847 }
848 } else {
849 if (!$v || !file_exists($v)) {
850 unset($this->clipData[$this->current]['el'][$k]);
851 $this->changed=1;
852 }
853 }
854 }
855 }
856 }
857
858 /**
859 * Counts the number of elements from the table $matchTable. If $matchTable is blank, all tables (except '_FILE' of course) is counted.
860 *
861 * @param string Table to match/count for.
862 * @param string $pad can optionally be used to set another pad than the current.
863 * @return array Array with keys from the CB.
864 */
865 function elFromTable($matchTable='',$pad='') {
866 $pad = $pad ? $pad : $this->current;
867 $list=array();
868 if (is_array($this->clipData[$pad]['el'])) {
869 reset($this->clipData[$pad]['el']);
870 while(list($k,$v)=each($this->clipData[$pad]['el'])) {
871 if ($v) {
872 list($table,$uid) = explode('|',$k);
873 if ($table!='_FILE') {
874 if ((!$matchTable || (string)$table==(string)$matchTable) && $GLOBALS['TCA'][$table]) {
875 $list[$k]= ($pad=='normal'?$v:$uid);
876 }
877 } else {
878 if ((string)$table==(string)$matchTable) {
879 $list[$k]=$v;
880 }
881 }
882 }
883 }
884 }
885 return $list;
886 }
887
888 /**
889 * Verifies if the item $table/$uid is on the current pad.
890 * If the pad is "normal", the mode value is returned if the element existed. Thus you'll know if the item was copy or cut moded...
891 *
892 * @param string Table name, (_FILE for files...)
893 * @param integer Element uid (path for files)
894 * @return string
895 */
896 function isSelected($table,$uid) {
897 $k=$table.'|'.$uid;
898 return $this->clipData[$this->current]['el'][$k] ? ($this->current=='normal'?$this->currentMode():1) : '';
899 }
900
901 /**
902 * Returns item record $table,$uid if selected on current clipboard
903 * If table and uid is blank, the first element is returned.
904 * Makes sense only for DB records - not files!
905 *
906 * @param string Table name
907 * @param integer Element uid
908 * @return array Element record with extra field _RECORD_TITLE set to the title of the record...
909 */
910 function getSelectedRecord($table='',$uid='') {
911 if (!$table && !$uid) {
912 $elArr = $this->elFromTable('');
913 reset($elArr);
914 list($table,$uid) = explode('|',key($elArr));
915 }
916 if ($this->isSelected($table,$uid)) {
917 $selRec = t3lib_BEfunc::getRecordWSOL($table,$uid);
918 $selRec['_RECORD_TITLE'] = t3lib_BEfunc::getRecordTitle($table,$selRec);
919 return $selRec;
920 }
921 }
922
923 /**
924 * Reports if the current pad has elements (does not check file/DB type OR if file/DBrecord exists or not. Only counting array)
925 *
926 * @return boolean True if elements exist.
927 */
928 function isElements() {
929 return is_array($this->clipData[$this->current]['el']) && count($this->clipData[$this->current]['el']);
930 }
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946 /*****************************************
947 *
948 * FOR USE IN tce_db.php:
949 *
950 ****************************************/
951
952 /**
953 * Applies the proper paste configuration in the $cmd array send to tce_db.php.
954 * $ref is the target, see description below.
955 * The current pad is pasted
956 *
957 * $ref: [tablename]:[paste-uid].
958 * tablename is the name of the table from which elements *on the current clipboard* is pasted with the 'pid' paste-uid.
959 * No tablename means that all items on the clipboard (non-files) are pasted. This requires paste-uid to be positive though.
960 * so 'tt_content:-3' means 'paste tt_content elements on the clipboard to AFTER tt_content:3 record
961 * 'tt_content:30' means 'paste tt_content elements on the clipboard into page with id 30
962 * ':30' means 'paste ALL database elements on the clipboard into page with id 30
963 * ':-30' not valid.
964 *
965 * @param string [tablename]:[paste-uid], see description
966 * @param array Command-array
967 * @return array Modified Command-array
968 */
969 function makePasteCmdArray($ref,$CMD) {
970 list($pTable,$pUid) = explode('|',$ref);
971 $pUid = intval($pUid);
972
973 if ($pTable || $pUid>=0) { // pUid must be set and if pTable is not set (that means paste ALL elements) the uid MUST be positive/zero (pointing to page id)
974 $elements = $this->elFromTable($pTable);
975
976 $elements = array_reverse($elements); // So the order is preserved.
977 $mode = $this->currentMode()=='copy' ? 'copy' : 'move';
978
979 // Traverse elements and make CMD array
980 reset($elements);
981 while(list($tP)=each($elements)) {
982 list($table,$uid) = explode('|',$tP);
983 if (!is_array($CMD[$table])) $CMD[$table]=array();
984 $CMD[$table][$uid][$mode]=$pUid;
985 if ($mode=='move') $this->removeElement($tP);
986 }
987 $this->endClipboard();
988 }
989 return $CMD;
990 }
991
992 /**
993 * Delete record entries in CMD array
994 *
995 * @param array Command-array
996 * @return array Modified Command-array
997 */
998 function makeDeleteCmdArray($CMD) {
999 $elements = $this->elFromTable(''); // all records
1000 reset($elements);
1001 while(list($tP)=each($elements)) {
1002 list($table,$uid) = explode('|',$tP);
1003 if (!is_array($CMD[$table])) $CMD[$table]=array();
1004 $CMD[$table][$uid]['delete']=1;
1005 $this->removeElement($tP);
1006 }
1007 $this->endClipboard();
1008 return $CMD;
1009 }
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027 /*****************************************
1028 *
1029 * FOR USE IN tce_file.php:
1030 *
1031 ****************************************/
1032
1033 /**
1034 * Applies the proper paste configuration in the $file array send to tce_file.php.
1035 * The current pad is pasted
1036 *
1037 * @param string Reference to element (splitted by "|")
1038 * @param array Command-array
1039 * @return array Modified Command-array
1040 */
1041 function makePasteCmdArray_file($ref,$FILE) {
1042 list($pTable,$pUid) = explode('|',$ref);
1043 $elements = $this->elFromTable('_FILE');
1044 $mode = $this->currentMode()=='copy' ? 'copy' : 'move';
1045
1046 // Traverse elements and make CMD array
1047 reset($elements);
1048 while(list($tP,$path)=each($elements)) {
1049 $FILE[$mode][]=array('data'=>$path,'target'=>$pUid,'altName'=>1);
1050 if ($mode=='move') $this->removeElement($tP);
1051 }
1052 $this->endClipboard();
1053
1054 return $FILE;
1055 }
1056
1057 /**
1058 * Delete files in CMD array
1059 *
1060 * @param array Command-array
1061 * @return array Modified Command-array
1062 */
1063 function makeDeleteCmdArray_file($FILE) {
1064 $elements = $this->elFromTable('_FILE');
1065 // Traverse elements and make CMD array
1066 reset($elements);
1067 while(list($tP,$path)=each($elements)) {
1068 $FILE['delete'][]=array('data'=>$path);
1069 $this->removeElement($tP);
1070 }
1071 $this->endClipboard();
1072
1073 return $FILE;
1074 }
1075 }
1076
1077
1078
1079 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_clipboard.php']) {
1080 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_clipboard.php']);
1081 }
1082
1083 ?>