split of mimetype detection code from OC_Helper, adding the option for apps to register additional mimetype mappings

This commit is contained in:
Robin Appelman 2013-08-07 16:38:57 +02:00
parent 057d7aa108
commit fc332acf8a
2 changed files with 315 additions and 236 deletions

View File

@ -0,0 +1,121 @@
<?php
/**
* Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OC\Files\Type;
/**
* Class Detection
*
* Mimetype detection
*
* @package OC\Files\Type
*/
class Detection {
protected $mimetypes = array();
/**
* add an extension -> mimetype mapping
*
* @param string $extension
* @param string $mimetype
*/
public function registerType($extension, $mimetype) {
$this->mimetypes[$extension] = $mimetype;
}
/**
* add an array of extension -> mimetype mappings
*
* @param array $types
*/
public function registerTypeArray($types) {
$this->mimetypes = array_merge($this->mimetypes, $types);
}
/**
* detect mimetype only based on filename, content of file is not used
*
* @param string $path
* @return string
*/
public function detectPath($path) {
if (strpos($path, '.')) {
//try to guess the type by the file extension
$extension = strtolower(strrchr(basename($path), "."));
$extension = substr($extension, 1); //remove leading .
return (isset($this->mimetypes[$extension])) ? $this->mimetypes[$extension] : 'application/octet-stream';
} else {
return 'application/octet-stream';
}
}
/**
* detect mimetype based on both filename and content
*
* @param string $path
* @return string
*/
public function detect($path) {
$isWrapped = (strpos($path, '://') !== false) and (substr($path, 0, 7) == 'file://');
if (@is_dir($path)) {
// directories are easy
return "httpd/unix-directory";
}
$mimeType = $this->detectPath($path);
if ($mimeType == 'application/octet-stream' and function_exists('finfo_open')
and function_exists('finfo_file') and $finfo = finfo_open(FILEINFO_MIME)
) {
$info = @strtolower(finfo_file($finfo, $path));
if ($info) {
$mimeType = substr($info, 0, strpos($info, ';'));
}
finfo_close($finfo);
}
if (!$isWrapped and $mimeType == 'application/octet-stream' && function_exists("mime_content_type")) {
// use mime magic extension if available
$mimeType = mime_content_type($path);
}
if (!$isWrapped and $mimeType == 'application/octet-stream' && \OC_Helper::canExecute("file")) {
// it looks like we have a 'file' command,
// lets see if it does have mime support
$path = escapeshellarg($path);
$fp = popen("file -b --mime-type $path 2>/dev/null", "r");
$reply = fgets($fp);
pclose($fp);
//trim the newline
$mimeType = trim($reply);
}
return $mimeType;
}
/**
* detect mimetype based on the content of a string
*
* @param string $data
* @return string
*/
public function detectString($data) {
if (function_exists('finfo_open') and function_exists('finfo_file')) {
$finfo = finfo_open(FILEINFO_MIME);
return finfo_buffer($finfo, $data);
} else {
$tmpFile = \OC_Helper::tmpFile();
$fh = fopen($tmpFile, 'wb');
fwrite($fh, $data, 8024);
fclose($fh);
$mime = $this->detect($tmpFile);
unset($tmpFile);
return $mime;
}
}
}

View File

