1: <?php
  2: 
  3: /*
  4:  * This file is part of the Symfony package.
  5:  *
  6:  * (c) Fabien Potencier <fabien@symfony.com>
  7:  *
  8:  * For the full copyright and license information, please view the LICENSE
  9:  * file that was distributed with this source code.
 10:  */
 11: 
 12: namespace Symfony\Component\HttpFoundation\File;
 13: 
 14: use Symfony\Component\HttpFoundation\File\Exception\FileException;
 15: use Symfony\Component\HttpFoundation\File\Exception\FileNotFoundException;
 16: use Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesser;
 17: use Symfony\Component\HttpFoundation\File\MimeType\ExtensionGuesser;
 18: 
 19: /**
 20:  * A file in the file system.
 21:  *
 22:  * @author Bernhard Schussek <bschussek@gmail.com>
 23:  *
 24:  * @api
 25:  */
 26: class File extends \SplFileInfo
 27: {
 28:     /**
 29:      * Constructs a new file from the given path.
 30:      *
 31:      * @param string  $path      The path to the file
 32:      * @param Boolean $checkPath Whether to check the path or not
 33:      *
 34:      * @throws FileNotFoundException If the given path is not a file
 35:      *
 36:      * @api
 37:      */
 38:     public function __construct($path, $checkPath = true)
 39:     {
 40:         if ($checkPath && !is_file($path)) {
 41:             throw new FileNotFoundException($path);
 42:         }
 43: 
 44:         parent::__construct($path);
 45:     }
 46: 
 47:     /**
 48:      * Returns the extension based on the mime type.
 49:      *
 50:      * If the mime type is unknown, returns null.
 51:      *
 52:      * @return string|null The guessed extension or null if it cannot be guessed
 53:      *
 54:      * @api
 55:      */
 56:     public function guessExtension()
 57:     {
 58:         $type = $this->getMimeType();
 59:         $guesser = ExtensionGuesser::getInstance();
 60: 
 61:         return $guesser->guess($type);
 62:     }
 63: 
 64:     /**
 65:      * Returns the mime type of the file.
 66:      *
 67:      * The mime type is guessed using the functions finfo(), mime_content_type()
 68:      * and the system binary "file" (in this order), depending on which of those
 69:      * is available on the current operating system.
 70:      *
 71:      * @return string|null The guessed mime type (i.e. "application/pdf")
 72:      *
 73:      * @api
 74:      */
 75:     public function getMimeType()
 76:     {
 77:         $guesser = MimeTypeGuesser::getInstance();
 78: 
 79:         return $guesser->guess($this->getPathname());
 80:     }
 81: 
 82:     /**
 83:      * Returns the extension of the file.
 84:      *
 85:      * \SplFileInfo::getExtension() is not available before PHP 5.3.6
 86:      *
 87:      * @return string The extension
 88:      *
 89:      * @api
 90:      */
 91:     public function getExtension()
 92:     {
 93:         return pathinfo($this->getBasename(), PATHINFO_EXTENSION);
 94:     }
 95: 
 96:     /**
 97:      * Moves the file to a new location.
 98:      *
 99:      * @param string $directory The destination folder
100:      * @param string $name      The new file name
101:      *
102:      * @return File A File object representing the new file
103:      *
104:      * @throws FileException if the target file could not be created
105:      *
106:      * @api
107:      */
108:     public function move($directory, $name = null)
109:     {
110:         $target = $this->getTargetFile($directory, $name);
111: 
112:         if (!@rename($this->getPathname(), $target)) {
113:             $error = error_get_last();
114:             throw new FileException(sprintf('Could not move the file "%s" to "%s" (%s)', $this->getPathname(), $target, strip_tags($error['message'])));
115:         }
116: 
117:         @chmod($target, 0666 & ~umask());
118: 
119:         return $target;
120:     }
121: 
122:     protected function getTargetFile($directory, $name = null)
123:     {
124:         if (!is_dir($directory)) {
125:             if (false === @mkdir($directory, 0777, true)) {
126:                 throw new FileException(sprintf('Unable to create the "%s" directory', $directory));
127:             }
128:         } elseif (!is_writable($directory)) {
129:             throw new FileException(sprintf('Unable to write in the "%s" directory', $directory));
130:         }
131: 
132:         $target = $directory.DIRECTORY_SEPARATOR.(null === $name ? $this->getBasename() : $this->getName($name));
133: 
134:         return new File($target, false);
135:     }
136: 
137:     /**
138:      * Returns locale independent base name of the given path.
139:      *
140:      * @param string $name The new file name
141:      *
142:      * @return string containing
143:      */
144:     protected function getName($name)
145:     {
146:         $originalName = str_replace('\\', '/', $name);
147:         $pos = strrpos($originalName, '/');
148:         $originalName = false === $pos ? $originalName : substr($originalName, $pos + 1);
149: 
150:         return $originalName;
151:     }
152: }
153: