21545b6d43c17eb578880ec13349fc7850efd42a
[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 $lines[] = $this->getLocalisations($table, $rec, $bgColClass, $pad);
471
472 } else {
473 unset($this->clipData[$pad]['el'][$k]);
474 $this->changed=1;
475 }
476 }
477 }
478 }
479 }
480 if (!count($lines)) {
481 $lines[]='
482 <tr>
483 <td class="bgColor4"><img src="clear.gif" width="56" height="1" alt="" /></td>
484 <td colspan="2" class="bgColor4" nowrap="nowrap" width="95%">&nbsp;<em>('.$this->clLabel('clipNoEl').')</em>&nbsp;</td>
485 </tr>';
486 }
487
488 $this->endClipboard();
489 return $lines;
490 }
491
492
493 /**
494 * returns all localisations of the current record
495 *
496 * @param string the table
497 * @param array the current record
498 * @return string HTML table rows
499 */
500 function getLocalisations($table, $parentRec, $bgColClass, $pad) {
501
502 $lines = array();
503 if ($table != 'pages' &&
504 $GLOBALS['TCA'][$table]['ctrl']['languageField'] &&
505 $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']
506 && !$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerTable']) {
507 $rows = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
508 '*',
509 $table,
510 $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'] . '=' . intval($parentRec['uid']) .
511 ' AND ' . $GLOBALS['TCA'][$table]['ctrl']['languageField'] . '!=0' .
512 ' AND ' . $GLOBALS['TCA'][$table]['ctrl']['delete'] . '=0' .
513 ' AND t3ver_wsid=' . $parentRec['t3ver_wsid']
514 );
515
516 foreach ($rows as $rec) {
517 $lines[]='
518 <tr>
519 <td class="' . $bgColClass . '">' .
520 t3lib_iconWorks::getIconImage($table, $rec, $this->backPath,' style="margin-left: 38px;"') . '</td>
521 <td class="' . $bgColClass . '" nowrap="nowrap" width="95%">&nbsp;' . htmlspecialchars(
522 t3lib_div::fixed_lgd_cs(t3lib_BEfunc::getRecordTitle($table, $rec), $GLOBALS['BE_USER']->uc['titleLen'])) .
523 ($pad == 'normal' ? (
524 ' <strong>(' . ($this->clipData['normal']['mode'] == 'copy' ? $this->clLabel('copy', 'cm') :
525 $this->clLabel('cut','cm')).')</strong>') :
526 ''
527 ) . '&nbsp;</td>
528 <td class="' . $bgColClass . '" align="center" nowrap="nowrap">&nbsp;</td>
529 </tr>';
530 }
531 }
532 return implode('',$lines);
533 }
534
535
536
537 /**
538 * Wraps title of pad in bold-tags and maybe the number of elements if any.
539 *
540 * @param string String (already htmlspecialchars()'ed)
541 * @param string Pad reference
542 * @return string HTML output (htmlspecialchar'ed content inside of tags.)
543 */
544 function padTitleWrap($str,$pad) {
545 $el = count($this->elFromTable($this->fileMode?'_FILE':'',$pad));
546 if ($el) {
547 return '<strong>'.$str.'</strong> ('.($pad=='normal'?($this->clipData['normal']['mode']=='copy'?$this->clLabel('copy','cm'):$this->clLabel('cut','cm')):htmlspecialchars($el)).')';
548 } else {
549 return $GLOBALS['TBE_TEMPLATE']->dfw($str);
550 }
551 }
552
553 /**
554 * Wraps the title of the items listed in link-tags. The items will link to the page/folder where they originate from
555 *
556 * @param string Title of element - must be htmlspecialchar'ed on beforehand.
557 * @param mixed If array, a record is expected. If string, its a path
558 * @param string Table name
559 * @return string
560 */
561 function linkItemText($str,$rec,$table='') {
562 if (is_array($rec) && $table) {
563 if ($this->fileMode) {
564 $str=$GLOBALS['TBE_TEMPLATE']->dfw($str);
565 } else {
566 $str='<a href="'.htmlspecialchars($this->backPath.'db_list.php?id='.$rec['pid']).'">'.$str.'</a>';
567 }
568 } elseif (file_exists($rec)) {
569 if (!$this->fileMode) {
570 $str=$GLOBALS['TBE_TEMPLATE']->dfw($str);
571 } else {
572 $str='<a href="'.htmlspecialchars($this->backPath.'file_list.php?id='.dirname($rec)).'">'.$str.'</a>';
573 }
574 }
575 return $str;
576 }
577
578 /**
579 * Returns the select-url for database elements
580 *
581 * @param string Table name
582 * @param integer Uid of record
583 * @param boolean If set, copymode will be enabled
584 * @param boolean If set, the link will deselect, otherwise select.
585 * @param array The base array of GET vars to be sent in addition. Notice that current GET vars WILL automatically be included.
586 * @return string URL linking to the current script but with the CB array set to select the element with table/uid
587 */
588 function selUrlDB($table,$uid,$copy=0,$deselect=0,$baseArray=array()) {
589 $CB = array('el'=>array(rawurlencode($table.'|'.$uid)=>$deselect?0:1));
590 if ($copy) $CB['setCopyMode'] = 1;
591 $baseArray['CB'] = $CB;
592 return t3lib_div::linkThisScript($baseArray);
593 }
594
595 /**
596 * Returns the select-url for files
597 *
598 * @param string Filepath
599 * @param boolean If set, copymode will be enabled
600 * @param boolean If set, the link will deselect, otherwise select.
601 * @param array The base array of GET vars to be sent in addition. Notice that current GET vars WILL automatically be included.
602 * @return string URL linking to the current script but with the CB array set to select the path
603 */
604 function selUrlFile($path,$copy=0,$deselect=0,$baseArray=array()) {
605 $CB=array('el'=>array(rawurlencode('_FILE|'.t3lib_div::shortmd5($path))=>$deselect?'':$path));
606 if ($copy) $CB['setCopyMode']=1;
607 $baseArray['CB']=$CB;
608 return t3lib_div::linkThisScript($baseArray);
609 }
610
611 /**
612 * pasteUrl of the element (database and file)
613 * For the meaning of $table and $uid, please read from ->makePasteCmdArray!!!
614 * The URL will point to tce_file or tce_db depending in $table
615 *
616 * @param string Tablename (_FILE for files)
617 * @param mixed "destination": can be positive or negative indicating how the paste is done (paste into / paste after)
618 * @param boolean If set, then the redirect URL will point back to the current script, but with CB reset.
619 * @return string
620 */
621 function pasteUrl($table,$uid,$setRedirect=1) {
622 $rU = $this->backPath.($table=='_FILE'?'tce_file.php':'tce_db.php').'?'.
623 ($setRedirect ? 'redirect='.rawurlencode(t3lib_div::linkThisScript(array('CB'=>''))) : '').
624 '&vC='.$GLOBALS['BE_USER']->veriCode().
625 '&prErr=1&uPT=1'.
626 '&CB[paste]='.rawurlencode($table.'|'.$uid).
627 '&CB[pad]='.$this->current;
628 return $rU;
629 }
630
631 /**
632 * deleteUrl for current pad
633 *
634 * @param boolean If set, then the redirect URL will point back to the current script, but with CB reset.
635 * @param boolean If set, then the URL will link to the tce_file.php script in the typo3/ dir.
636 * @return string
637 */
638 function deleteUrl($setRedirect=1,$file=0) {
639 $rU = $this->backPath.($file?'tce_file.php':'tce_db.php').'?'.
640 ($setRedirect ? 'redirect='.rawurlencode(t3lib_div::linkThisScript(array('CB'=>''))) : '').
641 '&vC='.$GLOBALS['BE_USER']->veriCode().
642 '&prErr=1&uPT=1'.
643 '&CB[delete]=1'.
644 '&CB[pad]='.$this->current;
645 return $rU;
646 }
647
648 /**
649 * editUrl of all current elements
650 * ONLY database
651 * Links to alt_doc.php
652 *
653 * @return string The URL to alt_doc.php with parameters.
654 */
655 function editUrl() {
656 $elements = $this->elFromTable(''); // all records
657 reset($elements);
658 $editCMDArray=array();
659 while(list($tP)=each($elements)) {
660 list($table,$uid) = explode('|',$tP);
661 $editCMDArray[] = '&edit['.$table.']['.$uid.']=edit';
662 }
663
664 $rU = $this->backPath.'alt_doc.php?'.implode('',$editCMDArray);
665 return $rU;
666 }
667
668 /**
669 * Returns the remove-url (file and db)
670 * for file $table='_FILE' and $uid = shortmd5 hash of path
671 *
672 * @param string Tablename
673 * @param string uid integer/shortmd5 hash
674 * @return string URL
675 */
676 function removeUrl($table,$uid) {
677 return t3lib_div::linkThisScript(array('CB'=>array('remove'=>$table.'|'.$uid)));
678 }
679
680 /**
681 * Returns confirm JavaScript message
682 *
683 * @param string Table name
684 * @param mixed For records its an array, for files its a string (path)
685 * @param string Type-code
686 * @param array Array of selected elements
687 * @return string JavaScript "confirm" message
688 */
689 function confirmMsg($table,$rec,$type,$clElements) {
690 if($GLOBALS['BE_USER']->jsConfirmation(2)) {
691 $labelKey = 'LLL:EXT:lang/locallang_core.php:mess.'.($this->currentMode()=='copy'?'copy':'move').($this->current=='normal'?'':'cb').'_'.$type;
692 $msg = $GLOBALS['LANG']->sL($labelKey);
693
694 if ($table=='_FILE') {
695 $thisRecTitle = basename($rec);
696 if ($this->current=='normal') {
697 reset($clElements);
698 $selItem = current($clElements);
699 $selRecTitle = basename($selItem);
700 } else {
701 $selRecTitle=count($clElements);
702 }
703 } else {
704 $thisRecTitle = (
705 $table=='pages' && !is_array($rec) ?
706 $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] :
707 t3lib_BEfunc::getRecordTitle($table,$rec)
708 );
709
710 if ($this->current=='normal') {
711 $selItem = $this->getSelectedRecord();
712 $selRecTitle=$selItem['_RECORD_TITLE'];
713 } else {
714 $selRecTitle=count($clElements);
715 }
716 }
717
718 // Message:
719 $conf='confirm('.$GLOBALS['LANG']->JScharCode(sprintf(
720 $msg,
721 t3lib_div::fixed_lgd_cs($selRecTitle,30),
722 t3lib_div::fixed_lgd_cs($thisRecTitle,30)
723 )).')';
724 } else {
725 $conf = '';
726 }
727 return $conf;
728 }
729
730 /**
731 * Clipboard label - getting from "EXT:lang/locallang_core.php:"
732 *
733 * @param string Label Key
734 * @param string Alternative key to "labels"
735 * @return string
736 */
737 function clLabel($key,$Akey='labels') {
738 return htmlspecialchars($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:'.$Akey.'.'.$key));
739 }
740
741 /**
742 * Creates GET parameters for linking to the export module.
743 *
744 * @return string GET parameters for current clipboard content to be exported.
745 */
746 function exportClipElementParameters() {
747
748 // Init:
749 $pad = $this->current;
750 $params = array();
751 $params[] = 'tx_impexp[action]=export';
752
753 // Traverse items:
754 if (is_array($this->clipData[$pad]['el'])) {
755 reset($this->clipData[$pad]['el']);
756 while(list($k,$v)=each($this->clipData[$pad]['el'])) {
757 if ($v) {
758 list($table,$uid) = explode('|',$k);
759
760 if ($table=='_FILE') { // Rendering files/directories on the clipboard:
761 if (file_exists($v) && t3lib_div::isAllowedAbsPath($v)) {
762 $params[] = 'tx_impexp['.(is_dir($v) ? 'dir' : 'file').'][]='.rawurlencode($v);
763 }
764 } else { // Rendering records:
765 $rec = t3lib_BEfunc::getRecord($table,$uid);
766 if (is_array($rec)) {
767 $params[] = 'tx_impexp[record][]='.rawurlencode($table.':'.$uid);
768 }
769 }
770 }
771 }
772 }
773
774 return '&'.implode('&', $params);
775 }
776
777
778
779
780
781
782
783
784 /*****************************************
785 *
786 * Helper functions
787 *
788 ****************************************/
789
790 /**
791 * Removes element on clipboard
792 *
793 * @param string Key of element in ->clipData array
794 * @return void
795 */
796 function removeElement($el) {
797 unset($this->clipData[$this->current]['el'][$el]);
798 $this->changed=1;
799 }
800
801 /**
802 * Saves the clipboard, no questions asked.
803 * Use ->endClipboard normally (as it checks if changes has been done so saving is necessary)
804 *
805 * @return void
806 * @access private
807 */
808 function saveClipboard() {
809 global $BE_USER;
810 $BE_USER->pushModuleData('clipboard',$this->clipData);
811 }
812
813 /**
814 * Returns the current mode, 'copy' or 'cut'
815 *
816 * @return string "copy" or "cut"
817 */
818 function currentMode() {
819 return $this->clipData[$this->current]['mode']=='copy' ? 'copy' : 'cut';
820 }
821
822 /**
823 * This traverses the elements on the current clipboard pane
824 * and unsets elements which does not exist anymore or are disabled.
825 *
826 * @return void
827 */
828 function cleanCurrent() {
829 if (is_array($this->clipData[$this->current]['el'])) {
830 reset($this->clipData[$this->current]['el']);
831 while(list($k,$v)=each($this->clipData[$this->current]['el'])) {
832 list($table,$uid) = explode('|',$k);
833 if ($table!='_FILE') {
834 if (!$v || !is_array(t3lib_BEfunc::getRecord($table,$uid,'uid'))) {
835 unset($this->clipData[$this->current]['el'][$k]);
836 $this->changed=1;
837 }
838 } else {
839 if (!$v || !file_exists($v)) {
840 unset($this->clipData[$this->current]['el'][$k]);
841 $this->changed=1;
842 }
843 }
844 }
845 }
846 }
847
848 /**
849 * Counts the number of elements from the table $matchTable. If $matchTable is blank, all tables (except '_FILE' of course) is counted.
850 *
851 * @param string Table to match/count for.
852 * @param string $pad can optionally be used to set another pad than the current.
853 * @return array Array with keys from the CB.
854 */
855 function elFromTable($matchTable='',$pad='') {
856 $pad = $pad ? $pad : $this->current;
857 $list=array();
858 if (is_array($this->clipData[$pad]['el'])) {
859 reset($this->clipData[$pad]['el']);
860 while(list($k,$v)=each($this->clipData[$pad]['el'])) {
861 if ($v) {
862 list($table,$uid) = explode('|',$k);
863 if ($table!='_FILE') {
864 if ((!$matchTable || (string)$table==(string)$matchTable) && $GLOBALS['TCA'][$table]) {
865 $list[$k]= ($pad=='normal'?$v:$uid);
866 }
867 } else {
868 if ((string)$table==(string)$matchTable) {
869 $list[$k]=$v;
870 }
871 }
872 }
873 }
874 }
875 return $list;
876 }
877
878 /**
879 * Verifies if the item $table/$uid is on the current pad.
880 * 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...
881 *
882 * @param string Table name, (_FILE for files...)
883 * @param integer Element uid (path for files)
884 * @return string
885 */
886 function isSelected($table,$uid) {
887 $k=$table.'|'.$uid;
888 return $this->clipData[$this->current]['el'][$k] ? ($this->current=='normal'?$this->currentMode():1) : '';
889 }
890
891 /**
892 * Returns item record $table,$uid if selected on current clipboard
893 * If table and uid is blank, the first element is returned.
894 * Makes sense only for DB records - not files!
895 *
896 * @param string Table name
897 * @param integer Element uid
898 * @return array Element record with extra field _RECORD_TITLE set to the title of the record...
899 */
900 function getSelectedRecord($table='',$uid='') {
901 if (!$table && !$uid) {
902 $elArr = $this->elFromTable('');
903 reset($elArr);
904 list($table,$uid) = explode('|',key($elArr));
905 }
906 if ($this->isSelected($table,$uid)) {
907 $selRec = t3lib_BEfunc::getRecordWSOL($table,$uid);
908 $selRec['_RECORD_TITLE'] = t3lib_BEfunc::getRecordTitle($table,$selRec);
909 return $selRec;
910 }
911 }
912
913 /**
914 * Reports if the current pad has elements (does not check file/DB type OR if file/DBrecord exists or not. Only counting array)
915 *
916 * @return boolean True if elements exist.
917 */
918 function isElements() {
919 return is_array($this->clipData[$this->current]['el']) && count($this->clipData[$this->current]['el']);
920 }
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936 /*****************************************
937 *
938 * FOR USE IN tce_db.php:
939 *
940 ****************************************/
941
942 /**
943 * Applies the proper paste configuration in the $cmd array send to tce_db.php.
944 * $ref is the target, see description below.
945 * The current pad is pasted
946 *
947 * $ref: [tablename]:[paste-uid].
948 * tablename is the name of the table from which elements *on the current clipboard* is pasted with the 'pid' paste-uid.
949 * No tablename means that all items on the clipboard (non-files) are pasted. This requires paste-uid to be positive though.
950 * so 'tt_content:-3' means 'paste tt_content elements on the clipboard to AFTER tt_content:3 record
951 * 'tt_content:30' means 'paste tt_content elements on the clipboard into page with id 30
952 * ':30' means 'paste ALL database elements on the clipboard into page with id 30
953 * ':-30' not valid.
954 *
955 * @param string [tablename]:[paste-uid], see description
956 * @param array Command-array
957 * @return array Modified Command-array
958 */
959 function makePasteCmdArray($ref,$CMD) {
960 list($pTable,$pUid) = explode('|',$ref);
961 $pUid = intval($pUid);
962
963 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)
964 $elements = $this->elFromTable($pTable);
965
966 $elements = array_reverse($elements); // So the order is preserved.
967 $mode = $this->currentMode()=='copy' ? 'copy' : 'move';
968
969 // Traverse elements and make CMD array
970 reset($elements);
971 while(list($tP)=each($elements)) {
972 list($table,$uid) = explode('|',$tP);
973 if (!is_array($CMD[$table])) $CMD[$table]=array();
974 $CMD[$table][$uid][$mode]=$pUid;
975 if ($mode=='move') $this->removeElement($tP);
976 }
977 $this->endClipboard();
978 }
979 return $CMD;
980 }
981
982 /**
983 * Delete record entries in CMD array
984 *
985 * @param array Command-array
986 * @return array Modified Command-array
987 */
988 function makeDeleteCmdArray($CMD) {
989 $elements = $this->elFromTable(''); // all records
990 reset($elements);
991 while(list($tP)=each($elements)) {
992 list($table,$uid) = explode('|',$tP);
993 if (!is_array($CMD[$table])) $CMD[$table]=array();
994 $CMD[$table][$uid]['delete']=1;
995 $this->removeElement($tP);
996 }
997 $this->endClipboard();
998 return $CMD;
999 }
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017 /*****************************************
1018 *
1019 * FOR USE IN tce_file.php:
1020 *
1021 ****************************************/
1022
1023 /**
1024 * Applies the proper paste configuration in the $file array send to tce_file.php.
1025 * The current pad is pasted
1026 *
1027 * @param string Reference to element (splitted by "|")
1028 * @param array Command-array
1029 * @return array Modified Command-array
1030 */
1031 function makePasteCmdArray_file($ref,$FILE) {
1032 list($pTable,$pUid) = explode('|',$ref);
1033 $elements = $this->elFromTable('_FILE');
1034 $mode = $this->currentMode()=='copy' ? 'copy' : 'move';
1035
1036 // Traverse elements and make CMD array
1037 reset($elements);
1038 while(list($tP,$path)=each($elements)) {
1039 $FILE[$mode][]=array('data'=>$path,'target'=>$pUid,'altName'=>1);
1040 if ($mode=='move') $this->removeElement($tP);
1041 }
1042 $this->endClipboard();
1043
1044 return $FILE;
1045 }
1046
1047 /**
1048 * Delete files in CMD array
1049 *
1050 * @param array Command-array
1051 * @return array Modified Command-array
1052 */
1053 function makeDeleteCmdArray_file($FILE) {
1054 $elements = $this->elFromTable('_FILE');
1055 // Traverse elements and make CMD array
1056 reset($elements);
1057 while(list($tP,$path)=each($elements)) {
1058 $FILE['delete'][]=array('data'=>$path);
1059 $this->removeElement($tP);
1060 }
1061 $this->endClipboard();
1062
1063 return $FILE;
1064 }
1065 }
1066
1067
1068
1069 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_clipboard.php']) {
1070 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_clipboard.php']);
1071 }
1072
1073 ?>