2011-03-03 00:18:22 +03:00
< ? php
/**
2011-03-13 19:25:34 +03:00
* ownCloud
*
* @ author Frank Karlitschek
* @ author Jakob Sack
2012-05-26 21:14:24 +04:00
* @ copyright 2012 Frank Karlitschek frank @ owncloud . org
2011-03-13 19:25:34 +03:00
*
* This library is free software ; you can redistribute it and / or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation ; either
* version 3 of the License , or any later version .
*
* This library 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
* GNU AFFERO GENERAL PUBLIC LICENSE for more details .
*
* You should have received a copy of the GNU Affero General Public
* License along with this library . If not , see < http :// www . gnu . org / licenses />.
*
*/
2011-03-03 00:18:22 +03:00
/**
2011-03-13 19:25:34 +03:00
* Collection of useful functions
2011-03-03 00:18:22 +03:00
*/
2011-07-29 23:36:03 +04:00
class OC_Helper {
2013-08-07 18:38:57 +04:00
private static $tmpFiles = array ();
2013-05-29 17:43:41 +04:00
private static $mimetypeIcons = array ();
2013-08-07 18:38:57 +04:00
private static $mimetypeDetector ;
2013-08-07 18:53:09 +04:00
private static $templateManager ;
2012-04-14 00:59:47 +04:00
2012-09-12 20:00:33 +04:00
/**
* @ brief Creates an url using a defined route
* @ param $route
2013-01-05 02:00:51 +04:00
* @ param array $parameters
* @ return
* @ internal param array $args with param => value , will be appended to the returned url
2012-09-12 20:00:33 +04:00
* @ returns the url
*
* Returns a url to the given app and file .
*/
2013-08-07 18:38:57 +04:00
public static function linkToRoute ( $route , $parameters = array ()) {
2012-09-12 20:00:33 +04:00
$urlLinkTo = OC :: getRouter () -> generate ( $route , $parameters );
return $urlLinkTo ;
}
2011-03-03 00:18:22 +03:00
/**
2011-03-13 19:25:34 +03:00
* @ brief Creates an url
2012-09-23 04:39:11 +04:00
* @ param string $app app
* @ param string $file file
* @ param array $args array with param => value , will be appended to the returned url
2013-08-07 18:38:57 +04:00
* The value of $args will be urlencoded
2012-09-23 04:39:11 +04:00
* @ return string the url
2011-03-03 00:18:22 +03:00
*
2011-03-13 19:25:34 +03:00
* Returns a url to the given app and file .
2011-03-03 00:18:22 +03:00
*/
2012-09-07 17:22:01 +04:00
public static function linkTo ( $app , $file , $args = array () ) {
if ( $app != '' ) {
2012-06-28 23:26:03 +04:00
$app_path = OC_App :: getAppPath ( $app );
2011-06-02 22:21:02 +04:00
// Check if the app is in the app folder
2013-08-07 18:38:57 +04:00
if ( $app_path && file_exists ( $app_path . '/' . $file )) {
if ( substr ( $file , - 3 ) == 'php' || substr ( $file , - 3 ) == 'css' ) {
$urlLinkTo = OC :: $WEBROOT . '/index.php/apps/' . $app ;
$urlLinkTo .= ( $file != 'index.php' ) ? '/' . $file : '' ;
} else {
$urlLinkTo = OC_App :: getAppWebPath ( $app ) . '/' . $file ;
2012-05-08 19:07:20 +04:00
}
2013-08-07 18:38:57 +04:00
} else {
$urlLinkTo = OC :: $WEBROOT . '/' . $app . '/' . $file ;
2011-06-02 22:21:02 +04:00
}
2013-08-07 18:38:57 +04:00
} else {
if ( file_exists ( OC :: $SERVERROOT . '/core/' . $file )) {
$urlLinkTo = OC :: $WEBROOT . '/core/' . $file ;
} else {
$urlLinkTo = OC :: $WEBROOT . '/' . $file ;
2011-06-20 23:01:34 +04:00
}
2011-06-20 22:29:30 +04:00
}
2011-06-24 23:44:28 +04:00
2013-01-25 20:02:44 +04:00
if ( $args && $query = http_build_query ( $args , '' , '&' )) {
2013-08-07 18:38:57 +04:00
$urlLinkTo .= '?' . $query ;
2012-09-03 20:13:45 +04:00
}
2012-02-21 23:05:02 +04:00
return $urlLinkTo ;
2011-03-03 00:18:22 +03:00
}
2012-02-16 22:45:00 +04:00
/**
* @ brief Creates an absolute url
2012-09-23 04:39:11 +04:00
* @ param string $app app
* @ param string $file file
* @ param array $args array with param => value , will be appended to the returned url
2013-08-07 18:38:57 +04:00
* The value of $args will be urlencoded
2012-09-23 04:39:11 +04:00
* @ return string the url
2012-02-16 22:45:00 +04:00
*
* Returns a absolute url to the given app and file .
*/
2013-08-07 18:38:57 +04:00
public static function linkToAbsolute ( $app , $file , $args = array ()) {
$urlLinkTo = self :: linkTo ( $app , $file , $args );
2012-08-07 00:15:55 +04:00
return self :: makeURLAbsolute ( $urlLinkTo );
}
/**
* @ brief Makes an $url absolute
2012-09-23 04:39:11 +04:00
* @ param string $url the url
* @ return string the absolute url
2012-08-07 00:15:55 +04:00
*
* Returns a absolute url to the given app and file .
*/
2013-08-07 18:38:57 +04:00
public static function makeURLAbsolute ( $url ) {
return OC_Request :: serverProtocol () . '://' . OC_Request :: serverHost () . $url ;
2012-02-16 22:45:00 +04:00
}
2012-10-17 12:52:16 +04:00
/**
* @ brief Creates an url for remote use
* @ param string $service id
* @ return string the url
*
* Returns a url to the given service .
*/
2013-08-07 18:38:57 +04:00
public static function linkToRemoteBase ( $service ) {
return self :: linkTo ( '' , 'remote.php' ) . '/' . $service ;
2012-10-17 12:52:16 +04:00
}
2012-05-07 22:22:55 +04:00
/**
* @ brief Creates an absolute url for remote use
2012-09-23 04:39:11 +04:00
* @ param string $service id
2013-01-05 02:00:51 +04:00
* @ param bool $add_slash
2012-09-23 04:39:11 +04:00
* @ return string the url
2012-05-07 22:22:55 +04:00
*
* Returns a absolute url to the given service .
*/
2013-08-07 18:38:57 +04:00
public static function linkToRemote ( $service , $add_slash = true ) {
2013-02-11 20:44:02 +04:00
return self :: makeURLAbsolute ( self :: linkToRemoteBase ( $service ))
2013-08-07 18:38:57 +04:00
. (( $add_slash && $service [ strlen ( $service ) - 1 ] != '/' ) ? '/' : '' );
2012-05-07 22:22:55 +04:00
}
2012-08-27 23:46:05 +04:00
/**
* @ brief Creates an absolute url for public use
2012-09-23 04:39:11 +04:00
* @ param string $service id
2013-01-05 02:00:51 +04:00
* @ param bool $add_slash
2012-09-23 04:39:11 +04:00
* @ return string the url
2012-08-27 23:46:05 +04:00
*
* Returns a absolute url to the given service .
*/
public static function linkToPublic ( $service , $add_slash = false ) {
2013-08-07 18:38:57 +04:00
return self :: linkToAbsolute ( '' , 'public.php' ) . '?service=' . $service
. (( $add_slash && $service [ strlen ( $service ) - 1 ] != '/' ) ? '/' : '' );
2012-08-27 23:46:05 +04:00
}
2011-03-03 00:18:22 +03:00
/**
2011-03-13 19:25:34 +03:00
* @ brief Creates path to an image
2012-09-23 04:39:11 +04:00
* @ param string $app app
* @ param string $image image name
* @ return string the url
2011-03-03 00:18:22 +03:00
*
2011-03-13 19:25:34 +03:00
* Returns the path to the image .
2011-03-03 00:18:22 +03:00
*/
2013-08-07 18:38:57 +04:00
public static function imagePath ( $app , $image ) {
2012-02-27 21:01:43 +04:00
// Read the selected theme from the config file
2013-04-24 15:45:40 +04:00
$theme = OC_Util :: getTheme ();
2012-02-14 19:32:38 +04:00
2012-02-27 21:01:43 +04:00
// Check if the app is in the app folder
2013-08-07 18:38:57 +04:00
if ( file_exists ( OC :: $SERVERROOT . " /themes/ $theme /apps/ $app /img/ $image " )) {
return OC :: $WEBROOT . " /themes/ $theme /apps/ $app /img/ $image " ;
} elseif ( file_exists ( OC_App :: getAppPath ( $app ) . " /img/ $image " )) {
return OC_App :: getAppWebPath ( $app ) . " /img/ $image " ;
} elseif ( ! empty ( $app ) and file_exists ( OC :: $SERVERROOT . " /themes/ $theme / $app /img/ $image " )) {
return OC :: $WEBROOT . " /themes/ $theme / $app /img/ $image " ;
} elseif ( ! empty ( $app ) and file_exists ( OC :: $SERVERROOT . " / $app /img/ $image " )) {
return OC :: $WEBROOT . " / $app /img/ $image " ;
} elseif ( file_exists ( OC :: $SERVERROOT . " /themes/ $theme /core/img/ $image " )) {
return OC :: $WEBROOT . " /themes/ $theme /core/img/ $image " ;
} elseif ( file_exists ( OC :: $SERVERROOT . " /core/img/ $image " )) {
return OC :: $WEBROOT . " /core/img/ $image " ;
} else {
throw new RuntimeException ( 'image not found: image:' . $image . ' webroot:' . OC :: $WEBROOT . ' serverroot:' . OC :: $SERVERROOT );
2012-02-27 21:01:43 +04:00
}
}
2011-03-03 00:18:22 +03:00
/**
2011-08-11 20:59:01 +04:00
* @ brief get path to icon of file type
2012-09-23 04:39:11 +04:00
* @ param string $mimetype mimetype
* @ return string the url
2011-03-03 00:18:22 +03:00
*
2011-08-11 20:59:01 +04:00
* Returns the path to the image of this file type .
2011-03-03 00:18:22 +03:00
*/
2013-05-29 18:56:28 +04:00
public static function mimetypeIcon ( $mimetype ) {
$alias = array ( 'application/xml' => 'code/xml' );
if ( isset ( $alias [ $mimetype ])) {
$mimetype = $alias [ $mimetype ];
2011-10-08 23:18:47 +04:00
}
2013-05-29 17:43:41 +04:00
if ( isset ( self :: $mimetypeIcons [ $mimetype ])) {
return self :: $mimetypeIcons [ $mimetype ];
}
2013-01-19 22:45:28 +04:00
// Replace slash and backslash with a minus
2013-05-29 18:56:28 +04:00
$icon = str_replace ( '/' , '-' , $mimetype );
2013-08-07 18:38:57 +04:00
$icon = str_replace ( '\\' , '-' , $icon );
2011-03-03 00:18:22 +03:00
// Is it a dir?
2013-05-29 18:56:28 +04:00
if ( $mimetype === 'dir' ) {
2013-08-07 18:38:57 +04:00
self :: $mimetypeIcons [ $mimetype ] = OC :: $WEBROOT . '/core/img/filetypes/folder.png' ;
return OC :: $WEBROOT . '/core/img/filetypes/folder.png' ;
2011-03-03 00:18:22 +03:00
}
// Icon exists?
2013-08-07 18:38:57 +04:00
if ( file_exists ( OC :: $SERVERROOT . '/core/img/filetypes/' . $icon . '.png' )) {
self :: $mimetypeIcons [ $mimetype ] = OC :: $WEBROOT . '/core/img/filetypes/' . $icon . '.png' ;
return OC :: $WEBROOT . '/core/img/filetypes/' . $icon . '.png' ;
2011-07-29 03:36:31 +04:00
}
2013-05-29 18:56:28 +04:00
// Try only the first part of the filetype
$mimePart = substr ( $icon , 0 , strpos ( $icon , '-' ));
2013-08-07 18:38:57 +04:00
if ( file_exists ( OC :: $SERVERROOT . '/core/img/filetypes/' . $mimePart . '.png' )) {
self :: $mimetypeIcons [ $mimetype ] = OC :: $WEBROOT . '/core/img/filetypes/' . $mimePart . '.png' ;
return OC :: $WEBROOT . '/core/img/filetypes/' . $mimePart . '.png' ;
2013-05-29 18:56:28 +04:00
} else {
2013-08-07 18:38:57 +04:00
self :: $mimetypeIcons [ $mimetype ] = OC :: $WEBROOT . '/core/img/filetypes/file.png' ;
return OC :: $WEBROOT . '/core/img/filetypes/file.png' ;
2011-03-03 00:18:22 +03:00
}
}
2011-03-03 00:28:32 +03:00
/**
2011-03-13 19:25:34 +03:00
* @ brief Make a human file size
2012-09-23 04:39:11 +04:00
* @ param int $bytes file size in bytes
* @ return string a human readable file size
2011-03-03 00:28:32 +03:00
*
2011-03-13 19:25:34 +03:00
* Makes 2048 to 2 kB .
2011-03-03 00:28:32 +03:00
*/
2013-08-07 18:38:57 +04:00
public static function humanFileSize ( $bytes ) {
if ( $bytes < 0 ) {
2013-01-15 02:39:31 +04:00
$l = OC_L10N :: get ( 'lib' );
2013-08-04 18:27:17 +04:00
return " ? " ;
2013-01-15 02:39:31 +04:00
}
2013-08-07 18:38:57 +04:00
if ( $bytes < 1024 ) {
2011-03-03 00:28:32 +03:00
return " $bytes B " ;
}
2013-08-07 18:38:57 +04:00
$bytes = round ( $bytes / 1024 , 1 );
if ( $bytes < 1024 ) {
2011-03-03 00:28:32 +03:00
return " $bytes kB " ;
}
2013-08-07 18:38:57 +04:00
$bytes = round ( $bytes / 1024 , 1 );
if ( $bytes < 1024 ) {
2011-03-03 00:28:32 +03:00
return " $bytes MB " ;
}
// Wow, heavy duty for owncloud
2013-08-07 18:38:57 +04:00
$bytes = round ( $bytes / 1024 , 1 );
2011-03-03 00:28:32 +03:00
return " $bytes GB " ;
}
2012-04-14 00:59:47 +04:00
2011-04-17 14:03:23 +04:00
/**
* @ brief Make a computer file size
2012-09-23 04:39:11 +04:00
* @ param string $str file size in a fancy format
* @ return int a file size in bytes
2011-04-17 14:03:23 +04:00
*
* Makes 2 kB to 2048.
*
* Inspired by : http :// www . php . net / manual / en / function . filesize . php #92418
*/
2013-08-07 18:38:57 +04:00
public static function computerFileSize ( $str ) {
$str = strtolower ( $str );
2011-04-17 14:03:23 +04:00
$bytes_array = array (
2011-12-12 02:33:24 +04:00
'b' => 1 ,
'k' => 1024 ,
'kb' => 1024 ,
'mb' => 1024 * 1024 ,
2013-08-07 18:38:57 +04:00
'm' => 1024 * 1024 ,
2011-12-12 02:33:24 +04:00
'gb' => 1024 * 1024 * 1024 ,
2013-08-07 18:38:57 +04:00
'g' => 1024 * 1024 * 1024 ,
2011-12-12 02:33:24 +04:00
'tb' => 1024 * 1024 * 1024 * 1024 ,
2013-08-07 18:38:57 +04:00
't' => 1024 * 1024 * 1024 * 1024 ,
2011-12-12 02:33:24 +04:00
'pb' => 1024 * 1024 * 1024 * 1024 * 1024 ,
2013-08-07 18:38:57 +04:00
'p' => 1024 * 1024 * 1024 * 1024 * 1024 ,
2011-04-17 14:03:23 +04:00
);
$bytes = floatval ( $str );
2011-12-12 02:33:24 +04:00
if ( preg_match ( '#([kmgtp]?b?)$#si' , $str , $matches ) && ! empty ( $bytes_array [ $matches [ 1 ]])) {
2011-04-17 14:03:23 +04:00
$bytes *= $bytes_array [ $matches [ 1 ]];
}
2012-02-26 06:31:04 +04:00
$bytes = round ( $bytes , 2 );
2011-04-17 14:03:23 +04:00
2012-04-14 00:59:47 +04:00
return $bytes ;
2011-04-17 14:03:23 +04:00
}
2012-04-14 00:59:47 +04:00
2011-04-16 12:23:15 +04:00
/**
2012-09-23 04:39:11 +04:00
* @ brief Recursive editing of file permissions
* @ param string $path path to file or folder
* @ param int $filemode unix style file permissions
* @ return bool
2011-04-16 12:23:15 +04:00
*/
2011-04-24 17:23:18 +04:00
static function chmodr ( $path , $filemode ) {
2011-04-16 12:23:15 +04:00
if ( ! is_dir ( $path ))
return chmod ( $path , $filemode );
$dh = opendir ( $path );
while (( $file = readdir ( $dh )) !== false ) {
2013-08-07 18:38:57 +04:00
if ( $file != '.' && $file != '..' ) {
$fullpath = $path . '/' . $file ;
if ( is_link ( $fullpath ))
2012-10-23 10:01:09 +04:00
return false ;
2013-08-07 18:38:57 +04:00
elseif ( ! is_dir ( $fullpath ) && !@ chmod ( $fullpath , $filemode ))
return false ; elseif ( ! self :: chmodr ( $fullpath , $filemode ))
2012-10-23 10:01:09 +04:00
return false ;
2011-04-16 12:23:15 +04:00
}
}
closedir ( $dh );
2013-08-07 18:38:57 +04:00
if ( @ chmod ( $path , $filemode ))
2012-10-23 10:01:09 +04:00
return true ;
2011-04-16 12:23:15 +04:00
else
2012-10-23 10:01:09 +04:00
return false ;
2011-04-16 12:23:15 +04:00
}
2011-05-28 19:33:25 +04:00
/**
2012-09-23 04:39:11 +04:00
* @ brief Recursive copying of folders
2011-05-28 19:33:25 +04:00
* @ param string $src source folder
* @ param string $dest target folder
*
*/
static function copyr ( $src , $dest ) {
2013-08-07 18:38:57 +04:00
if ( is_dir ( $src )) {
if ( ! is_dir ( $dest )) {
2011-05-28 19:33:25 +04:00
mkdir ( $dest );
}
$files = scandir ( $src );
2012-09-07 17:22:01 +04:00
foreach ( $files as $file ) {
if ( $file != " . " && $file != " .. " ) {
2011-05-28 19:33:25 +04:00
self :: copyr ( " $src / $file " , " $dest / $file " );
}
}
2013-08-07 18:38:57 +04:00
} elseif ( file_exists ( $src ) && ! \OC\Files\Filesystem :: isFileBlacklisted ( $src )) {
2011-05-28 19:33:25 +04:00
copy ( $src , $dest );
}
}
2012-04-14 00:59:47 +04:00
2011-05-28 19:33:25 +04:00
/**
2012-09-23 04:39:11 +04:00
* @ brief Recursive deletion of folders
2011-05-28 19:33:25 +04:00
* @ param string $dir path to the folder
2012-09-23 04:39:11 +04:00
* @ return bool
2011-05-28 19:33:25 +04:00
*/
static function rmdirr ( $dir ) {
2013-08-07 18:38:57 +04:00
if ( is_dir ( $dir )) {
$files = scandir ( $dir );
foreach ( $files as $file ) {
2012-09-07 17:22:01 +04:00
if ( $file != " . " && $file != " .. " ) {
2011-05-28 19:33:25 +04:00
self :: rmdirr ( " $dir / $file " );
}
}
rmdir ( $dir );
2013-08-07 18:38:57 +04:00
} elseif ( file_exists ( $dir )) {
2011-05-28 19:33:25 +04:00
unlink ( $dir );
}
2013-08-07 18:38:57 +04:00
if ( file_exists ( $dir )) {
2012-04-14 00:59:47 +04:00
return false ;
2013-08-07 18:38:57 +04:00
} else {
2012-09-23 04:39:11 +04:00
return true ;
2012-04-14 00:59:47 +04:00
}
2011-05-28 19:33:25 +04:00
}
2012-02-16 00:44:58 +04:00
2013-08-07 18:53:09 +04:00
/**
* @ return \OC\Files\Type\Detection
*/
2013-08-07 18:38:57 +04:00
static public function getMimetypeDetector () {
if ( ! self :: $mimetypeDetector ) {
self :: $mimetypeDetector = new \OC\Files\Type\Detection ();
self :: $mimetypeDetector -> registerTypeArray ( include 'mimetypes.list.php' );
}
return self :: $mimetypeDetector ;
}
2013-08-07 18:53:09 +04:00
/**
* @ return \OC\Files\Type\TemplateManager
*/
static public function getFileTemplateManager () {
if ( ! self :: $templateManager ) {
self :: $templateManager = new \OC\Files\Type\TemplateManager ();
}
return self :: $templateManager ;
}
2012-02-16 00:44:58 +04:00
/**
2013-06-07 01:51:44 +04:00
* Try to guess the mimetype based on filename
*
2013-06-07 02:17:51 +04:00
* @ param string $path
2012-02-16 00:44:58 +04:00
* @ return string
*/
2013-08-07 18:38:57 +04:00
static public function getFileNameMimeType ( $path ) {
return self :: getMimetypeDetector () -> detectPath ( $path );
2013-06-07 01:51:44 +04:00
}
/**
* get the mimetype form a local file
2013-08-07 18:38:57 +04:00
*
2013-06-07 01:51:44 +04:00
* @ param string $path
* @ return string
* does NOT work for ownClouds filesystem , use OC_FileSystem :: getMimeType instead
*/
static function getMimeType ( $path ) {
2013-08-07 18:38:57 +04:00
return self :: getMimetypeDetector () -> detect ( $path );
2012-02-16 00:44:58 +04:00
}
2012-04-14 00:59:47 +04:00
2012-04-18 22:24:22 +04:00
/**
* get the mimetype form a data string
2013-08-07 18:38:57 +04:00
*
2012-09-23 04:39:11 +04:00
* @ param string $data
2012-04-18 22:24:22 +04:00
* @ return string
*/
2012-09-07 17:22:01 +04:00
static function getStringMimeType ( $data ) {
2013-08-07 18:38:57 +04:00
return self :: getMimetypeDetector () -> detectString ( $data );
2012-04-18 22:24:22 +04:00
}
2011-05-18 00:34:31 +04:00
/**
* @ brief Checks $_REQUEST contains a var for the $s key . If so , returns the html - escaped value of this var ; otherwise returns the default value provided by $d .
2012-09-23 04:39:11 +04:00
* @ param string $s name of the var to escape , if set .
* @ param string $d default value .
* @ return string the print - safe value .
2011-05-18 00:34:31 +04:00
*
*/
2012-04-14 00:59:47 +04:00
2011-05-18 00:34:31 +04:00
//FIXME: should also check for value validation (i.e. the email is an email).
2013-08-07 18:38:57 +04:00
public static function init_var ( $s , $d = " " ) {
2011-05-18 00:34:31 +04:00
$r = $d ;
2013-08-07 18:38:57 +04:00
if ( isset ( $_REQUEST [ $s ]) && ! empty ( $_REQUEST [ $s ])) {
2013-02-10 17:03:40 +04:00
$r = OC_Util :: sanitizeHTML ( $_REQUEST [ $s ]);
2013-02-10 17:09:49 +04:00
}
2012-04-14 00:59:47 +04:00
2011-05-18 00:34:31 +04:00
return $r ;
}
2012-04-14 00:59:47 +04:00
2011-09-30 20:22:12 +04:00
/**
2013-02-11 20:44:02 +04:00
* returns " checked " - attribute if request contains selected radio element
* OR if radio element is the default one -- maybe ?
2013-08-07 18:38:57 +04:00
*
2011-09-30 20:22:12 +04:00
* @ param string $s Name of radio - button element name
* @ param string $v Value of current radio - button element
* @ param string $d Value of default radio - button element
*/
2011-05-18 00:34:31 +04:00
public static function init_radio ( $s , $v , $d ) {
2013-08-07 18:38:57 +04:00
if (( isset ( $_REQUEST [ $s ]) && $_REQUEST [ $s ] == $v ) || ( ! isset ( $_REQUEST [ $s ]) && $v == $d ))
2011-05-18 00:34:31 +04:00
print " checked= \" checked \" " ;
}
2011-07-28 22:10:58 +04:00
/**
2013-01-05 02:00:51 +04:00
* detect if a given program is found in the search PATH
*
* @ param $name
* @ param bool $path
* @ internal param string $program name
* @ internal param string $optional search path , defaults to $PATH
* @ return bool true if executable program found in path
*/
2012-09-07 17:22:01 +04:00
public static function canExecute ( $name , $path = false ) {
2011-07-28 22:10:58 +04:00
// path defaults to PATH from environment if not set
if ( $path === false ) {
$path = getenv ( " PATH " );
}
// check method depends on operating system
if ( ! strncmp ( PHP_OS , " WIN " , 3 )) {
// on Windows an appropriate COM or EXE file needs to exist
$exts = array ( " .exe " , " .com " );
$check_fn = " file_exists " ;
} else {
// anywhere else we look for an executable file of that name
$exts = array ( " " );
$check_fn = " is_executable " ;
}
// Default check will be done with $path directories :
$dirs = explode ( PATH_SEPARATOR , $path );
// WARNING : We have to check if open_basedir is enabled :
$obd = ini_get ( 'open_basedir' );
2013-08-07 18:38:57 +04:00
if ( $obd != " none " ) {
2011-07-28 22:10:58 +04:00
$obd_values = explode ( PATH_SEPARATOR , $obd );
2013-08-07 18:38:57 +04:00
if ( count ( $obd_values ) > 0 and $obd_values [ 0 ]) {
2012-09-23 04:39:11 +04:00
// open_basedir is in effect !
// We need to check if the program is in one of these dirs :
$dirs = $obd_values ;
}
}
2013-08-07 18:38:57 +04:00
foreach ( $dirs as $dir ) {
foreach ( $exts as $ext ) {
if ( $check_fn ( " $dir / $name " . $ext ))
2011-07-28 22:10:58 +04:00
return true ;
}
}
return false ;
}
2012-04-14 00:59:47 +04:00
2012-02-27 15:04:04 +04:00
/**
* copy the contents of one stream to another
2013-08-07 18:38:57 +04:00
*
2012-09-23 04:39:11 +04:00
* @ param resource $source
* @ param resource $target
2012-02-27 15:04:04 +04:00
* @ return int the number of bytes copied
*/
2012-11-02 22:53:02 +04:00
public static function streamCopy ( $source , $target ) {
2013-08-07 18:38:57 +04:00
if ( ! $source or ! $target ) {
2012-02-27 15:04:04 +04:00
return false ;
}
2013-02-22 19:43:11 +04:00
$result = true ;
$count = 0 ;
2013-08-07 18:38:57 +04:00
while ( ! feof ( $source )) {
if (( $c = fwrite ( $target , fread ( $source , 8192 ))) === false ) {
2013-02-22 17:56:50 +04:00
$result = false ;
2013-02-22 19:43:11 +04:00
} else {
$count += $c ;
2013-02-22 17:56:50 +04:00
}
2012-02-27 15:04:04 +04:00
}
2013-02-22 19:43:11 +04:00
return array ( $count , $result );
2012-02-27 15:04:04 +04:00
}
2012-04-14 00:59:47 +04:00
2012-02-28 14:16:19 +04:00
/**
* create a temporary file with an unique filename
2013-08-07 18:38:57 +04:00
*
2012-09-23 04:39:11 +04:00
* @ param string $postfix
2012-02-28 14:16:19 +04:00
* @ return string
*
* temporary files are automatically cleaned up after the script is finished
*/
2013-08-07 18:38:57 +04:00
public static function tmpFile ( $postfix = '' ) {
$file = get_temp_dir () . '/' . md5 ( time () . rand ()) . $postfix ;
$fh = fopen ( $file , 'w' );
2012-02-28 14:32:45 +04:00
fclose ( $fh );
2013-08-07 18:38:57 +04:00
self :: $tmpFiles [] = $file ;
2012-02-28 14:16:19 +04:00
return $file ;
}
2012-03-29 00:30:55 +04:00
2012-10-19 02:11:20 +04:00
/**
2013-03-21 01:37:02 +04:00
* move a file to oc - noclean temp dir
2013-08-07 18:38:57 +04:00
*
2013-03-21 01:37:02 +04:00
* @ param string $filename
* @ return mixed
2012-10-19 02:11:20 +04:00
*
*/
2013-08-07 18:38:57 +04:00
public static function moveToNoClean ( $filename = '' ) {
2013-03-21 01:37:02 +04:00
if ( $filename == '' ) {
return false ;
}
2013-08-07 18:38:57 +04:00
$tmpDirNoClean = get_temp_dir () . '/oc-noclean/' ;
2012-10-19 02:11:20 +04:00
if ( ! file_exists ( $tmpDirNoClean ) || ! is_dir ( $tmpDirNoClean )) {
2012-10-31 02:37:31 +04:00
if ( file_exists ( $tmpDirNoClean )) {
2012-10-19 02:11:20 +04:00
unlink ( $tmpDirNoClean );
2012-10-31 02:37:31 +04:00
}
2012-10-19 02:11:20 +04:00
mkdir ( $tmpDirNoClean );
}
2013-08-07 18:38:57 +04:00
$newname = $tmpDirNoClean . basename ( $filename );
2013-03-21 01:37:02 +04:00
if ( rename ( $filename , $newname )) {
return $newname ;
} else {
return false ;
}
2012-10-19 02:11:20 +04:00
}
2013-01-14 23:30:39 +04:00
2012-03-29 00:30:55 +04:00
/**
* create a temporary folder with an unique filename
2013-08-07 18:38:57 +04:00
*
2012-03-29 00:30:55 +04:00
* @ return string
*
* temporary files are automatically cleaned up after the script is finished
*/
2012-09-07 17:22:01 +04:00
public static function tmpFolder () {
2013-08-07 18:38:57 +04:00
$path = get_temp_dir () . '/' . md5 ( time () . rand ());
2012-03-29 00:30:55 +04:00
mkdir ( $path );
2013-08-07 18:38:57 +04:00
self :: $tmpFiles [] = $path ;
return $path . '/' ;
2012-03-29 00:30:55 +04:00
}
2012-04-14 00:59:47 +04:00
2012-02-28 14:16:19 +04:00
/**
* remove all files created by self :: tmpFile
*/
2012-09-07 17:22:01 +04:00
public static function cleanTmp () {
2013-08-07 18:38:57 +04:00
$leftoversFile = get_temp_dir () . '/oc-not-deleted' ;
if ( file_exists ( $leftoversFile )) {
$leftovers = file ( $leftoversFile );
foreach ( $leftovers as $file ) {
2012-04-14 00:59:47 +04:00
self :: rmdirr ( $file );
}
unlink ( $leftoversFile );
}
2013-08-07 18:38:57 +04:00
foreach ( self :: $tmpFiles as $file ) {
if ( file_exists ( $file )) {
if ( ! self :: rmdirr ( $file )) {
file_put_contents ( $leftoversFile , $file . " \n " , FILE_APPEND );
2012-04-14 00:59:47 +04:00
}
2012-02-28 14:16:19 +04:00
}
}
}
2012-04-15 18:59:39 +04:00
2012-10-19 02:11:20 +04:00
/**
2013-06-07 01:51:44 +04:00
* remove all files in PHP / oc - noclean temp dir
2012-10-19 02:11:20 +04:00
*/
public static function cleanTmpNoClean () {
2013-08-07 18:38:57 +04:00
$tmpDirNoCleanFile = get_temp_dir () . '/oc-noclean/' ;
if ( file_exists ( $tmpDirNoCleanFile )) {
2012-10-19 02:11:20 +04:00
self :: rmdirr ( $tmpDirNoCleanFile );
}
}
2012-06-14 14:57:30 +04:00
/**
2013-08-07 18:38:57 +04:00
* Adds a suffix to the name in case the file exists
*
* @ param $path
* @ param $filename
* @ return string
*/
2012-09-07 17:22:01 +04:00
public static function buildNotExistingFileName ( $path , $filename ) {
2013-03-08 17:22:04 +04:00
$view = \OC\Files\Filesystem :: getView ();
return self :: buildNotExistingFileNameForView ( $path , $filename , $view );
}
/**
2013-08-07 18:38:57 +04:00
* Adds a suffix to the name in case the file exists
*
* @ param $path
* @ param $filename
* @ return string
*/
2013-03-08 17:22:04 +04:00
public static function buildNotExistingFileNameForView ( $path , $filename , \OC\Files\View $view ) {
2013-08-07 18:38:57 +04:00
if ( $path === '/' ) {
$path = '' ;
2012-06-14 14:57:30 +04:00
}
if ( $pos = strrpos ( $filename , '.' )) {
$name = substr ( $filename , 0 , $pos );
$ext = substr ( $filename , $pos );
} else {
$name = $filename ;
2012-09-23 04:39:11 +04:00
$ext = '' ;
2012-06-14 14:57:30 +04:00
}
$newpath = $path . '/' . $filename ;
2013-07-05 17:38:09 +04:00
if ( $view -> file_exists ( $newpath )) {
2013-08-07 18:38:57 +04:00
if ( preg_match_all ( '/\((\d+)\)/' , $name , $matches , PREG_OFFSET_CAPTURE )) {
2013-07-05 17:38:09 +04:00
//Replace the last "(number)" with "(number+1)"
2013-08-07 18:38:57 +04:00
$last_match = count ( $matches [ 0 ]) - 1 ;
$counter = $matches [ 1 ][ $last_match ][ 0 ] + 1 ;
2013-07-05 17:38:09 +04:00
$offset = $matches [ 0 ][ $last_match ][ 1 ];
$match_length = strlen ( $matches [ 0 ][ $last_match ][ 0 ]);
} else {
$counter = 2 ;
$offset = false ;
}
do {
2013-08-07 18:38:57 +04:00
if ( $offset ) {
2013-07-05 17:38:09 +04:00
//Replace the last "(number)" with "(number+1)"
2013-08-07 18:38:57 +04:00
$newname = substr_replace ( $name , '(' . $counter . ')' , $offset , $match_length );
2013-07-05 17:38:09 +04:00
} else {
$newname = $name . ' (' . $counter . ')' ;
}
$newpath = $path . '/' . $newname . $ext ;
$counter ++ ;
} while ( $view -> file_exists ( $newpath ));
2012-06-14 14:57:30 +04:00
}
return $newpath ;
}
2012-07-02 22:24:26 +04:00
2013-01-13 17:54:18 +04:00
/**
2013-01-13 17:50:31 +04:00
* @ brief Checks if $sub is a subdirectory of $parent
2012-07-02 22:24:26 +04:00
*
2012-09-23 04:39:11 +04:00
* @ param string $sub
* @ param string $parent
2012-04-18 10:20:51 +04:00
* @ return bool
*/
2012-09-07 17:22:01 +04:00
public static function issubdirectory ( $sub , $parent ) {
2013-01-14 19:51:31 +04:00
if ( strpos ( realpath ( $sub ), realpath ( $parent )) === 0 ) {
2013-01-13 17:33:19 +04:00
return true ;
2012-04-26 19:55:00 +04:00
}
return false ;
2012-04-18 10:20:51 +04:00
}
2012-07-02 22:24:26 +04:00
/**
2013-08-07 18:38:57 +04:00
* @ brief Returns an array with all keys from input lowercased or uppercased . Numbered indices are left as is .
*
* @ param array $input The array to work on
* @ param int $case Either MB_CASE_UPPER or MB_CASE_LOWER ( default )
* @ param string $encoding The encoding parameter is the character encoding . Defaults to UTF - 8
* @ return array
*
* Returns an array with all keys from input lowercased or uppercased . Numbered indices are left as is .
* based on http :// www . php . net / manual / en / function . array - change - key - case . php #107715
*
*/
2012-09-07 17:22:01 +04:00
public static function mb_array_change_key_case ( $input , $case = MB_CASE_LOWER , $encoding = 'UTF-8' ) {
2012-07-02 22:24:26 +04:00
$case = ( $case != MB_CASE_UPPER ) ? MB_CASE_LOWER : MB_CASE_UPPER ;
$ret = array ();
foreach ( $input as $k => $v ) {
$ret [ mb_convert_case ( $k , $case , $encoding )] = $v ;
}
return $ret ;
}
/**
2013-01-05 02:00:51 +04:00
* @ brief replaces a copy of string delimited by the start and ( optionally ) length parameters with the string given in replacement .
*
* @ param $string
* @ param string $replacement The replacement string .
* @ param int $start If start is positive , the replacing will begin at the start 'th offset into string. If start is negative, the replacing will begin at the start' th character from the end of string .
* @ param int $length Length of the part to be replaced
* @ param string $encoding The encoding parameter is the character encoding . Defaults to UTF - 8
* @ internal param string $input The input string . . Opposite to the PHP build - in function does not accept an array .
* @ return string
*/
2012-07-02 22:24:26 +04:00
public static function mb_substr_replace ( $string , $replacement , $start , $length = null , $encoding = 'UTF-8' ) {
$start = intval ( $start );
$length = intval ( $length );
$string = mb_substr ( $string , 0 , $start , $encoding ) .
2013-01-18 23:09:03 +04:00
$replacement .
2013-08-07 18:38:57 +04:00
mb_substr ( $string , $start + $length , mb_strlen ( $string , 'UTF-8' ) - $start , $encoding );
2012-07-02 22:24:26 +04:00
return $string ;
}
/**
2013-08-07 18:38:57 +04:00
* @ brief Replace all occurrences of the search string with the replacement string
*
* @ param string $search The value being searched for , otherwise known as the needle .
* @ param string $replace The replacement
* @ param string $subject The string or array being searched and replaced on , otherwise known as the haystack .
* @ param string $encoding The encoding parameter is the character encoding . Defaults to UTF - 8
* @ param int $count If passed , this will be set to the number of replacements performed .
* @ return string
*
*/
2012-07-02 22:24:26 +04:00
public static function mb_str_replace ( $search , $replace , $subject , $encoding = 'UTF-8' , & $count = null ) {
$offset = - 1 ;
2012-07-20 19:51:50 +04:00
$length = mb_strlen ( $search , $encoding );
2013-08-07 18:38:57 +04:00
while (( $i = mb_strrpos ( $subject , $search , $offset , $encoding )) !== false ) {
2012-07-02 22:24:26 +04:00
$subject = OC_Helper :: mb_substr_replace ( $subject , $replace , $i , $length );
2012-10-11 14:42:57 +04:00
$offset = $i - mb_strlen ( $subject , $encoding );
2012-07-02 22:24:26 +04:00
$count ++ ;
}
return $subject ;
}
2012-07-24 12:54:56 +04:00
/**
2013-08-07 18:38:57 +04:00
* @ brief performs a search in a nested array
* @ param array $haystack the array to be searched
* @ param string $needle the search string
* @ param string $index optional , only search this key name
* @ return mixed the key of the matching field , otherwise false
*
* performs a search in a nested array
*
* taken from http :// www . php . net / manual / en / function . array - search . php #97645
*/
2012-07-24 12:54:56 +04:00
public static function recursiveArraySearch ( $haystack , $needle , $index = null ) {
$aIt = new RecursiveArrayIterator ( $haystack );
$it = new RecursiveIteratorIterator ( $aIt );
2013-08-07 18:38:57 +04:00
while ( $it -> valid ()) {
2012-07-24 12:54:56 +04:00
if ((( isset ( $index ) AND ( $it -> key () == $index )) OR ( ! isset ( $index ))) AND ( $it -> current () == $needle )) {
return $aIt -> key ();
}
$it -> next ();
}
return false ;
}
2012-11-12 16:56:29 +04:00
2012-11-12 17:04:23 +04:00
/**
* 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'
2013-08-07 18:38:57 +04:00
*
2012-11-12 17:04:23 +04:00
* @ param string $str the string
* @ param string $maxlen the maximum length of the result
* @ return string with at most maxlen characters
*/
2012-11-12 16:56:29 +04:00
public static function ellipsis ( $str , $maxlen ) {
if ( strlen ( $str ) > $maxlen ) {
$characters = floor ( $maxlen / 2 );
return substr ( $str , 0 , $characters ) . '...' . substr ( $str , - 1 * $characters );
}
return $str ;
}
2013-01-05 02:00:51 +04:00
2013-01-18 23:09:03 +04:00
/**
* @ brief calculates the maximum upload size respecting system settings , free space and user quota
*
* @ param $dir the current folder where the user currently operates
* @ return number of bytes representing
*/
public static function maxUploadFilesize ( $dir ) {
$upload_max_filesize = OCP\Util :: computerFileSize ( ini_get ( 'upload_max_filesize' ));
$post_max_size = OCP\Util :: computerFileSize ( ini_get ( 'post_max_size' ));
2013-03-15 19:40:36 +04:00
$freeSpace = \OC\Files\Filesystem :: free_space ( $dir );
2013-06-13 11:18:50 +04:00
if (( int ) $upload_max_filesize === 0 and ( int ) $post_max_size === 0 ) {
2013-07-25 18:00:48 +04:00
$maxUploadFilesize = \OC\Files\SPACE_UNLIMITED ;
2013-06-13 11:18:50 +04:00
} elseif (( int ) $upload_max_filesize === 0 or ( int ) $post_max_size === 0 ) {
2013-03-15 19:31:35 +04:00
$maxUploadFilesize = max ( $upload_max_filesize , $post_max_size ); //only the non 0 value counts
} else {
$maxUploadFilesize = min ( $upload_max_filesize , $post_max_size );
}
2012-12-20 20:16:01 +04:00
2013-08-18 13:34:56 +04:00
if ( $freeSpace !== \OC\Files\SPACE_UNKNOWN ) {
2013-02-16 06:27:50 +04:00
$freeSpace = max ( $freeSpace , 0 );
2012-12-20 20:16:01 +04:00
2013-02-16 06:27:50 +04:00
return min ( $maxUploadFilesize , $freeSpace );
} else {
return $maxUploadFilesize ;
}
2013-01-18 23:09:03 +04:00
}
2013-01-07 01:40:35 +04:00
2013-01-05 02:00:51 +04:00
/**
* Checks if a function is available
2013-08-07 18:38:57 +04:00
*
2013-01-05 02:00:51 +04:00
* @ param string $function_name
* @ return bool
*/
public static function is_function_enabled ( $function_name ) {
if ( ! function_exists ( $function_name )) {
return false ;
}
$disabled = explode ( ', ' , ini_get ( 'disable_functions' ));
if ( in_array ( $function_name , $disabled )) {
return false ;
}
$disabled = explode ( ', ' , ini_get ( 'suhosin.executor.func.blacklist' ));
if ( in_array ( $function_name , $disabled )) {
return false ;
}
return true ;
}
2013-01-06 15:18:21 +04:00
2013-01-02 17:35:45 +04:00
/**
* Calculate the disc space
*/
public static function getStorageInfo () {
2013-01-27 00:16:53 +04:00
$rootInfo = \OC\Files\Filesystem :: getFileInfo ( '/' );
2013-01-02 17:35:45 +04:00
$used = $rootInfo [ 'size' ];
if ( $used < 0 ) {
$used = 0 ;
}
2013-01-27 00:16:53 +04:00
$free = \OC\Files\Filesystem :: free_space ();
2013-08-07 18:38:57 +04:00
if ( $free >= 0 ) {
2013-03-15 19:46:20 +04:00
$total = $free + $used ;
} else {
$total = $free ; //either unknown or unlimited
}
2013-01-02 17:35:45 +04:00
if ( $total == 0 ) {
$total = 1 ; // prevent division by zero
}
2013-08-07 18:38:57 +04:00
if ( $total >= 0 ) {
2013-03-15 19:46:20 +04:00
$relative = round (( $used / $total ) * 10000 ) / 100 ;
} else {
$relative = 0 ;
}
2013-01-02 17:35:45 +04:00
return array ( 'free' => $free , 'used' => $used , 'total' => $total , 'relative' => $relative );
}
2011-03-03 00:18:22 +03:00
}