[TASK] Clean-up several whitespaces and PHPdoc comments
[Packages/TYPO3.CMS.git] / typo3 / file_rename.php
old mode 100755 (executable)
new mode 100644 (file)
index 89028c4..af2a024
@@ -2,7 +2,7 @@
 /***************************************************************
 *  Copyright notice
 *
-*  (c) 1999-2004 Kasper Skaarhoj (kasperYYYY@typo3.com)
+*  (c) 1999-2011 Kasper Skårhøj (kasperYYYY@typo3.com)
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 /**
  * Web>File: Renaming files and folders
  *
- * $Id$
- * Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj
- *
- * @author     Kasper Skaarhoj <kasperYYYY@typo3.com>
- */
-/**
- * [CLASS/FUNCTION INDEX of SCRIPT]
- *
- *
- *
- *   74: class SC_file_rename
- *   96:     function init()
- *  149:     function main()
- *  194:     function printContent()
- *
- * TOTAL FUNCTIONS: 3
- * (This index is automatically created/updated by the extension "extdeveval")
+ * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
  *
+ * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
 
 $BACK_PATH = '';
 require('init.php');
 require('template.php');
-require_once(PATH_t3lib.'class.t3lib_basicfilefunc.php');
-
-
-
-
-
-
-
-
 
 
 
 /**
  * Script Class for the rename-file form.
  *
- * @author     Kasper Skaarhoj <kasperYYYY@typo3.com>
+ * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage core
  */
 class SC_file_rename {
 
                // Internal, static:
-       var $doc;                       // Template object.
-       var $basicff;           // Instance of "t3lib_basicFileFunctions"
+       /**
+        * Document template object
+        *
+        * @var smallDoc
+        */
+       var $doc;
+
+       /**
+        * File processing object
+        *
+        * @var t3lib_basicFileFunctions
+        */
+       var $basicff;
        var $icon;                      // Will be set to the proper icon for the $target value.
        var $shortPath;         // Relative path to current found filemount
        var $title;                     // Name of the filemount
@@ -94,46 +81,51 @@ class SC_file_rename {
         * @return      void
         */
        function init() {
-               global $LANG,$BACK_PATH,$TYPO3_CONF_VARS;
-
                        // Initialize GPvars:
                $this->target = t3lib_div::_GP('target');
-               $this->returnUrl = t3lib_div::_GP('returnUrl');
+               $this->returnUrl = t3lib_div::sanitizeLocalUrl(t3lib_div::_GP('returnUrl'));
 
                        // Init basic-file-functions object:
                $this->basicff = t3lib_div::makeInstance('t3lib_basicFileFunctions');
-               $this->basicff->init($GLOBALS['FILEMOUNTS'],$TYPO3_CONF_VARS['BE']['fileExtensions']);
+               $this->basicff->init($GLOBALS['FILEMOUNTS'],$GLOBALS['TYPO3_CONF_VARS']['BE']['fileExtensions']);
 
                        // Cleaning and checking target
-               if (@file_exists($this->target))        {
+               if (file_exists($this->target)) {
                        $this->target=$this->basicff->cleanDirectoryName($this->target);                // Cleaning and checking target (file or dir)
                } else {
                        $this->target='';
                }
                $key=$this->basicff->checkPathAgainstMounts($this->target.'/');
-               if (!$this->target || !$key)    {
-                       t3lib_BEfunc::typo3PrintError ('Parameter Error','Target was not a directory!','');
-                       exit;
+               if (!$this->target || !$key) {
+                       $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_file_list.xml:paramError', TRUE);
+                       $message = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_file_list.xml:targetNoDir', TRUE);
+                       throw new RuntimeException($title . ': ' . $message, 1294586844);
                }
 
                        // Finding the icon
-               switch($GLOBALS['FILEMOUNTS'][$key]['type'])    {
-                       case 'user':    $this->icon = 'gfx/i/_icon_ftp_user.gif';       break;
-                       case 'group':   $this->icon = 'gfx/i/_icon_ftp_group.gif';      break;
-                       default:                $this->icon = 'gfx/i/_icon_ftp.gif';    break;
+               switch($GLOBALS['FILEMOUNTS'][$key]['type']) {
+                       case 'user':
+                               $this->icon = 'gfx/i/_icon_ftp_user.gif';
+                               break;
+                       case 'group':
+                               $this->icon = 'gfx/i/_icon_ftp_group.gif';
+                               break;
+                       default:
+                               $this->icon = 'gfx/i/_icon_ftp.gif';
                }
 
+               $this->icon = '<img'.t3lib_iconWorks::skinImg($this->backPath,$this->icon,'width="18" height="16"').' title="" alt="" />';
+
                        // Relative path to filemount, $key:
                $this->shortPath = substr($this->target,strlen($GLOBALS['FILEMOUNTS'][$key]['path']));
 
                        // Setting title:
-               $this->title = $GLOBALS['FILEMOUNTS'][$key]['name'].': '.$this->shortPath;
+               $this->title = $this->icon . htmlspecialchars($GLOBALS['FILEMOUNTS'][$key]['name']) . ': ' . $this->shortPath;
 
                        // Setting template object
-               $this->doc = t3lib_div::makeInstance('smallDoc');
-               $this->doc->docType = 'xhtml_trans';
-               $this->doc->backPath = $BACK_PATH;
-               $this->doc->form='<form action="tce_file.php" method="post" name="editform">';
+               $this->doc = t3lib_div::makeInstance('template');
+               $this->doc->setModuleTemplate('templates/file_rename.html');
+               $this->doc->backPath = $GLOBALS['BACK_PATH'];
                $this->doc->JScode=$this->doc->wrapScriptTags('
                        function backToList()   {       //
                                top.goToModule("file_list");
@@ -147,19 +139,19 @@ class SC_file_rename {
         * @return      void
         */
        function main() {
-               global $LANG;
+               //TODO: change locallang*.php to locallang*.xml
 
                        // Make page header:
-               $this->content='';
-               $this->content.=$this->doc->startPage($LANG->sL('LLL:EXT:lang/locallang_core.php:file_rename.php.pagetitle'));
-               $this->content.=$this->doc->header($LANG->sL('LLL:EXT:lang/locallang_core.php:file_rename.php.pagetitle'));
-               $this->content.=$this->doc->spacer(5);
-               $this->content.=$this->doc->section('',$this->doc->getFileheader($this->title,$this->shortPath,$this->icon));
-               $this->content.=$this->doc->divider(5);
+               $this->content = $this->doc->startPage($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:file_rename.php.pagetitle'));
+
+               $pageContent = $this->doc->header($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:file_rename.php.pagetitle'));
+               $pageContent .= $this->doc->spacer(5);
+               $pageContent .= $this->doc->divider(5);
 
 
+               $code = '<form action="tce_file.php" method="post" name="editform">';
                        // Making the formfields for renaming:
-               $code='
+               $code .= '
 
                        <div id="c-rename">
                                <input type="text" name="file[rename][0][data]" value="'.htmlspecialchars(basename($this->shortPath)).'"'.$GLOBALS['TBE_TEMPLATE']->formWidth(20).' />
@@ -170,20 +162,31 @@ class SC_file_rename {
                        // Making submit button:
                $code.='
                        <div id="c-submit">
-                               <input type="submit" value="'.$LANG->sL('LLL:EXT:lang/locallang_core.php:file_rename.php.submit',1).'" />
-                               <input type="submit" value="'.$LANG->sL('LLL:EXT:lang/locallang_core.php:labels.cancel',1).'" onclick="backToList(); return false;" />
+                               <input type="submit" value="' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:file_rename.php.submit', 1) . '" />
+                               <input type="submit" value="' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.cancel', 1) . '" onclick="backToList(); return false;" />
                                <input type="hidden" name="redirect" value="'.htmlspecialchars($this->returnUrl).'" />
                        </div>
                ';
 
-                       // CSH:
-               $code.= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'file_rename', $GLOBALS['BACK_PATH'],'<br/>');
+               $code .= '</form>';
 
                        // Add the HTML as a section:
-               $this->content.= $this->doc->section('',$code);
+               $pageContent .= $code;
 
-                       // Ending page
+               $docHeaderButtons = array();
+               $docHeaderButtons['csh'] = t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'file_rename', $GLOBALS['BACK_PATH']);
+
+                       // Add the HTML as a section:
+               $markerArray = array(
+                       'CSH' => $docHeaderButtons['csh'],
+                       'FUNC_MENU' => t3lib_BEfunc::getFuncMenu($this->id, 'SET[function]', $this->MOD_SETTINGS['function'], $this->MOD_MENU['function']),
+                       'CONTENT' => $pageContent,
+                       'PATH' => $this->title,
+               );
+
+               $this->content.= $this->doc->moduleBody(array(), $docHeaderButtons, $markerArray);
                $this->content.= $this->doc->endPage();
+               $this->content = $this->doc->insertStylesAndJS($this->content);
        }
 
        /**
@@ -192,24 +195,14 @@ class SC_file_rename {
         * @return      void
         */
        function printContent() {
-
                echo $this->content;
        }
 }
 
-// Include extension?
-if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/file_rename.php'])  {
-       include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/file_rename.php']);
-}
-
-
-
-
-
-
-
-
 
+if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/file_rename.php'])) {
+       include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/file_rename.php']);
+}
 
 
 
@@ -218,4 +211,5 @@ $SOBE = t3lib_div::makeInstance('SC_file_rename');
 $SOBE->init();
 $SOBE->main();
 $SOBE->printContent();
+
 ?>
\ No newline at end of file