@ -25,9 +25,9 @@
* Collection of useful functions * Collection of useful functions
*/ */
class OC_Helper { class OC_Helper {
private static $mimetypes=array(); private static $tmpFiles = array();
private static $tmpFiles=array();
private static $mimetypeIcons = array(); private static $mimetypeIcons = array();
private static $mimetypeDetector;
/** /**
* @brief Creates an url using a defined route * @brief Creates an url using a defined route
@ -39,7 +39,7 @@ class OC_Helper {
* *
* Returns a url to the given app and file. * Returns a url to the given app and file.
*/ */
public static function linkToRoute( $route, $parameters = array() ) { public static function linkToRoute($route, $parameters = array()) {
$urlLinkTo = OC::getRouter()->generate($route, $parameters); $urlLinkTo = OC::getRouter()->generate($route, $parameters);
return $urlLinkTo; return $urlLinkTo;
} }
@ -54,33 +54,30 @@ class OC_Helper {
* *
* Returns a url to the given app and file. * Returns a url to the given app and file.
*/ */
public static function linkTo( $app, $file, $args = array() ) { public static function linkTo($app, $file, $args = array()) {
if( $app != '' ) { if ($app != '') {
$app_path = OC_App::getAppPath($app); $app_path = OC_App::getAppPath($app);
// Check if the app is in the app folder // Check if the app is in the app folder
if( $app_path && file_exists( $app_path.'/'.$file )) { if ($app_path && file_exists($app_path . '/' . $file)) {
if(substr($file, -3) == 'php' || substr($file, -3) == 'css') { if (substr($file, -3) == 'php' || substr($file, -3) == 'css') {
$urlLinkTo = OC::$WEBROOT . '/index.php/apps/' . $app; $urlLinkTo = OC::$WEBROOT . '/index.php/apps/' . $app;
$urlLinkTo .= ($file!='index.php') ? '/' . $file : ''; $urlLinkTo .= ($file != 'index.php') ? '/' . $file : '';
}else{ } else {
$urlLinkTo = OC_App::getAppWebPath($app) . '/' . $file; $urlLinkTo = OC_App::getAppWebPath($app) . '/' . $file;
} }
} } else {
else{
$urlLinkTo = OC::$WEBROOT . '/' . $app . '/' . $file; $urlLinkTo = OC::$WEBROOT . '/' . $app . '/' . $file;
} }
} } else {
else{ if (file_exists(OC::$SERVERROOT . '/core/' . $file)) {
if( file_exists( OC::$SERVERROOT . '/core/'. $file )) { $urlLinkTo = OC::$WEBROOT . '/core/' . $file;
$urlLinkTo = OC::$WEBROOT . '/core/'.$file; } else {
} $urlLinkTo = OC::$WEBROOT . '/' . $file;
else{
$urlLinkTo = OC::$WEBROOT . '/'.$file;
} }
} }
if ($args && $query = http_build_query($args, '', '&')) { if ($args && $query = http_build_query($args, '', '&')) {
$urlLinkTo .= '?'.$query; $urlLinkTo .= '?' . $query;
} }
return $urlLinkTo; return $urlLinkTo;
@ -96,8 +93,8 @@ class OC_Helper {
* *
* Returns a absolute url to the given app and file. * Returns a absolute url to the given app and file.
*/ */
public static function linkToAbsolute( $app, $file, $args = array() ) { public static function linkToAbsolute($app, $file, $args = array()) {
$urlLinkTo = self::linkTo( $app, $file, $args ); $urlLinkTo = self::linkTo($app, $file, $args);
return self::makeURLAbsolute($urlLinkTo); return self::makeURLAbsolute($urlLinkTo);
} }
@ -108,9 +105,8 @@ class OC_Helper {
* *
* Returns a absolute url to the given app and file. * Returns a absolute url to the given app and file.
*/ */
public static function makeURLAbsolute( $url ) public static function makeURLAbsolute($url) {
{ return OC_Request::serverProtocol() . '://' . OC_Request::serverHost() . $url;
return OC_Request::serverProtocol(). '://' . OC_Request::serverHost() . $url;
} }
/** /**
@ -120,8 +116,8 @@ class OC_Helper {
* *
* Returns a url to the given service. * Returns a url to the given service.
*/ */
public static function linkToRemoteBase( $service ) { public static function linkToRemoteBase($service) {
return self::linkTo( '', 'remote.php') . '/' . $service; return self::linkTo('', 'remote.php') . '/' . $service;
} }
/** /**
@ -132,9 +128,9 @@ class OC_Helper {
* *
* Returns a absolute url to the given service. * Returns a absolute url to the given service.
*/ */
public static function linkToRemote( $service, $add_slash = true ) { public static function linkToRemote($service, $add_slash = true) {
return self::makeURLAbsolute(self::linkToRemoteBase($service)) return self::makeURLAbsolute(self::linkToRemoteBase($service))
. (($add_slash && $service[strlen($service)-1]!='/')?'/':''); . (($add_slash && $service[strlen($service) - 1] != '/') ? '/' : '');
} }
/** /**
@ -146,8 +142,8 @@ class OC_Helper {
* Returns a absolute url to the given service. * Returns a absolute url to the given service.
*/ */
public static function linkToPublic($service, $add_slash = false) { public static function linkToPublic($service, $add_slash = false) {
return self::linkToAbsolute( '', 'public.php') . '?service=' . $service return self::linkToAbsolute('', 'public.php') . '?service=' . $service
. (($add_slash && $service[strlen($service)-1]!='/')?'/':''); . (($add_slash && $service[strlen($service) - 1] != '/') ? '/' : '');
} }
/** /**
@ -158,25 +154,25 @@ class OC_Helper {
* *
* Returns the path to the image. * Returns the path to the image.
*/ */
public static function imagePath( $app, $image ) { public static function imagePath($app, $image) {
// Read the selected theme from the config file // Read the selected theme from the config file
$theme = OC_Util::getTheme(); $theme = OC_Util::getTheme();
// Check if the app is in the app folder // Check if the app is in the app folder
if( file_exists( OC::$SERVERROOT."/themes/$theme/apps/$app/img/$image" )) { if (file_exists(OC::$SERVERROOT . "/themes/$theme/apps/$app/img/$image")) {
return OC::$WEBROOT."/themes/$theme/apps/$app/img/$image"; return OC::$WEBROOT . "/themes/$theme/apps/$app/img/$image";
}elseif( file_exists(OC_App::getAppPath($app)."/img/$image" )) { } elseif (file_exists(OC_App::getAppPath($app) . "/img/$image")) {
return OC_App::getAppWebPath($app)."/img/$image"; return OC_App::getAppWebPath($app) . "/img/$image";
}elseif( !empty( $app ) and file_exists( OC::$SERVERROOT."/themes/$theme/$app/img/$image" )) { } elseif (!empty($app) and file_exists(OC::$SERVERROOT . "/themes/$theme/$app/img/$image")) {
return OC::$WEBROOT."/themes/$theme/$app/img/$image"; return OC::$WEBROOT . "/themes/$theme/$app/img/$image";
}elseif( !empty( $app ) and file_exists( OC::$SERVERROOT."/$app/img/$image" )) { } elseif (!empty($app) and file_exists(OC::$SERVERROOT . "/$app/img/$image")) {
return OC::$WEBROOT."/$app/img/$image"; return OC::$WEBROOT . "/$app/img/$image";
}elseif( file_exists( OC::$SERVERROOT."/themes/$theme/core/img/$image" )) { } elseif (file_exists(OC::$SERVERROOT . "/themes/$theme/core/img/$image")) {
return OC::$WEBROOT."/themes/$theme/core/img/$image"; return OC::$WEBROOT . "/themes/$theme/core/img/$image";
}elseif( file_exists( OC::$SERVERROOT."/core/img/$image" )) { } elseif (file_exists(OC::$SERVERROOT . "/core/img/$image")) {
return OC::$WEBROOT."/core/img/$image"; return OC::$WEBROOT . "/core/img/$image";
}else{ } else {
throw new RuntimeException('image not found: image:'.$image.' webroot:'.OC::$WEBROOT.' serverroot:'.OC::$SERVERROOT); throw new RuntimeException('image not found: image:' . $image . ' webroot:' . OC::$WEBROOT . ' serverroot:' . OC::$SERVERROOT);
} }
} }
@ -197,28 +193,28 @@ class OC_Helper {
} }
// Replace slash and backslash with a minus // Replace slash and backslash with a minus
$icon = str_replace('/', '-', $mimetype); $icon = str_replace('/', '-', $mimetype);
$icon = str_replace( '\\', '-', $icon); $icon = str_replace('\\', '-', $icon);
// Is it a dir? // Is it a dir?
if ($mimetype === 'dir') { if ($mimetype === 'dir') {
self::$mimetypeIcons[$mimetype] = OC::$WEBROOT.'/core/img/filetypes/folder.png'; self::$mimetypeIcons[$mimetype] = OC::$WEBROOT . '/core/img/filetypes/folder.png';
return OC::$WEBROOT.'/core/img/filetypes/folder.png'; return OC::$WEBROOT . '/core/img/filetypes/folder.png';
} }
// Icon exists? // Icon exists?
if (file_exists(OC::$SERVERROOT.'/core/img/filetypes/'.$icon.'.png')) { if (file_exists(OC::$SERVERROOT . '/core/img/filetypes/' . $icon . '.png')) {
self::$mimetypeIcons[$mimetype] = OC::$WEBROOT.'/core/img/filetypes/'.$icon.'.png'; self::$mimetypeIcons[$mimetype] = OC::$WEBROOT . '/core/img/filetypes/' . $icon . '.png';
return OC::$WEBROOT.'/core/img/filetypes/'.$icon.'.png'; return OC::$WEBROOT . '/core/img/filetypes/' . $icon . '.png';
} }
// Try only the first part of the filetype // Try only the first part of the filetype
$mimePart = substr($icon, 0, strpos($icon, '-')); $mimePart = substr($icon, 0, strpos($icon, '-'));
if (file_exists(OC::$SERVERROOT.'/core/img/filetypes/'.$mimePart.'.png')) { if (file_exists(OC::$SERVERROOT . '/core/img/filetypes/' . $mimePart . '.png')) {
self::$mimetypeIcons[$mimetype] = OC::$WEBROOT.'/core/img/filetypes/'.$mimePart.'.png'; self::$mimetypeIcons[$mimetype] = OC::$WEBROOT . '/core/img/filetypes/' . $mimePart . '.png';
return OC::$WEBROOT.'/core/img/filetypes/'.$mimePart.'.png'; return OC::$WEBROOT . '/core/img/filetypes/' . $mimePart . '.png';
} else { } else {
self::$mimetypeIcons[$mimetype] = OC::$WEBROOT.'/core/img/filetypes/file.png'; self::$mimetypeIcons[$mimetype] = OC::$WEBROOT . '/core/img/filetypes/file.png';
return OC::$WEBROOT.'/core/img/filetypes/file.png'; return OC::$WEBROOT . '/core/img/filetypes/file.png';
} }
} }
@ -229,25 +225,25 @@ class OC_Helper {
* *
* Makes 2048 to 2 kB. * Makes 2048 to 2 kB.
*/ */
public static function humanFileSize( $bytes ) { public static function humanFileSize($bytes) {
if( $bytes < 0 ) { if ($bytes < 0) {
$l = OC_L10N::get('lib'); $l = OC_L10N::get('lib');
return $l->t("couldn't be determined"); return $l->t("couldn't be determined");
} }
if( $bytes < 1024 ) { if ($bytes < 1024) {
return "$bytes B"; return "$bytes B";
} }
$bytes = round( $bytes / 1024, 1 ); $bytes = round($bytes / 1024, 1);
if( $bytes < 1024 ) { if ($bytes < 1024) {
return "$bytes kB"; return "$bytes kB";
} }
$bytes = round( $bytes / 1024, 1 ); $bytes = round($bytes / 1024, 1);
if( $bytes < 1024 ) { if ($bytes < 1024) {
return "$bytes MB"; return "$bytes MB";
} }
// Wow, heavy duty for owncloud // Wow, heavy duty for owncloud
$bytes = round( $bytes / 1024, 1 ); $bytes = round($bytes / 1024, 1);
return "$bytes GB"; return "$bytes GB";
} }
@ -260,8 +256,8 @@ class OC_Helper {
* *
* Inspired by: http://www.php.net/manual/en/function.filesize.php#92418 * Inspired by: http://www.php.net/manual/en/function.filesize.php#92418
*/ */
public static function computerFileSize( $str ) { public static function computerFileSize($str) {
$str=strtolower($str); $str = strtolower($str);
$bytes_array = array( $bytes_array = array(
'b' => 1, 'b' => 1,
@ -299,18 +295,17 @@ class OC_Helper {
return chmod($path, $filemode); return chmod($path, $filemode);
$dh = opendir($path); $dh = opendir($path);
while (($file = readdir($dh)) !== false) { while (($file = readdir($dh)) !== false) {
if($file != '.' && $file != '..') { if ($file != '.' && $file != '..') {
$fullpath = $path.'/'.$file; $fullpath = $path . '/' . $file;
if(is_link($fullpath)) if (is_link($fullpath))
return false; return false;
elseif(!is_dir($fullpath) && !@chmod($fullpath, $filemode)) elseif (!is_dir($fullpath) && !@chmod($fullpath, $filemode))
return false; return false; elseif (!self::chmodr($fullpath, $filemode))
elseif(!self::chmodr($fullpath, $filemode))
return false; return false;
} }
} }
closedir($dh); closedir($dh);
if(@chmod($path, $filemode)) if (@chmod($path, $filemode))
return true; return true;
else else
return false; return false;
@ -323,8 +318,8 @@ class OC_Helper {
* *
*/ */
static function copyr($src, $dest) { static function copyr($src, $dest) {
if(is_dir($src)) { if (is_dir($src)) {
if(!is_dir($dest)) { if (!is_dir($dest)) {
mkdir($dest); mkdir($dest);
} }
$files = scandir($src); $files = scandir($src);
@ -333,7 +328,7 @@ class OC_Helper {
self::copyr("$src/$file", "$dest/$file"); self::copyr("$src/$file", "$dest/$file");
} }
} }
}elseif(file_exists($src) && !\OC\Files\Filesystem::isFileBlacklisted($src)) { } elseif (file_exists($src) && !\OC\Files\Filesystem::isFileBlacklisted($src)) {
copy($src, $dest); copy($src, $dest);
} }
} }
@ -344,105 +339,61 @@ class OC_Helper {
* @return bool * @return bool
*/ */
static function rmdirr($dir) { static function rmdirr($dir) {
if(is_dir($dir)) { if (is_dir($dir)) {
$files=scandir($dir); $files = scandir($dir);
foreach($files as $file) { foreach ($files as $file) {
if ($file != "." && $file != "..") { if ($file != "." && $file != "..") {
self::rmdirr("$dir/$file"); self::rmdirr("$dir/$file");
} }
} }
rmdir($dir); rmdir($dir);
}elseif(file_exists($dir)) { } elseif (file_exists($dir)) {
unlink($dir); unlink($dir);
} }
if(file_exists($dir)) { if (file_exists($dir)) {
return false; return false;
}else{ } else {
return true; return true;
} }
} }
static public function getMimetypeDetector() {
if (!self::$mimetypeDetector) {
self::$mimetypeDetector = new \OC\Files\Type\Detection();
self::$mimetypeDetector->registerTypeArray(include 'mimetypes.list.php');
}
return self::$mimetypeDetector;
}
/** /**
* Try to guess the mimetype based on filename * Try to guess the mimetype based on filename
* *
* @param string $path * @param string $path
* @return string * @return string
*/ */
static public function getFileNameMimeType($path){ static public function getFileNameMimeType($path) {
if(strpos($path, '.')) { return self::getMimetypeDetector()->detectPath($path);
//try to guess the type by the file extension
if(!self::$mimetypes || self::$mimetypes != include 'mimetypes.list.php') {
self::$mimetypes=include 'mimetypes.list.php';
}
$extension=strtolower(strrchr(basename($path), "."));
$extension=substr($extension, 1);//remove leading .
return (isset(self::$mimetypes[$extension]))?self::$mimetypes[$extension]:'application/octet-stream';
}else{
return 'application/octet-stream';
}
} }
/** /**
* get the mimetype form a local file * get the mimetype form a local file
*
* @param string $path * @param string $path
* @return string * @return string
* does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
*/ */
static function getMimeType($path) { static function getMimeType($path) {
$isWrapped=(strpos($path, '://')!==false) and (substr($path, 0, 7)=='file://'); return self::getMimetypeDetector()->detect($path);
if (@is_dir($path)) {
// directories are easy
return "httpd/unix-directory";
}
$mimeType = self::getFileNameMimeType($path);
if($mimeType=='application/octet-stream' and function_exists('finfo_open')
and function_exists('finfo_file') and $finfo=finfo_open(FILEINFO_MIME)) {
$info = @strtolower(finfo_file($finfo, $path));
if($info) {
$mimeType=substr($info, 0, strpos($info, ';'));
}
finfo_close($finfo);
}
if (!$isWrapped and $mimeType=='application/octet-stream' && function_exists("mime_content_type")) {
// use mime magic extension if available
$mimeType = mime_content_type($path);
}
if (!$isWrapped and $mimeType=='application/octet-stream' && OC_Helper::canExecute("file")) {
// it looks like we have a 'file' command,
// lets see if it does have mime support
$path=escapeshellarg($path);
$fp = popen("file -b --mime-type $path 2>/dev/null", "r");
$reply = fgets($fp);
pclose($fp);
//trim the newline
$mimeType = trim($reply);
}
return $mimeType;
} }
/** /**
* get the mimetype form a data string * get the mimetype form a data string
*
* @param string $data * @param string $data
* @return string * @return string
*/ */
static function getStringMimeType($data) { static function getStringMimeType($data) {
if(function_exists('finfo_open') and function_exists('finfo_file')) { return self::getMimetypeDetector()->detectString($data);
$finfo=finfo_open(FILEINFO_MIME);
return finfo_buffer($finfo, $data);
}else{
$tmpFile=OC_Helper::tmpFile();
$fh=fopen($tmpFile, 'wb');
fwrite($fh, $data, 8024);
fclose($fh);
$mime=self::getMimeType($tmpFile);
unset($tmpFile);
return $mime;
}
} }
/** /**
@ -454,9 +405,9 @@ class OC_Helper {
*/ */
//FIXME: should also check for value validation (i.e. the email is an email). //FIXME: should also check for value validation (i.e. the email is an email).
public static function init_var($s, $d="") { public static function init_var($s, $d = "") {
$r = $d; $r = $d;
if(isset($_REQUEST[$s]) && !empty($_REQUEST[$s])) { if (isset($_REQUEST[$s]) && !empty($_REQUEST[$s])) {
$r = OC_Util::sanitizeHTML($_REQUEST[$s]); $r = OC_Util::sanitizeHTML($_REQUEST[$s]);
} }
@ -466,12 +417,13 @@ class OC_Helper {
/** /**
* returns "checked"-attribute if request contains selected radio element * returns "checked"-attribute if request contains selected radio element
* OR if radio element is the default one -- maybe? * OR if radio element is the default one -- maybe?
*
* @param string $s Name of radio-button element name * @param string $s Name of radio-button element name
* @param string $v Value of current radio-button element * @param string $v Value of current radio-button element
* @param string $d Value of default radio-button element * @param string $d Value of default radio-button element
*/ */
public static function init_radio($s, $v, $d) { public static function init_radio($s, $v, $d) {
if((isset($_REQUEST[$s]) && $_REQUEST[$s]==$v) || (!isset($_REQUEST[$s]) && $v == $d)) if ((isset($_REQUEST[$s]) && $_REQUEST[$s] == $v) || (!isset($_REQUEST[$s]) && $v == $d))
print "checked=\"checked\" "; print "checked=\"checked\" ";
} }
@ -503,17 +455,17 @@ class OC_Helper {
$dirs = explode(PATH_SEPARATOR, $path); $dirs = explode(PATH_SEPARATOR, $path);
// WARNING : We have to check if open_basedir is enabled : // WARNING : We have to check if open_basedir is enabled :
$obd = ini_get('open_basedir'); $obd = ini_get('open_basedir');
if($obd != "none") { if ($obd != "none") {
$obd_values = explode(PATH_SEPARATOR, $obd); $obd_values = explode(PATH_SEPARATOR, $obd);
if(count($obd_values) > 0 and $obd_values[0]) { if (count($obd_values) > 0 and $obd_values[0]) {
// open_basedir is in effect ! // open_basedir is in effect !
// We need to check if the program is in one of these dirs : // We need to check if the program is in one of these dirs :
$dirs = $obd_values; $dirs = $obd_values;
} }
} }
foreach($dirs as $dir) { foreach ($dirs as $dir) {
foreach($exts as $ext) { foreach ($exts as $ext) {
if($check_fn("$dir/$name".$ext)) if ($check_fn("$dir/$name" . $ext))
return true; return true;
} }
} }
@ -522,18 +474,19 @@ class OC_Helper {
/** /**
* copy the contents of one stream to another * copy the contents of one stream to another
*
* @param resource $source * @param resource $source
* @param resource $target * @param resource $target
* @return int the number of bytes copied * @return int the number of bytes copied
*/ */
public static function streamCopy($source, $target) { public static function streamCopy($source, $target) {
if(!$source or !$target) { if (!$source or !$target) {
return false; return false;
} }
$result = true; $result = true;
$count = 0; $count = 0;
while(!feof($source)) { while (!feof($source)) {
if ( ( $c = fwrite($target, fread($source, 8192)) ) === false) { if (($c = fwrite($target, fread($source, 8192))) === false) {
$result = false; $result = false;
} else { } else {
$count += $c; $count += $c;
@ -544,37 +497,39 @@ class OC_Helper {
/** /**
* create a temporary file with an unique filename * create a temporary file with an unique filename
*
* @param string $postfix * @param string $postfix
* @return string * @return string
* *
* temporary files are automatically cleaned up after the script is finished * temporary files are automatically cleaned up after the script is finished
*/ */
public static function tmpFile($postfix='') { public static function tmpFile($postfix = '') {
$file=get_temp_dir().'/'.md5(time().rand()).$postfix; $file = get_temp_dir() . '/' . md5(time() . rand()) . $postfix;
$fh=fopen($file, 'w'); $fh = fopen($file, 'w');
fclose($fh); fclose($fh);
self::$tmpFiles[]=$file; self::$tmpFiles[] = $file;
return $file; return $file;
} }
/** /**
* move a file to oc-noclean temp dir * move a file to oc-noclean temp dir
*
* @param string $filename * @param string $filename
* @return mixed * @return mixed
* *
*/ */
public static function moveToNoClean($filename='') { public static function moveToNoClean($filename = '') {
if ($filename == '') { if ($filename == '') {
return false; return false;
} }
$tmpDirNoClean=get_temp_dir().'/oc-noclean/'; $tmpDirNoClean = get_temp_dir() . '/oc-noclean/';
if (!file_exists($tmpDirNoClean) || !is_dir($tmpDirNoClean)) { if (!file_exists($tmpDirNoClean) || !is_dir($tmpDirNoClean)) {
if (file_exists($tmpDirNoClean)) { if (file_exists($tmpDirNoClean)) {
unlink($tmpDirNoClean); unlink($tmpDirNoClean);
} }
mkdir($tmpDirNoClean); mkdir($tmpDirNoClean);
} }
$newname=$tmpDirNoClean.basename($filename); $newname = $tmpDirNoClean . basename($filename);
if (rename($filename, $newname)) { if (rename($filename, $newname)) {
return $newname; return $newname;
} else { } else {
@ -584,34 +539,35 @@ class OC_Helper {
/** /**
* create a temporary folder with an unique filename * create a temporary folder with an unique filename
*
* @return string * @return string
* *
* temporary files are automatically cleaned up after the script is finished * temporary files are automatically cleaned up after the script is finished
*/ */
public static function tmpFolder() { public static function tmpFolder() {
$path=get_temp_dir().'/'.md5(time().rand()); $path = get_temp_dir() . '/' . md5(time() . rand());
mkdir($path); mkdir($path);
self::$tmpFiles[]=$path; self::$tmpFiles[] = $path;
return $path.'/'; return $path . '/';
} }
/** /**
* remove all files created by self::tmpFile * remove all files created by self::tmpFile
*/ */
public static function cleanTmp() { public static function cleanTmp() {
$leftoversFile=get_temp_dir().'/oc-not-deleted'; $leftoversFile = get_temp_dir() . '/oc-not-deleted';
if(file_exists($leftoversFile)) { if (file_exists($leftoversFile)) {
$leftovers=file($leftoversFile); $leftovers = file($leftoversFile);
foreach($leftovers as $file) { foreach ($leftovers as $file) {
self::rmdirr($file); self::rmdirr($file);
} }
unlink($leftoversFile); unlink($leftoversFile);
} }
foreach(self::$tmpFiles as $file) { foreach (self::$tmpFiles as $file) {
if(file_exists($file)) { if (file_exists($file)) {
if(!self::rmdirr($file)) { if (!self::rmdirr($file)) {
file_put_contents($leftoversFile, $file."\n", FILE_APPEND); file_put_contents($leftoversFile, $file . "\n", FILE_APPEND);
} }
} }
} }
@ -621,8 +577,8 @@ class OC_Helper {
* remove all files in PHP /oc-noclean temp dir * remove all files in PHP /oc-noclean temp dir
*/ */
public static function cleanTmpNoClean() { public static function cleanTmpNoClean() {
$tmpDirNoCleanFile=get_temp_dir().'/oc-noclean/'; $tmpDirNoCleanFile = get_temp_dir() . '/oc-noclean/';
if(file_exists($tmpDirNoCleanFile)) { if (file_exists($tmpDirNoCleanFile)) {
self::rmdirr($tmpDirNoCleanFile); self::rmdirr($tmpDirNoCleanFile);
} }
} }
@ -647,8 +603,8 @@ class OC_Helper {
* @return string * @return string
*/ */
public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) { public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) {
if($path==='/') { if ($path === '/') {
$path=''; $path = '';
} }
if ($pos = strrpos($filename, '.')) { if ($pos = strrpos($filename, '.')) {
$name = substr($filename, 0, $pos); $name = substr($filename, 0, $pos);
@ -660,10 +616,10 @@ class OC_Helper {
$newpath = $path . '/' . $filename; $newpath = $path . '/' . $filename;
if ($view->file_exists($newpath)) { if ($view->file_exists($newpath)) {
if(preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) { if (preg_match_all('/\((\d+)\)/', $name, $matches, PREG_OFFSET_CAPTURE)) {
//Replace the last "(number)" with "(number+1)" //Replace the last "(number)" with "(number+1)"
$last_match = count($matches[0])-1; $last_match = count($matches[0]) - 1;
$counter = $matches[1][$last_match][0]+1; $counter = $matches[1][$last_match][0] + 1;
$offset = $matches[0][$last_match][1]; $offset = $matches[0][$last_match][1];
$match_length = strlen($matches[0][$last_match][0]); $match_length = strlen($matches[0][$last_match][0]);
} else { } else {
@ -671,9 +627,9 @@ class OC_Helper {
$offset = false; $offset = false;
} }
do { do {
if($offset) { if ($offset) {
//Replace the last "(number)" with "(number+1)" //Replace the last "(number)" with "(number+1)"
$newname = substr_replace($name, '('.$counter.')', $offset, $match_length); $newname = substr_replace($name, '(' . $counter . ')', $offset, $match_length);
} else { } else {
$newname = $name . ' (' . $counter . ')'; $newname = $name . ' (' . $counter . ')';
} }
@ -736,7 +692,7 @@ class OC_Helper {
$length = intval($length); $length = intval($length);
$string = mb_substr($string, 0, $start, $encoding) . $string = mb_substr($string, 0, $start, $encoding) .
$replacement . $replacement .
mb_substr($string, $start+$length, mb_strlen($string, 'UTF-8')-$start, $encoding); mb_substr($string, $start + $length, mb_strlen($string, 'UTF-8') - $start, $encoding);
return $string; return $string;
} }
@ -755,7 +711,7 @@ class OC_Helper {
public static function mb_str_replace($search, $replace, $subject, $encoding = 'UTF-8', &$count = null) { public static function mb_str_replace($search, $replace, $subject, $encoding = 'UTF-8', &$count = null) {
$offset = -1; $offset = -1;
$length = mb_strlen($search, $encoding); $length = mb_strlen($search, $encoding);
while(($i = mb_strrpos($subject, $search, $offset, $encoding)) !== false ) { while (($i = mb_strrpos($subject, $search, $offset, $encoding)) !== false) {
$subject = OC_Helper::mb_substr_replace($subject, $replace, $i, $length); $subject = OC_Helper::mb_substr_replace($subject, $replace, $i, $length);
$offset = $i - mb_strlen($subject, $encoding); $offset = $i - mb_strlen($subject, $encoding);
$count++; $count++;
@ -778,7 +734,7 @@ class OC_Helper {
$aIt = new RecursiveArrayIterator($haystack); $aIt = new RecursiveArrayIterator($haystack);
$it = new RecursiveIteratorIterator($aIt); $it = new RecursiveIteratorIterator($aIt);
while($it->valid()) { while ($it->valid()) {
if (((isset($index) AND ($it->key() == $index)) OR (!isset($index))) AND ($it->current() == $needle)) { if (((isset($index) AND ($it->key() == $index)) OR (!isset($index))) AND ($it->current() == $needle)) {
return $aIt->key(); return $aIt->key();
} }
@ -792,6 +748,7 @@ class OC_Helper {
/** /**
* Shortens str to maxlen by replacing characters in the middle with '...', eg. * Shortens str to maxlen by replacing characters in the middle with '...', eg.
* ellipsis('a very long string with lots of useless info to make a better example', 14) becomes 'a very ...example' * ellipsis('a very long string with lots of useless info to make a better example', 14) becomes 'a very ...example'
*
* @param string $str the string * @param string $str the string
* @param string $maxlen the maximum length of the result * @param string $maxlen the maximum length of the result
* @return string with at most maxlen characters * @return string with at most maxlen characters
@ -822,7 +779,7 @@ class OC_Helper {
$maxUploadFilesize = min($upload_max_filesize, $post_max_size); $maxUploadFilesize = min($upload_max_filesize, $post_max_size);
} }
if($freeSpace !== \OC\Files\FREE_SPACE_UNKNOWN){ if ($freeSpace !== \OC\Files\FREE_SPACE_UNKNOWN) {
$freeSpace = max($freeSpace, 0); $freeSpace = max($freeSpace, 0);
return min($maxUploadFilesize, $freeSpace); return min($maxUploadFilesize, $freeSpace);
@ -833,6 +790,7 @@ class OC_Helper {
/** /**
* Checks if a function is available * Checks if a function is available
*
* @param string $function_name * @param string $function_name
* @return bool * @return bool
*/ */
@ -861,7 +819,7 @@ class OC_Helper {
$used = 0; $used = 0;
} }
$free = \OC\Files\Filesystem::free_space(); $free = \OC\Files\Filesystem::free_space();
if ($free >= 0){ if ($free >= 0) {
$total = $free + $used; $total = $free + $used;
} else { } else {
$total = $free; //either unknown or unlimited $total = $free; //either unknown or unlimited
@ -869,7 +827,7 @@ class OC_Helper {
if ($total == 0) { if ($total == 0) {
$total = 1; // prevent division by zero $total = 1; // prevent division by zero
} }
if ($total >= 0){ if ($total >= 0) {
$relative = round(($used / $total) * 10000) / 100; $relative = round(($used / $total) * 10000) / 100;
} else { } else {
$relative = 0; $relative = 0;