Updates mainly to import/export extension. Many smaller changes / additions. See...
[Packages/TYPO3.CMS.git] / typo3 / alt_shortcut.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2004 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 * Shortcut frame
29 * Appears in the bottom frame of the backend frameset.
30 * Provides links to registered shortcuts
31 * If the 'cms' extension is loaded you will also have a field for entering page id/alias which will be found/edited
32 *
33 * $Id$
34 * Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj
35 * XHTML compliant output
36 *
37 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
38 */
39 /**
40 * [CLASS/FUNCTION INDEX of SCRIPT]
41 *
42 *
43 *
44 * 82: class SC_alt_shortcut
45 * 118: function preinit()
46 * 143: function preprocess()
47 * 200: function init()
48 * 234: function main()
49 * 335: function editLoadedFunc()
50 * 396: function editPageIdFunc()
51 * 438: function printContent()
52 *
53 * SECTION: OTHER FUNCTIONS:
54 * 466: function mIconFilename($Ifilename,$backPath)
55 * 479: function getIcon($modName)
56 * 503: function itemLabel($inlabel,$modName,$M_modName='')
57 *
58 * TOTAL FUNCTIONS: 10
59 * (This index is automatically created/updated by the extension "extdeveval")
60 *
61 */
62
63
64 require('init.php');
65 require('template.php');
66 $LANG->includeLLFile('EXT:lang/locallang_misc.xml');
67 require_once(PATH_t3lib.'class.t3lib_loadmodules.php');
68 require_once(PATH_t3lib.'class.t3lib_basicfilefunc.php');
69
70
71
72
73
74
75 /**
76 * Script Class for the shortcut frame, bottom frame of the backend frameset
77 *
78 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
79 * @package TYPO3
80 * @subpackage core
81 */
82 class SC_alt_shortcut {
83
84 // Internal, static: GPvar
85 var $modName;
86 var $M_modName;
87 var $URL;
88 var $editSC;
89 var $deleteCategory;
90 var $editName;
91 var $editGroup;
92 var $whichItem;
93
94 // Internal, static:
95 var $loadModules; // Modules object
96 var $doc; // Document template object
97 var $nGroups; // Number of groups
98 var $nGlobals; // Number of globals
99
100 // Internal, dynamic:
101 var $content; // Accumulation of output HTML (string)
102 var $lines; // Accumulation of table cells (array)
103
104 var $editLoaded; // Flag for defining whether we are editing
105 var $editError; // Can contain edit error message
106 var $editPath; // Set to the record path of the record being edited.
107 var $editSC_rec; // Holds the shortcut record when editing
108 var $theEditRec; // Page record to be edited
109 var $editPage; // Page alias or id to be edited
110 var $selOpt; // Select options.
111
112 var $alternativeTableUid = array(); // Array with key 0/1 being table/uid of record to edit. Internally set.
113
114
115
116 /**
117 * Pre-initialization - setting input variables for storing shortcuts etc.
118 *
119 * @return void
120 */
121 function preinit() {
122 global $TBE_MODULES;
123
124 // Setting GPvars:
125 $this->modName = t3lib_div::_GP('modName');
126 $this->M_modName = t3lib_div::_GP('motherModName');
127 $this->URL = t3lib_div::_GP('URL');
128 $this->editSC = t3lib_div::_GP('editShortcut');
129
130 $this->deleteCategory = t3lib_div::_GP('deleteCategory');
131 $this->editPage = t3lib_div::_GP('editPage');
132 $this->editName = t3lib_div::_GP('editName');
133 $this->editGroup = t3lib_div::_GP('editGroup');
134 $this->whichItem = t3lib_div::_GP('whichItem');
135
136 // Creating modules object
137 $this->loadModules = t3lib_div::makeInstance('t3lib_loadModules');
138 $this->loadModules->load($TBE_MODULES);
139 }
140
141 /**
142 * Adding shortcuts, editing shortcuts etc.
143 *
144 * @return void
145 */
146 function preprocess() {
147 global $BE_USER;
148
149 // Adding a shortcut being set from another frame
150 if ($this->modName && $this->URL) {
151 $fields_values = array(
152 'userid' => $BE_USER->user['uid'],
153 'module_name' => $this->modName.'|'.$this->M_modName,
154 'url' => $this->URL,
155 'sorting' => time()
156 );
157 $GLOBALS['TYPO3_DB']->exec_INSERTquery('sys_be_shortcuts', $fields_values);
158 }
159
160 // Selection-clause for users - so users can deleted only their own shortcuts (except admins)
161 $addUSERWhere = (!$BE_USER->isAdmin()?' AND userid='.intval($BE_USER->user['uid']):'');
162
163 // Deleting shortcuts:
164 if (strcmp($this->deleteCategory,'')) {
165 if (t3lib_div::testInt($this->deleteCategory)) {
166 $GLOBALS['TYPO3_DB']->exec_DELETEquery('sys_be_shortcuts', 'sc_group='.intval($this->deleteCategory).$addUSERWhere);
167 }
168 }
169
170 // If other changes in post-vars:
171 if (is_array($_POST)) {
172 // Saving:
173 if (isset($_POST['_savedok_x']) || isset($_POST['_saveclosedok_x'])) {
174 $fields_values = array(
175 'description' => $this->editName,
176 'sc_group' => intval($this->editGroup)
177 );
178 if ($fields_values['sc_group']<0 && !$BE_USER->isAdmin()) {
179 $fields_values['sc_group']=0;
180 }
181
182 $GLOBALS['TYPO3_DB']->exec_UPDATEquery('sys_be_shortcuts', 'uid='.intval($this->whichItem).$addUSERWhere, $fields_values);
183 }
184 // If save without close, keep the session going...
185 if (isset($_POST['_savedok_x'])) {
186 $this->editSC=$this->whichItem;
187 }
188 // Deleting a single shortcut ?
189 if (isset($_POST['_deletedok_x'])) {
190 $GLOBALS['TYPO3_DB']->exec_DELETEquery('sys_be_shortcuts', 'uid='.intval($this->whichItem).$addUSERWhere);
191
192 if (!$this->editSC) $this->editSC=-1; // Just to have the checkbox set...
193 }
194 }
195
196 }
197
198 /**
199 * Initialize (page output)
200 *
201 * @return void
202 */
203 function init() {
204 global $BACK_PATH;
205
206 $this->doc = t3lib_div::makeInstance('template');
207 $this->doc->backPath = $BACK_PATH;
208 $this->doc->form='<form action="alt_shortcut.php" name="shForm" method="post">';
209 $this->doc->docType='xhtml_trans';
210 $this->doc->divClass='typo3-shortcut';
211 $this->doc->JScode.=$this->doc->wrapScriptTags('
212 function jump(url,modName,mainModName) { //
213 // Clear information about which entry in nav. tree that might have been highlighted.
214 top.fsMod.navFrameHighlightedID = new Array();
215 if (top.content && top.content.nav_frame && top.content.nav_frame.refresh_nav) {
216 top.content.nav_frame.refresh_nav();
217 }
218
219 top.nextLoadModuleUrl = url;
220 top.goToModule(modName);
221 }
222 function editSh(uid) { //
223 document.location="alt_shortcut.php?editShortcut="+uid;
224 }
225 function submitEditPage(id) { //
226 document.location="alt_shortcut.php?editPage="+top.rawurlencode(id);
227 }
228 ');
229 $this->content.=$this->doc->startPage('Shortcut frame');
230 }
231
232 /**
233 * Main function, creating content in the frame
234 *
235 * @return void
236 */
237 function main() {
238 global $BE_USER,$LANG,$TCA;
239
240 // Setting groups and globals
241 $this->nGroups=4;
242 $this->nGlobals=5;
243
244 $globalGroups=array(-100);
245 $shortCutGroups = $BE_USER->getTSConfig('options.shortcutGroups');
246 for($a=1;$a<=$this->nGlobals;$a++) {
247 if ($BE_USER->isAdmin() || strcmp($shortCutGroups['properties'][$a],'')) {
248 $globalGroups[]=-$a;
249 }
250 }
251
252 // Fetching shortcuts to display for this user:
253 $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', 'sys_be_shortcuts', '((userid='.$BE_USER->user['uid'].' AND sc_group>=0) OR sc_group IN ('.implode(',',$globalGroups).'))', '', 'sc_group,sorting');
254
255 // Init vars:
256 $this->lines=array();
257 $this->editSC_rec='';
258 $this->selOpt=array();
259 $formerGr='';
260
261 // Traverse shortcuts
262 while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
263 if ($this->editSC && $row['uid']==$this->editSC) {
264 $this->editSC_rec=$row;
265 }
266
267 if (strcmp($formerGr,$row['sc_group'])) {
268 if ($row['sc_group']!=-100) {
269 if ($row['sc_group']>=0) {
270 $onC = 'if (confirm('.$GLOBALS['LANG']->JScharCode($LANG->getLL('shortcut_delAllInCat')).')){document.location=\'alt_shortcut.php?deleteCategory='.$row['sc_group'].'\';}return false;';
271 $this->lines[]='<td>&nbsp;</td><td class="bgColor5"><a href="#" onclick="'.htmlspecialchars($onC).'" title="'.$LANG->getLL('shortcut_delAllInCat',1).'">'.abs($row['sc_group']).'</a></td>';
272 } else {
273 $this->lines[]='<td>&nbsp;</td><td class="bgColor5">'.abs($row['sc_group']).'</td>';
274 }
275 }
276 }
277
278 $mParts = explode('|',$row['module_name']);
279 $row['module_name']=$mParts[0];
280 $row['M_module_name']=$mParts[1];
281 $mParts = explode('_',$row['M_module_name']?$row['M_module_name']:$row['module_name']);
282 $qParts = parse_url($row['url']);
283
284 $bgColorClass = $row['uid']==$this->editSC ? 'bgColor5' : ($row['sc_group']<0 ? 'bgColor6' : 'bgColor4');
285 $titleA = $this->itemLabel($row['description']&&($row['uid']!=$this->editSC) ? $row['description'] : t3lib_div::fixed_lgd(rawurldecode($qParts['query']),150),$row['module_name'],$row['M_module_name']);
286
287 $editSH = ($row['sc_group']>=0 || $BE_USER->isAdmin()) ? 'editSh('.intval($row['uid']).');' : "alert('".$LANG->getLL('shortcut_onlyAdmin')."')";
288 $jumpSC = 'jump(unescape(\''.rawurlencode($row['url']).'\'),\''.implode('_',$mParts).'\',\''.$mParts[0].'\');';
289 $onC = 'if (document.shForm.editShortcut_check && document.shForm.editShortcut_check.checked){'.$editSH.'}else{'.$jumpSC.'}return false;';
290 $this->lines[]='<td class="'.$bgColorClass.'"><a href="#" onclick="'.htmlspecialchars($onC).'"><img src="'.$this->getIcon($row['module_name']).'" title="'.htmlspecialchars($titleA).'" alt="" /></a></td>';
291 if (trim($row['description'])) {
292 $kkey = strtolower(substr($row['description'],0,20)).'_'.$row['uid'];
293 $this->selOpt[$kkey]='<option value="'.htmlspecialchars($jumpSC).'">'.htmlspecialchars(t3lib_div::fixed_lgd_cs($row['description'],50)).'</option>';
294 }
295 $formerGr=$row['sc_group'];
296 }
297 ksort($this->selOpt);
298 array_unshift($this->selOpt,'<option>['.$LANG->getLL('shortcut_selSC',1).']</option>');
299
300 $this->editLoadedFunc();
301 $this->editPageIdFunc();
302
303 if (!$this->editLoaded && t3lib_extMgm::isLoaded('cms')) {
304 $editIdCode = '<td nowrap="nowrap">'.$LANG->getLL('shortcut_editID',1).': <input type="text" value="'.($this->editError?htmlspecialchars($this->editPage):'').'" name="editPage"'.$this->doc->formWidth(5).' onchange="submitEditPage(this.value);" />'.
305 ($this->editError?'&nbsp;<strong><span class="typo3-red">'.htmlspecialchars($this->editError).'</span></strong>':'').
306 (is_array($this->theEditRec)?'&nbsp;<strong>'.$LANG->getLL('shortcut_loadEdit',1).' \''.t3lib_BEfunc::getRecordTitle('pages',$this->theEditRec,1).'\'</strong> ('.htmlspecialchars($this->editPath).')':'').
307 '</td>';
308 } else $editIdCode = '';
309
310 // Adding CSH:
311 $editIdCode.= '<td>&nbsp;'.t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'shortcuts', $GLOBALS['BACK_PATH'],'',TRUE).'</td>';
312
313 $this->content.='
314
315
316 <!--
317 Shortcut Display Table:
318 -->
319 <table border="0" cellpadding="0" cellspacing="2" id="typo3-shortcuts">
320 <tr>
321 '.implode('
322 ',$this->lines).$editIdCode.'
323 </tr>
324 </table>
325
326 ';
327
328 // Launch Edit page:
329 if ($this->theEditRec['uid']) {
330 $this->content.=$this->doc->wrapScriptTags('top.loadEditId('.$this->theEditRec['uid'].');');
331 }
332
333 // Load alternative table/uid into editing form.
334 if (count($this->alternativeTableUid)==2 && isset($TCA[$this->alternativeTableUid[0]]) && t3lib_div::testInt($this->alternativeTableUid[1])) {
335 $JSaction = t3lib_BEfunc::editOnClick('&edit['.$this->alternativeTableUid[0].']['.$this->alternativeTableUid[1].']=edit','','dummy.php');
336 $this->content.=$this->doc->wrapScriptTags('function editArbitraryElement() { top.content.'.$JSaction.'; } editArbitraryElement();');
337 }
338 }
339
340 /**
341 * Creates lines for the editing form.
342 *
343 * @return void
344 */
345 function editLoadedFunc() {
346 global $BE_USER,$LANG;
347
348 $this->editLoaded=0;
349 if (is_array($this->editSC_rec) && ($this->editSC_rec['sc_group']>=0 || $BE_USER->isAdmin())) { // sc_group numbers below 0 requires admin to edit those. sc_group numbers above zero must always be owned by the user himself.
350 $this->editLoaded=1;
351
352 $opt=array();
353 $opt[]='<option value="0"></option>';
354 for($a=1;$a<=$this->nGroups;$a++) {
355 $opt[]='<option value="'.$a.'"'.(!strcmp($this->editSC_rec['sc_group'],$a)?' selected="selected"':'').'>'.$LANG->getLL('shortcut_group',1).' '.$a.'</option>';
356 }
357 if ($BE_USER->isAdmin()) {
358 for($a=1;$a<=$this->nGlobals;$a++) {
359 $opt[]='<option value="-'.$a.'"'.(!strcmp($this->editSC_rec['sc_group'],'-'.$a)?' selected="selected"':'').'>'.$LANG->getLL('shortcut_GLOBAL',1).': '.$a.'</option>';
360 }
361 $opt[]='<option value="-100"'.(!strcmp($this->editSC_rec['sc_group'],'-100')?' selected="selected"':'').'>'.$LANG->getLL('shortcut_GLOBAL',1).': '.$LANG->getLL('shortcut_ALL',1).'</option>';
362 }
363
364 // border="0" hspace="2" width="21" height="16" - not XHTML compliant in <input type="image" ...>
365 $manageForm='
366
367
368 <!--
369 Shortcut Editing Form:
370 -->
371 <table border="0" cellpadding="0" cellspacing="0" id="typo3-shortcuts-editing">
372 <tr>
373 <td>&nbsp;&nbsp;</td>
374 <td><input type="image" class="c-inputButton" name="_savedok"'.t3lib_iconWorks::skinImg($this->doc->backPath,'gfx/savedok.gif','').' title="'.$LANG->getLL('shortcut_save',1).'" /></td>
375 <td><input type="image" class="c-inputButton" name="_saveclosedok"'.t3lib_iconWorks::skinImg($this->doc->backPath,'gfx/saveandclosedok.gif','').' title="'.$LANG->getLL('shortcut_saveClose',1).'" /></td>
376 <td><input type="image" class="c-inputButton" name="_closedok"'.t3lib_iconWorks::skinImg($this->doc->backPath,'gfx/closedok.gif','').' title="'.$LANG->getLL('shortcut_close',1).'" /></td>
377 <td><input type="image" class="c-inputButton" name="_deletedok"'.t3lib_iconWorks::skinImg($this->doc->backPath,'gfx/deletedok.gif','').' title="'.$LANG->getLL('shortcut_delete',1).'" /></td>
378 <td><input name="editName" type="text" value="'.htmlspecialchars($this->editSC_rec['description']).'"'.$this->doc->formWidth(15).' /></td>
379 <td><select name="editGroup">'.implode('',$opt).'</select></td>
380 </tr>
381 </table>
382 <input type="hidden" name="whichItem" value="'.$this->editSC_rec['uid'].'" />
383
384 ';
385 } else $manageForm='';
386 //debug(count($opt));
387 if (!$this->editLoaded && count($this->selOpt)>1) {
388 $this->lines[]='<td>&nbsp;</td>';
389 $this->lines[]='<td><select name="_selSC" onchange="eval(this.options[this.selectedIndex].value);this.selectedIndex=0;">'.implode('',$this->selOpt).'</select></td>';
390 }
391 if (count($this->lines)) {
392 if (!$BE_USER->getTSConfigVal('options.mayNotCreateEditShortcuts')) {
393 $this->lines=array_merge(array('<td><input type="checkbox" name="editShortcut_check" value="1"'.($this->editSC?' checked="checked"':'').' />'.$LANG->getLL('shortcut_edit',1).'&nbsp;</td>'),$this->lines);
394 $this->lines[]='<td>'.$manageForm.'</td>';
395 }
396 $this->lines[]='<td><img src="clear.gif" width="10" height="1" alt="" /></td>';
397 }
398 }
399
400 /**
401 * If "editPage" value is sent to script and it points to an accessible page, the internal var $this->theEditRec is set to the page record which should be loaded.
402 * Returns void
403 *
404 * @return void
405 */
406 function editPageIdFunc() {
407 global $BE_USER,$LANG;
408
409 if (!t3lib_extMgm::isLoaded('cms')) return;
410
411 // EDIT page:
412 $this->editPage = trim(strtolower($this->editPage));
413 $this->editError = '';
414 $this->theEditRec = '';
415 if ($this->editPage) {
416
417 // First, test alternative value consisting of [table]:[uid] and if not found, proceed with traditional page ID resolve:
418 $this->alternativeTableUid = explode(':',$this->editPage);
419 if (!(count($this->alternativeTableUid)==2 && $BE_USER->isAdmin())) { // We restrict it to admins only just because I'm not really sure if alt_doc.php properly checks permissions of passed records for editing. If alt_doc.php does that, then we can remove this.
420
421 $where = ' AND ('.$BE_USER->getPagePermsClause(2).' OR '.$BE_USER->getPagePermsClause(16).')';
422 if (t3lib_div::testInt($this->editPage)) {
423 $this->theEditRec = t3lib_BEfunc::getRecord ('pages',$this->editPage,'*',$where);
424 } else {
425 $records = t3lib_BEfunc::getRecordsByField('pages','alias',$this->editPage,$where);
426 if (is_array($records)) {
427 reset($records);
428 $this->theEditRec = current($records);
429 }
430 }
431 if (!is_array($this->theEditRec) || !$BE_USER->isInWebMount($this->theEditRec['uid'])) {
432 unset($this->theEditRec);
433 $this->editError=$LANG->getLL('shortcut_notEditable');
434 } else {
435 // Visual path set:
436 $perms_clause = $BE_USER->getPagePermsClause(1);
437 $this->editPath = t3lib_BEfunc::getRecordPath($this->theEditRec['pid'], $perms_clause, 30);
438
439 if(!$BE_USER->getTSConfigVal('options.shortcut_onEditId_dontSetPageTree')) {
440
441 // Expanding page tree:
442 t3lib_BEfunc::openPageTree($this->theEditRec['pid'],!$BE_USER->getTSConfigVal('options.shortcut_onEditId_keepExistingExpanded'));
443 }
444 }
445 }
446 }
447 }
448
449 /**
450 * Outputting the accumulated content to screen
451 *
452 * @return void
453 */
454 function printContent() {
455 $this->content.= $this->doc->endPage();
456 echo $this->content;
457 }
458
459
460
461
462
463
464
465
466
467
468
469 /***************************
470 *
471 * OTHER FUNCTIONS:
472 *
473 ***************************/
474
475 /**
476 * Returns relative filename for icon.
477 *
478 * @param string Absolute filename of the icon
479 * @param string Backpath string to prepend the icon after made relative
480 * @return void
481 */
482 function mIconFilename($Ifilename,$backPath) {
483 if (t3lib_div::isAbsPath($Ifilename)) {
484 $Ifilename = '../'.substr($Ifilename,strlen(PATH_site));
485 }
486 return $backPath.$Ifilename;
487 }
488
489 /**
490 * Returns icon for shortcut display
491 *
492 * @param string Backend module name
493 * @return string Icon file name
494 */
495 function getIcon($modName) {
496 global $LANG;
497 if ($LANG->moduleLabels['tabs_images'][$modName.'_tab']) {
498 $icon = $this->mIconFilename($LANG->moduleLabels['tabs_images'][$modName.'_tab'],'');
499 } elseif ($modName=='xMOD_alt_doc.php') {
500 $icon = 'gfx/edit2.gif';
501 } elseif ($modName=='xMOD_file_edit.php') {
502 $icon = 'gfx/edit_file.gif';
503 } elseif ($modName=='xMOD_wizard_rte.php') {
504 $icon = 'gfx/edit_rtewiz.gif';
505 } else {
506 $icon = 'gfx/dummy_module.gif';
507 }
508 return $icon;
509 }
510
511 /**
512 * Returns title-label for icon
513 *
514 * @param string In-label
515 * @param string Backend module name (key)
516 * @param string Backend module label (user defined?)
517 * @return string Label for the shortcut item
518 */
519 function itemLabel($inlabel,$modName,$M_modName='') {
520 global $LANG;
521 if (substr($modName,0,5)=='xMOD_') {
522 $label=substr($modName,5);
523 } else {
524 $split = explode('_',$modName);
525 $label = $LANG->moduleLabels['tabs'][$split[0].'_tab'];
526 if (count($split)>1) {
527 $label.='>'.$LANG->moduleLabels['tabs'][$modName.'_tab'];
528 }
529 }
530 if ($M_modName) $label.=' ('.$M_modName.')';
531 $label.=': '.$inlabel;
532 return $label;
533 }
534 }
535
536 // Include extension?
537 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_shortcut.php']) {
538 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/alt_shortcut.php']);
539 }
540
541
542
543
544
545
546
547
548
549
550
551 // Make instance:
552 $SOBE = t3lib_div::makeInstance('SC_alt_shortcut');
553 $SOBE->preinit();
554 $SOBE->preprocess();
555 $SOBE->init();
556 $SOBE->main();
557 $SOBE->printContent();
558 ?>