[TASK] Clean up phpDoc comments in typo3/
[Packages/TYPO3.CMS.git] / typo3 / file_newfolder.php
old mode 100755 (executable)
new mode 100644 (file)
index 2328288..83093c7
@@ -1,22 +1,22 @@
 <?php
 /***************************************************************
 *  Copyright notice
-*  
-*  (c) 1999-2004 Kasper Skaarhoj (kasper@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 script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
-* 
+*
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
-*  A copy is found in the textfile GPL.txt and important notices to the license 
+*  A copy is found in the textfile GPL.txt and important notices to the license
 *  from the author is found in LICENSE.txt distributed with these scripts.
 *
-* 
+*
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *
 *  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
- *
- * @author     Kasper Skaarhoj <kasper@typo3.com>
- */
+
 /**
- * [CLASS/FUNCTION INDEX of SCRIPT]
- *
- *
- *
- *   76: class SC_file_newfolder 
- *  102:     function init()   
- *  161:     function main()   
- *  248:     function printContent()   
+ * Web>File: Create new folders in the filemounts
  *
- * 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');
-
-
-
-
-
-
-
-
-
-
-
 
+$BACK_PATH = '';
+require('init.php');
+require('template.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 <kasper@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:
-       var $doc;                       // Template object.
-       var $basicff;           // Instance of "t3lib_basicFileFunctions"
-       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
+       /**
+        * document template object
+        *
+        * @var smallDoc
+        */
+       var $doc;
+               // Name of the filemount
+       var $title;
 
                // Internal, static (GPVar):
-       var $number;            
-       var $target;            // Set with the target path inputted in &target
+       var $number;
+               // Set with the target path inputted in &target
+       var $target;
+
+       /**
+        * The folder object which is  the target directory
+        *
+        * @var t3lib_file_Folder $folderObject
+        */
+       protected $folderObject;
+               // Return URL of list module.
+       var $returnUrl;
 
-               // Internal, dynamic:   
-       var $content;           // Accumulating content
-       
-       
+               // Internal, dynamic:
+               // 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');
-                       
-                       // Init basic-file-functions object:
-               $this->basicff = t3lib_div::makeInstance('t3lib_basicFileFunctions');
-               $this->basicff->init($GLOBALS['FILEMOUNTS'],$TYPO3_CONF_VARS['BE']['fileExtensions']);
-               
-                       // Cleaning and checking target
-               $this->target=$this->basicff->is_directory($this->target);              
-               $key=$this->basicff->checkPathAgainstMounts($this->target.'/');
-               if (!$this->target || !$key)    {
-                       t3lib_BEfunc::typo3PrintError ('Parameter Error','Target was not a directory!','');
-                       exit;
+               $this->target = $combinedIdentifier = t3lib_div::_GP('target');
+               $this->returnUrl = t3lib_div::sanitizeLocalUrl(t3lib_div::_GP('returnUrl'));
+
+                       // create the folder object
+               if ($combinedIdentifier) {
+                       $this->folderObject = t3lib_file_Factory::getInstance()->getFolderObjectFromCombinedIdentifier($combinedIdentifier);
                }
-               
-                       // 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;
+
+                       // 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);
                }
-               
-                       // 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;
-               
+
+                       // 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('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->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="+escape(path)+"&number="+a; 
-                                       document.location = "file_newfolder.php?"+params;
+               $this->doc = t3lib_div::makeInstance('template');
+               $this->doc->setModuleTemplate('templates/file_newfolder.html');
+               $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");
                        }
-                       
+
                        var changed = 0;
                ');
        }
@@ -156,120 +128,136 @@ class SC_file_newfolder {
        /**
         * Main function, rendering the main module content
         *
-        * @return      void
+        * @return void
         */
-       function main() {
-               global $LANG;
+       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:
-               $this->content='';
-               $this->content.=$this->doc->startPage($LANG->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.pagetitle'));
-               $this->content.=$this->doc->header($LANG->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.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);
-               
+               $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);
-               $code='
+               $this->number = t3lib_utility_Math::forceIntegerInRange($this->number, 1, 10);
+               $code .= '
                        <div id="c-select">
-                               <select name="number" onchange="reload(this.options[this.selectedIndex].value);">';
-               for ($a=1;$a<=$this->folderNumber;$a++) {
-                       $code.='
-                                       <option value="'.$a.'"'.($this->number==$a?' selected="selected"':'').'>'.$a.' '.$LANG->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.folders',1).'</option>';
+                               <label for="number-of-new-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++) {
+                       $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;" />
-                       </div>                          
+                               <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>
                        ';
-               $this->content.= $this->doc->section('',$code);
-               
 
+                       // CSH:
+               $code .= t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'file_newfolder', $GLOBALS['BACK_PATH'], '<br />');
+
+               $pageContent .= $code;
 
                        // Add spacer:
-               $this->content.= $this->doc->spacer(10);
+               $pageContent .= $this->doc->spacer(10);
 
                        // Switching form tags:
-               $this->content.= $this->doc->sectionEnd();
-               $this->content.= '</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>  
+                       </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($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.newfile'), $code);
+               $pageContent .= $this->doc->sectionEnd();
+               $pageContent .= '</form>';
+
+               $docHeaderButtons = array();
+
                        // Add the HTML as a section:
-               $this->content.= $this->doc->section($LANG->sL('LLL:EXT:lang/locallang_core.php:file_newfolder.php.newfile'),$code);
+               $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();
 
-                       // Ending page
-               $this->content.= $this->doc->endPage();
+               $this->content = $this->doc->insertStylesAndJS($this->content);
        }
 
        /**
         * Outputting the accumulated content to screen
         *
-        * @return      void
+        * @return void
         */
-       function printContent() {
-
+       function printContent() {
                echo $this->content;
        }
 }
 
-// Include extension?
-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();
 $SOBE->printContent();
+
 ?>
\ No newline at end of file