[TASK] Clean up phpDoc comments in typo3/
[Packages/TYPO3.CMS.git] / typo3 / file_newfolder.php
index 8e7e273..83093c7 100644 (file)
@@ -2,7 +2,7 @@
 /***************************************************************
 *  Copyright notice
 *
-*  (c) 1999-2009 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
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Web>File: Create new folders in the filemounts
  *
- * $Id$
- * Revised for TYPO3 3.6 November/2003 by Kasper Skaarhoj
+ * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skaarhoj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
-/**
- * [CLASS/FUNCTION INDEX of SCRIPT]
- *
- *
- *
- *   74: class SC_file_newfolder
- *  101:     function init()
- *  161:     function main()
- *  255:     function printContent()
- *
- * TOTAL FUNCTIONS: 3
- * (This index is automatically created/updated by the extension "extdeveval")
- *
- */
-
-
 
 $BACK_PATH = '';
 require('init.php');
 require('template.php');
-require_once(PATH_t3lib.'class.t3lib_basicfilefunc.php');
-require_once(PATH_t3lib.'class.t3lib_parsehtml.php');
-
-
-
-
-
-
-
-
-
 
 /**
  * Script Class for the create-new script; Displays a form for creating up to 10 folders or one new text file
  *
- * @author     Kasper Skaarhoj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage core
  */
 class SC_file_newfolder {
 
                // External, static:
-       var $folderNumber=10;
+       var $folderNumber = 10;
 
                // Internal, static:
        /**
@@ -83,94 +56,68 @@ class SC_file_newfolder {
         * @var smallDoc
         */
        var $doc;
+               // Name of the filemount
+       var $title;
 
-       /**
-        * 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
+               // Internal, static (GPVar):
+       var $number;
+               // Set with the target path inputted in &target
+       var $target;
 
        /**
-        * Charset processing object
+        * The folder object which is  the target directory
         *
-        * @var t3lib_cs
+        * @var t3lib_file_Folder $folderObject
         */
-       protected $charsetConversion;
-
-               // Internal, static (GPVar):
-       var $number;
-       var $target;            // Set with the target path inputted in &target
-       var $returnUrl;         // Return URL of list module.
+       protected $folderObject;
+               // Return URL of list module.
+       var $returnUrl;
 
                // Internal, dynamic:
-       var $content;           // Accumulating content
-
-
+               // Accumulating content
+       var $content;
 
        /**
         * Constructor function for class
         *
-        * @return      void
+        * @return void
         */
-       function init() {
-               global $LANG,$BACK_PATH,$TYPO3_CONF_VARS;
-
+       function init() {
                        // Initialize GPvars:
                $this->number = t3lib_div::_GP('number');
-               $this->target = t3lib_div::_GP('target');
-               $this->returnUrl = 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']);
-
-                       // Init basic-charset-functions object:
-               $this->charsetConversion = t3lib_div::makeInstance('t3lib_cs');
-
-                       // Cleaning and checking target
-               $this->target = $this->charsetConversion->conv($this->target, 'utf-8', $GLOBALS['LANG']->charSet);
-               $this->target = $this->basicff->is_directory($this->target);
-               $key=$this->basicff->checkPathAgainstMounts($this->target.'/');
-               if (!$this->target || !$key)    {
-                       t3lib_BEfunc::typo3PrintError ($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_file_list.xml:paramError', true), $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_file_list.xml:targetNoDir', true), '');
-                       exit;
-               }
+               $this->target = $combinedIdentifier = t3lib_div::_GP('target');
+               $this->returnUrl = t3lib_div::sanitizeLocalUrl(t3lib_div::_GP('returnUrl'));
 
-                       // 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;
+                       // create the folder object
+               if ($combinedIdentifier) {
+                       $this->folderObject = t3lib_file_Factory::getInstance()->getFolderObjectFromCombinedIdentifier($combinedIdentifier);
                }
 
-               $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']));
+                       // Cleaning and checking target directory
+               if (!$this->folderObject) {
+                       $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, 1294586843);
+               }
 
-                       // Setting title:
-               $this->title = $this->icon.$GLOBALS['FILEMOUNTS'][$key]['name'].': '.$this->shortPath;
+                       // Setting the title and the icon
+               $icon = t3lib_iconWorks::getSpriteIcon('apps-filetree-root');
+               $this->title = $icon . htmlspecialchars($this->folderObject->getStorage()->getName()) . ': ' . htmlspecialchars($this->folderObject->getIdentifier());
 
                        // Setting template object
                $this->doc = t3lib_div::makeInstance('template');
                $this->doc->setModuleTemplate('templates/file_newfolder.html');
-               $this->doc->backPath = $BACK_PATH;
-               $this->doc->JScode=$this->doc->wrapScriptTags('
-                       var path = "'.$this->target.'";
-
-                       function reload(a)      {       //
-                               if (!changed || (changed && confirm('.$LANG->JScharCode($LANG->sL('LLL:EXT:lang/locallang_core.php:mess.redraw')).')))  {
-                                       var params = "&target="+encodeURIComponent(path)+"&number="+a+"&returnUrl='
-                                                       . urlencode($this->charsetConversion->conv($this->returnUrl, $GLOBALS['LANG']->charSet, 'utf-8'))
-                                                       . '";
+               $this->doc->backPath = $GLOBALS['BACK_PATH'];
+               $this->doc->JScode = $this->doc->wrapScriptTags('
+                       var path = "' . $this->target . '";
+
+                       function reload(a) {    //
+                               if (!changed || (changed && confirm(' . $GLOBALS['LANG']->JScharCode($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:mess.redraw')) . '))) {
+                                       var params = "&target="+encodeURIComponent(path)+"&number="+a+"&returnUrl=' . rawurlencode($this->returnUrl) . '";
                                        window.location.href = "file_newfolder.php?"+params;
                                }
                        }
-                       function backToList()   {       //
+                       function backToList() { //
                                top.goToModule("file_list");
                        }
 
@@ -181,99 +128,103 @@ class SC_file_newfolder {
        /**
         * Main function, rendering the main module content
         *
-        * @return      void
+        * @return void
         */
-       function main() {
-               global $LANG;
-
-                       // start content compilation
-               $this->content.=$this->doc->startPage($LANG->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.pagetitle'));
+       function main() {
 
+                       // Start content compilation
+               $this->content .= $this->doc->startPage($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.pagetitle'));
 
                        // Make page header:
-               $pageContent='';
-               $pageContent.=$this->doc->header($LANG->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.pagetitle'));
-               $pageContent.=$this->doc->spacer(5);
+               $pageContent = '';
+               $pageContent .= $this->doc->header($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.pagetitle'));
+               $pageContent .= $this->doc->spacer(5);
                $pageContent.=$this->doc->divider(5);
 
 
                $code = '<form action="tce_file.php" method="post" name="editform">';
                        // Making the selector box for the number of concurrent folder-creations
-               $this->number = t3lib_div::intInRange($this->number,1,10);
+               $this->number = t3lib_utility_Math::forceIntegerInRange($this->number, 1, 10);
                $code .= '
                        <div id="c-select">
                                <label for="number-of-new-folders">' .
-                               $LANG->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.number_of_folders') .
+                               $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.number_of_folders') .
                                '</label>
                                <select name="number" id="number-of-new-folders" onchange="reload(this.options[this.selectedIndex].value);">';
-               for ($a=1;$a<=$this->folderNumber;$a++) {
+               for ($a = 1; $a <= $this->folderNumber; $a++) {
                        $code .= '<option value="' . $a . '"' .
                                        ($this->number == $a ? ' selected="selected"' : '') .
                                        '>' . $a . '</option>';
                }
-               $code.='
+               $code .= '
                                </select>
                        </div>
                        ';
 
                        // Making the number of new-folder boxes needed:
-               $code.='
+               $code .= '
                        <div id="c-createFolders">
                ';
-               for ($a=0;$a<$this->number;$a++)        {
-                       $code.='
+               for ($a = 0; $a < $this->number; $a++) {
+                       $code .= '
                                        <input'.$this->doc->formWidth(20).' type="text" name="file[newfolder]['.$a.'][data]" onchange="changed=true;" />
-                                       <input type="hidden" name="file[newfolder]['.$a.'][target]" value="'.htmlspecialchars($this->target).'" />
+                                       <input type="hidden" name="file[newfolder][' . $a . '][target]" value="' . htmlspecialchars($this->target) . '" /><br />
                                ';
                }
-               $code.='
+               $code .= '
                        </div>
                ';
 
                        // Making submit button for folder creation:
-               $code.='
+               $code .= '
                        <div id="c-submitFolders">
-                               <input type="submit" value="'.$LANG->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.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_newfolder.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_newfolder', $GLOBALS['BACK_PATH'], '<br />');
-
-               $pageContent.= $code;
-
+               $code .= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'file_newfolder', $GLOBALS['BACK_PATH'], '<br />');
 
+               $pageContent .= $code;
 
                        // Add spacer:
-               $pageContent.= $this->doc->spacer(10);
+               $pageContent .= $this->doc->spacer(10);
 
                        // Switching form tags:
-               $pageContent.= $this->doc->sectionEnd();
-               $pageContent.= '</form><form action="tce_file.php" method="post" name="editform2">';
-
+               $pageContent .= $this->doc->sectionEnd();
+               $pageContent .= '</form><form action="tce_file.php" method="post" name="editform2">';
+
+                       // Create a list of allowed file extensions with the nice format "*.jpg, *.gif" etc.
+               $fileExtList = array();
+               $textfileExt = t3lib_div::trimExplode(',', $GLOBALS['TYPO3_CONF_VARS']['SYS']['textfile_ext'], TRUE);
+               foreach ($textfileExt as $fileExt) {
+                       if (!preg_match('/' . $GLOBALS['TYPO3_CONF_VARS']['BE']['fileDenyPattern'] . '/i', '.' . $fileExt)) {
+                               $fileExtList[] = '*.' . $fileExt;
+                       }
+               }
                        // Add form fields for creation of a new, blank text file:
-               $code='
+               $code = '
                        <div id="c-newFile">
-                               <p>['.htmlspecialchars($GLOBALS['TYPO3_CONF_VARS']['SYS']['textfile_ext']).']</p>
+                               <p>[' . htmlspecialchars(implode(', ', $fileExtList)) . ']</p>
                                <input'.$this->doc->formWidth(20).' type="text" name="file[newfile][0][data]" onchange="changed=true;" />
                                <input type="hidden" name="file[newfile][0][target]" value="'.htmlspecialchars($this->target).'" />
                        </div>
                        ';
 
                        // Submit button for creation of a new file:
-               $code.='
+               $code .= '
                        <div id="c-submitFiles">
-                               <input type="submit" value="'.$LANG->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.newfile_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_newfolder.php.newfile_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_newfile', $GLOBALS['BACK_PATH'], '<br />');
-               $pageContent.= $this->doc->section($LANG->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.newfile'),$code);
+               $pageContent .= $this->doc->section($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.newfile'), $code);
                $pageContent .= $this->doc->sectionEnd();
                $pageContent .= '</form>';
 
@@ -287,8 +238,8 @@ class SC_file_newfolder {
                        'PATH' => $this->title,
                );
 
-               $this->content.= $this->doc->moduleBody(array(), $docHeaderButtons, $markerArray);
-               $this->content.= $this->doc->endPage();
+               $this->content .= $this->doc->moduleBody(array(), $docHeaderButtons, $markerArray);
+               $this->content .= $this->doc->endPage();
 
                $this->content = $this->doc->insertStylesAndJS($this->content);
        }
@@ -296,21 +247,14 @@ class SC_file_newfolder {
        /**
         * Outputting the accumulated content to screen
         *
-        * @return      void
+        * @return void
         */
-       function printContent() {
+       function printContent() {
                echo $this->content;
        }
 }
 
-
-if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/file_newfolder.php'])       {
-       include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/file_newfolder.php']);
-}
-
-
-
-// Make instance:
+       // Make instance:
 $SOBE = t3lib_div::makeInstance('SC_file_newfolder');
 $SOBE->init();
 $SOBE->main();