You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
173 lines
6.6 KiB
173 lines
6.6 KiB
12 years ago
|
<?php
|
||
|
/**
|
||
|
* Filesystem helper class file.
|
||
|
*
|
||
|
* @link http://www.yiiframework.com/
|
||
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
||
|
* @license http://www.yiiframework.com/license/
|
||
|
*/
|
||
|
|
||
|
namespace yii\helpers\base;
|
||
|
|
||
12 years ago
|
use Yii;
|
||
12 years ago
|
|
||
|
/**
|
||
|
* Filesystem helper
|
||
|
*
|
||
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
||
|
* @author Alex Makarov <sam@rmcreative.ru>
|
||
|
* @since 2.0
|
||
|
*/
|
||
|
class FileHelper
|
||
|
{
|
||
|
/**
|
||
|
* Normalizes a file/directory path.
|
||
|
* After normalization, the directory separators in the path will be `DIRECTORY_SEPARATOR`,
|
||
|
* and any trailing directory separators will be removed. For example, '/home\demo/' on Linux
|
||
|
* will be normalized as '/home/demo'.
|
||
|
* @param string $path the file/directory path to be normalized
|
||
|
* @param string $ds the directory separator to be used in the normalized result. Defaults to `DIRECTORY_SEPARATOR`.
|
||
|
* @return string the normalized file/directory path
|
||
|
*/
|
||
|
public static function normalizePath($path, $ds = DIRECTORY_SEPARATOR)
|
||
|
{
|
||
|
return rtrim(strtr($path, array('/' => $ds, '\\' => $ds)), $ds);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Returns the localized version of a specified file.
|
||
|
*
|
||
|
* The searching is based on the specified language code. In particular,
|
||
|
* a file with the same name will be looked for under the subdirectory
|
||
12 years ago
|
* whose name is the same as the language code. For example, given the file "path/to/view.php"
|
||
|
* and language code "zh_CN", the localized file will be looked for as
|
||
|
* "path/to/zh_CN/view.php". If the file is not found, the original file
|
||
12 years ago
|
* will be returned.
|
||
|
*
|
||
|
* If the target and the source language codes are the same,
|
||
|
* the original file will be returned.
|
||
|
*
|
||
|
* @param string $file the original file
|
||
|
* @param string $language the target language that the file should be localized to.
|
||
|
* If not set, the value of [[\yii\base\Application::language]] will be used.
|
||
|
* @param string $sourceLanguage the language that the original file is in.
|
||
|
* If not set, the value of [[\yii\base\Application::sourceLanguage]] will be used.
|
||
|
* @return string the matching localized file, or the original file if the localized version is not found.
|
||
|
* If the target and the source language codes are the same, the original file will be returned.
|
||
|
*/
|
||
|
public static function localize($file, $language = null, $sourceLanguage = null)
|
||
|
{
|
||
|
if ($language === null) {
|
||
12 years ago
|
$language = Yii::$app->language;
|
||
12 years ago
|
}
|
||
|
if ($sourceLanguage === null) {
|
||
12 years ago
|
$sourceLanguage = Yii::$app->sourceLanguage;
|
||
12 years ago
|
}
|
||
|
if ($language === $sourceLanguage) {
|
||
|
return $file;
|
||
|
}
|
||
|
$desiredFile = dirname($file) . DIRECTORY_SEPARATOR . $sourceLanguage . DIRECTORY_SEPARATOR . basename($file);
|
||
|
return is_file($desiredFile) ? $desiredFile : $file;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Determines the MIME type of the specified file.
|
||
|
* This method will first try to determine the MIME type based on
|
||
|
* [finfo_open](http://php.net/manual/en/function.finfo-open.php). If this doesn't work, it will
|
||
|
* fall back to [[getMimeTypeByExtension()]].
|
||
|
* @param string $file the file name.
|
||
|
* @param string $magicFile name of the optional magic database file, usually something like `/path/to/magic.mime`.
|
||
|
* This will be passed as the second parameter to [finfo_open](http://php.net/manual/en/function.finfo-open.php).
|
||
|
* @param boolean $checkExtension whether to use the file extension to determine the MIME type in case
|
||
|
* `finfo_open()` cannot determine it.
|
||
|
* @return string the MIME type (e.g. `text/plain`). Null is returned if the MIME type cannot be determined.
|
||
|
*/
|
||
|
public static function getMimeType($file, $magicFile = null, $checkExtension = true)
|
||
|
{
|
||
|
if (function_exists('finfo_open')) {
|
||
|
$info = finfo_open(FILEINFO_MIME_TYPE, $magicFile);
|
||
12 years ago
|
if ($info) {
|
||
|
$result = finfo_file($info, $file);
|
||
12 years ago
|
finfo_close($info);
|
||
12 years ago
|
if ($result !== false) {
|
||
|
return $result;
|
||
|
}
|
||
12 years ago
|
}
|
||
|
}
|
||
|
|
||
|
return $checkExtension ? self::getMimeTypeByExtension($file) : null;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Determines the MIME type based on the extension name of the specified file.
|
||
|
* This method will use a local map between extension names and MIME types.
|
||
|
* @param string $file the file name.
|
||
|
* @param string $magicFile the path of the file that contains all available MIME type information.
|
||
|
* If this is not set, the default file aliased by `@yii/util/mimeTypes.php` will be used.
|
||
|
* @return string the MIME type. Null is returned if the MIME type cannot be determined.
|
||
|
*/
|
||
|
public static function getMimeTypeByExtension($file, $magicFile = null)
|
||
|
{
|
||
12 years ago
|
static $mimeTypes = array();
|
||
12 years ago
|
if ($magicFile === null) {
|
||
12 years ago
|
$magicFile = __DIR__ . '/mimeTypes.php';
|
||
|
}
|
||
|
if (!isset($mimeTypes[$magicFile])) {
|
||
|
$mimeTypes[$magicFile] = require($magicFile);
|
||
12 years ago
|
}
|
||
|
if (($ext = pathinfo($file, PATHINFO_EXTENSION)) !== '') {
|
||
|
$ext = strtolower($ext);
|
||
12 years ago
|
if (isset($mimeTypes[$magicFile][$ext])) {
|
||
|
return $mimeTypes[$magicFile][$ext];
|
||
12 years ago
|
}
|
||
|
}
|
||
|
return null;
|
||
|
}
|
||
|
|
||
12 years ago
|
/**
|
||
|
* Copies a whole directory as another one.
|
||
|
* The files and sub-directories will also be copied over.
|
||
|
* @param string $src the source directory
|
||
|
* @param string $dst the destination directory
|
||
|
* @param array $options options for directory copy. Valid options are:
|
||
|
*
|
||
|
* - dirMode: integer, the permission to be set for newly copied directories. Defaults to 0777.
|
||
|
* - fileMode: integer, the permission to be set for newly copied files. Defaults to the current environment setting.
|
||
12 years ago
|
* - beforeCopy: callback, a PHP callback that is called before copying each sub-directory or file.
|
||
|
* If the callback returns false, the copy operation for the sub-directory or file will be cancelled.
|
||
|
* The signature of the callback should be: `function ($from, $to)`, where `$from` is the sub-directory or
|
||
|
* file to be copied from, while `$to` is the copy target.
|
||
|
* - afterCopy: callback, a PHP callback that is called after a sub-directory or file is successfully copied.
|
||
|
* The signature of the callback is similar to that of `beforeCopy`.
|
||
12 years ago
|
*/
|
||
|
public static function copyDirectory($src, $dst, $options = array())
|
||
|
{
|
||
|
if (!is_dir($dst)) {
|
||
|
mkdir($dst, isset($options['dirMode']) ? $options['dirMode'] : 0777, true);
|
||
|
}
|
||
|
|
||
|
$handle = opendir($src);
|
||
|
while (($file = readdir($handle)) !== false) {
|
||
|
if ($file === '.' || $file === '..') {
|
||
|
continue;
|
||
|
}
|
||
12 years ago
|
$from = $src . DIRECTORY_SEPARATOR . $file;
|
||
|
$to = $dst . DIRECTORY_SEPARATOR . $file;
|
||
|
if (!isset($options['beforeCopy']) || call_user_func($options['beforeCopy'], $from, $to)) {
|
||
|
if (is_file($from)) {
|
||
|
copy($from, $to);
|
||
12 years ago
|
if (isset($options['fileMode'])) {
|
||
12 years ago
|
@chmod($to, $options['fileMode']);
|
||
12 years ago
|
}
|
||
|
} else {
|
||
12 years ago
|
static::copyDirectory($from, $to, $options);
|
||
|
}
|
||
|
if (isset($options['afterCopy'])) {
|
||
|
call_user_func($options['afterCopy'], $from, $to);
|
||
12 years ago
|
}
|
||
|
}
|
||
|
}
|
||
|
closedir($handle);
|
||
|
}
|
||
12 years ago
|
}
|