2012-04-23 13:50:30 +00:00
< ? php
/**
2015-02-26 10:37:37 +00:00
* ownCloud
2013-11-03 12:51:39 +00:00
*
2015-02-26 10:37:37 +00:00
* @ author Frank Karlitschek
* @ copyright 2012 Frank Karlitschek frank @ owncloud . org
2013-11-03 12:51:39 +00:00
*
2015-02-26 10:37:37 +00: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 .
2013-11-03 12:51:39 +00:00
*
2015-02-26 10:37:37 +00:00
* This library is distributed in the hope that it will be useful ,
2013-11-03 12:51:39 +00:00
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
2015-02-26 10:37:37 +00:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details .
2013-11-03 12:51:39 +00:00
*
2015-02-26 10:37:37 +00:00
* 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 />.
2013-11-03 12:51:39 +00:00
*
*/
2015-02-26 10:37:37 +00:00
/**
* Public interface of ownCloud for apps to use .
* Utility Class .
*
*/
2012-07-02 18:24:26 +00:00
// use OCP namespace for all classes that are considered public.
2012-04-23 13:50:30 +00:00
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP ;
2014-09-22 13:03:28 +00:00
use DateTimeZone ;
2012-04-23 13:50:30 +00:00
2012-05-19 08:36:57 +00:00
/**
* This class provides different helper functions to make the life of a developer easier
*/
2012-04-23 13:50:30 +00:00
class Util {
2012-05-01 15:38:27 +00:00
// consts for Logging
const DEBUG = 0 ;
const INFO = 1 ;
const WARN = 2 ;
const ERROR = 3 ;
const FATAL = 4 ;
2012-05-01 19:07:08 +00:00
/**
2013-10-31 18:00:53 +00:00
* get the current installed version of ownCloud
2012-05-01 19:07:08 +00:00
* @ return array
*/
2012-09-07 13:22:01 +00:00
public static function getVersion () {
2012-05-01 19:07:08 +00:00
return ( \OC_Util :: getVersion ());
}
2012-04-23 13:50:30 +00:00
/**
2013-10-31 18:00:53 +00:00
* send an email
2012-04-23 13:50:30 +00:00
* @ param string $toaddress
* @ param string $toname
* @ param string $subject
* @ param string $mailtext
* @ param string $fromaddress
* @ param string $fromname
2014-04-21 13:44:54 +00:00
* @ param int $html
2013-10-31 18:00:53 +00:00
* @ param string $altbody
* @ param string $ccaddress
* @ param string $ccname
* @ param string $bcc
2015-02-12 12:53:27 +00:00
* @ deprecated Use \OCP\Mail\IMailer instead
2012-04-23 13:50:30 +00:00
*/
2015-03-16 13:10:03 +00:00
public static function sendMail ( $toaddress , $toname , $subject , $mailtext , $fromaddress , $fromname ,
2013-02-11 16:44:02 +00:00
$html = 0 , $altbody = '' , $ccaddress = '' , $ccname = '' , $bcc = '' ) {
2015-02-12 12:53:27 +00:00
$mailer = \OC :: $server -> getMailer ();
$message = $mailer -> createMessage ();
2015-03-16 13:10:03 +00:00
$message -> setTo ([ $toaddress => $toname ]);
2015-02-12 12:53:27 +00:00
$message -> setSubject ( $subject );
$message -> setPlainBody ( $mailtext );
2015-03-16 13:10:03 +00:00
$message -> setFrom ([ $fromaddress => $fromname ]);
2015-02-12 12:53:27 +00:00
if ( $html === 1 ) {
$message -> setHTMLBody ( $altbody );
}
2015-03-16 13:10:03 +00:00
if ( $altbody === '' ) {
$message -> setHTMLBody ( $mailtext );
$message -> setPlainBody ( '' );
} else {
$message -> setHtmlBody ( $mailtext );
$message -> setPlainBody ( $altbody );
}
2015-02-12 12:53:27 +00:00
if ( ! empty ( $ccaddress )) {
if ( ! empty ( $ccname )) {
2015-03-16 13:10:03 +00:00
$message -> setCc ([ $ccaddress => $ccname ]);
2015-02-12 12:53:27 +00:00
} else {
2015-03-16 13:10:03 +00:00
$message -> setCc ([ $ccaddress ]);
2015-02-12 12:53:27 +00:00
}
}
if ( ! empty ( $bcc )) {
2015-03-16 13:10:03 +00:00
$message -> setBcc ([ $bcc ]);
2015-02-12 12:53:27 +00:00
}
$mailer -> send ( $message );
2012-04-23 13:50:30 +00:00
}
2012-09-08 14:18:47 +00:00
/**
2013-10-31 18:00:53 +00:00
* write a message in the log
2012-05-01 07:39:12 +00:00
* @ param string $app
* @ param string $message
2012-12-25 17:17:32 +00:00
* @ param int $level
2012-09-08 14:18:47 +00:00
*/
public static function writeLog ( $app , $message , $level ) {
// call the internal log class
\OC_LOG :: write ( $app , $message , $level );
}
2012-05-01 07:39:12 +00:00
2013-10-23 08:47:26 +00:00
/**
2014-09-11 12:14:02 +00:00
* write exception into the log
2013-10-31 18:00:53 +00:00
* @ param string $app app name
2014-04-21 13:44:54 +00:00
* @ param \Exception $ex exception to log
2014-09-11 12:14:02 +00:00
* @ param int $level log level , defaults to \OCP\Util :: FATAL
2013-10-23 08:47:26 +00:00
*/
2014-05-05 09:31:25 +00:00
public static function logException ( $app , \Exception $ex , $level = \OCP\Util :: FATAL ) {
2014-09-11 12:14:02 +00:00
$exception = array (
'Message' => $ex -> getMessage (),
'Code' => $ex -> getCode (),
'Trace' => $ex -> getTraceAsString (),
'File' => $ex -> getFile (),
'Line' => $ex -> getLine (),
);
\OCP\Util :: writeLog ( $app , 'Exception: ' . json_encode ( $exception ), $level );
2013-10-23 08:47:26 +00:00
}
2014-05-13 13:22:18 +00:00
/**
* check if sharing is disabled for the current user
*
* @ return boolean
*/
public static function isSharingDisabledForUser () {
return \OC_Util :: isSharingDisabledForUser ();
}
2013-07-19 09:40:11 +00:00
/**
2013-10-31 18:00:53 +00:00
* get l10n object
* @ param string $application
2014-07-21 12:50:34 +00:00
* @ param string | null $language
2014-01-13 13:28:49 +00:00
* @ return \OC_L10N
2013-07-19 09:40:11 +00:00
*/
2014-07-21 12:50:34 +00:00
public static function getL10N ( $application , $language = null ) {
2014-08-31 08:05:59 +00:00
return \OC :: $server -> getL10N ( $application , $language );
2012-09-08 14:18:47 +00:00
}
2012-05-01 07:39:12 +00:00
/**
2013-10-31 18:00:53 +00:00
* add a css file
* @ param string $application
* @ param string $file
2012-05-01 07:39:12 +00:00
*/
2012-09-07 13:22:01 +00:00
public static function addStyle ( $application , $file = null ) {
2012-05-06 20:02:16 +00:00
\OC_Util :: addStyle ( $application , $file );
2012-09-08 14:18:47 +00:00
}
2012-05-06 20:02:16 +00:00
2012-05-01 19:07:08 +00:00
/**
2013-10-31 18:00:53 +00:00
* add a javascript file
2012-12-25 17:17:32 +00:00
* @ param string $application
2013-10-31 18:00:53 +00:00
* @ param string $file
2012-05-01 19:07:08 +00:00
*/
2012-09-07 13:22:01 +00:00
public static function addScript ( $application , $file = null ) {
2012-05-06 20:02:16 +00:00
\OC_Util :: addScript ( $application , $file );
2012-09-08 14:18:47 +00:00
}
2012-04-23 13:50:30 +00:00
2014-10-17 17:47:37 +00:00
/**
* Add a translation JS file
* @ param string $application application id
* @ param string $languageCode language code , defaults to the current locale
*/
public static function addTranslations ( $application , $languageCode = null ) {
\OC_Util :: addTranslations ( $application , $languageCode );
}
2012-05-01 19:07:08 +00:00
/**
2013-10-31 18:00:53 +00:00
* Add a custom element to the header
2014-10-28 10:15:58 +00:00
* If $text is null then the element will be written as empty element .
* So use " " to get a closing tag .
2012-12-25 17:17:32 +00:00
* @ param string $tag tag name of the element
2012-05-01 19:07:08 +00:00
* @ param array $attributes array of attributes for the element
* @ param string $text the text content for the element
*/
2014-10-28 10:15:58 +00:00
public static function addHeader ( $tag , $attributes , $text = null ) {
\OC_Util :: addHeader ( $tag , $attributes , $text );
2012-05-01 19:07:08 +00:00
}
2012-04-23 13:50:30 +00:00
2012-05-01 19:07:08 +00:00
/**
2013-10-31 18:00:53 +00:00
* formats a timestamp in the " right " way
2012-12-25 17:17:32 +00:00
* @ param int $timestamp $timestamp
* @ param bool $dateOnly option to omit time from the result
2014-09-22 13:03:28 +00:00
* @ param DateTimeZone | string $timeZone where the given timestamp shall be converted to
2014-04-21 13:44:54 +00:00
* @ return string timestamp
2014-11-24 15:37:04 +00:00
*
* @ deprecated Use \OC :: $server -> query ( 'DateTimeFormatter' ) instead
2012-05-01 19:07:08 +00:00
*/
2014-09-22 13:03:28 +00:00
public static function formatDate ( $timestamp , $dateOnly = false , $timeZone = null ) {
return ( \OC_Util :: formatDate ( $timestamp , $dateOnly , $timeZone ));
2012-05-01 19:07:08 +00:00
}
2012-04-23 13:50:30 +00:00
2013-08-12 15:25:27 +00:00
/**
2013-10-31 18:00:53 +00:00
* check if some encrypted files are stored
2013-08-12 15:25:27 +00:00
* @ return bool
*/
public static function encryptedFiles () {
return \OC_Util :: encryptedFiles ();
}
2013-10-31 18:00:53 +00:00
2012-05-01 21:19:39 +00:00
/**
2013-10-31 18:00:53 +00:00
* Creates an absolute url to the given app and file .
2012-12-25 17:17:32 +00:00
* @ param string $app app
* @ param string $file file
* @ param array $args array with param => value , will be appended to the returned url
2012-09-28 20:27:52 +00:00
* The value of $args will be urlencoded
2013-10-31 18:00:53 +00:00
* @ return string the url
2012-05-01 21:19:39 +00:00
*/
2012-09-03 16:13:45 +00:00
public static function linkToAbsolute ( $app , $file , $args = array () ) {
return ( \OC_Helper :: linkToAbsolute ( $app , $file , $args ));
2012-05-01 21:19:39 +00:00
}
2012-05-01 20:59:38 +00:00
2012-05-07 18:22:55 +00:00
/**
2013-10-31 18:00:53 +00:00
* Creates an absolute url for remote use .
2012-12-25 17:17:32 +00:00
* @ param string $service id
2013-10-31 18:00:53 +00:00
* @ return string the url
2012-05-07 18:22:55 +00:00
*/
public static function linkToRemote ( $service ) {
return ( \OC_Helper :: linkToRemote ( $service ));
}
2012-08-27 19:46:05 +00:00
/**
2013-10-31 18:00:53 +00:00
* Creates an absolute url for public use
2012-12-25 17:17:32 +00:00
* @ param string $service id
2013-10-31 18:00:53 +00:00
* @ return string the url
2012-08-27 19:46:05 +00:00
*/
public static function linkToPublic ( $service ) {
return \OC_Helper :: linkToPublic ( $service );
}
2012-06-14 10:57:30 +00:00
/**
2013-10-31 18:00:53 +00:00
* Creates an url using a defined route
2014-05-11 20:51:30 +00:00
* @ param string $route
2013-02-08 21:05:13 +00:00
* @ param array $parameters
* @ internal param array $args with param => value , will be appended to the returned url
2014-04-21 13:44:54 +00:00
* @ return string the url
2013-02-08 21:05:13 +00:00
*/
public static function linkToRoute ( $route , $parameters = array () ) {
return \OC_Helper :: linkToRoute ( $route , $parameters );
}
/**
2013-10-31 18:00:53 +00:00
* Creates an url to the given app and file
2012-12-25 17:17:32 +00:00
* @ param string $app app
* @ param string $file file
* @ param array $args array with param => value , will be appended to the returned url
2012-09-28 20:27:52 +00:00
* The value of $args will be urlencoded
2013-10-31 18:00:53 +00:00
* @ return string the url
2012-06-14 10:57:30 +00:00
*/
2012-09-07 13:22:01 +00:00
public static function linkTo ( $app , $file , $args = array () ) {
2012-09-03 16:13:45 +00:00
return ( \OC_Helper :: linkTo ( $app , $file , $args ));
2012-05-01 21:19:39 +00:00
}
2012-05-01 20:59:38 +00:00
2012-05-01 21:19:39 +00:00
/**
2013-10-31 18:00:53 +00:00
* Returns the server host , even if the website uses one or more reverse proxy
* @ return string the server host
2015-02-10 12:02:48 +00:00
* @ deprecated Use \OCP\IRequest :: getServerHost
2012-05-01 21:19:39 +00:00
*/
public static function getServerHost () {
2015-02-10 12:02:48 +00:00
return \OC :: $server -> getRequest () -> getServerHost ();
2012-05-01 21:19:39 +00:00
}
2012-05-01 20:59:38 +00:00
2012-12-19 00:09:14 +00:00
/**
* Returns the server host name without an eventual port number
2013-10-31 18:00:53 +00:00
* @ return string the server hostname
2012-12-19 00:09:14 +00:00
*/
public static function getServerHostName () {
$host_name = self :: getServerHost ();
// strip away port number (if existing)
$colon_pos = strpos ( $host_name , ':' );
if ( $colon_pos != FALSE ) {
$host_name = substr ( $host_name , 0 , $colon_pos );
}
return $host_name ;
}
/**
2013-10-31 18:00:53 +00:00
* Returns the default email address
2012-12-25 17:17:32 +00:00
* @ param string $user_part the user part of the address
2013-10-31 18:00:53 +00:00
* @ return string the default email address
2012-12-19 00:09:14 +00:00
*
* Assembles a default email address ( using the server hostname
* and the given user part , and returns it
* Example : when given lostpassword - noreply as $user_part param ,
* and is currently accessed via http ( s ) :// example . com / ,
* it would return 'lostpassword-noreply@example.com'
2014-01-24 13:22:42 +00:00
*
* If the configuration value 'mail_from_address' is set in
* config . php , this value will override the $user_part that
* is passed to this function
2012-12-19 00:09:14 +00:00
*/
public static function getDefaultEmailAddress ( $user_part ) {
2014-01-24 13:04:37 +00:00
$user_part = \OC_Config :: getValue ( 'mail_from_address' , $user_part );
2012-12-19 00:09:14 +00:00
$host_name = self :: getServerHostName ();
2013-03-22 09:07:06 +00:00
$host_name = \OC_Config :: getValue ( 'mail_domain' , $host_name );
2013-03-01 21:24:19 +00:00
$defaultEmailAddress = $user_part . '@' . $host_name ;
2015-02-19 17:55:27 +00:00
$mailer = \OC :: $server -> getMailer ();
if ( $mailer -> validateMailAddress ( $defaultEmailAddress )) {
2013-03-01 21:24:19 +00:00
return $defaultEmailAddress ;
2012-12-19 00:09:14 +00:00
}
2013-03-01 21:24:19 +00:00
2013-03-04 20:10:18 +00:00
// in case we cannot build a valid email address from the hostname let's fallback to 'localhost.localdomain'
2013-03-01 21:24:19 +00:00
return $user_part . '@localhost.localdomain' ;
2012-12-19 00:09:14 +00:00
}
2012-06-01 08:38:44 +00:00
/**
* Returns the server protocol . It respects reverse proxy servers and load balancers
2013-10-31 18:00:53 +00:00
* @ return string the server protocol
2015-02-10 12:02:48 +00:00
* @ deprecated Use \OCP\IRequest :: getServerProtocol
2012-06-01 08:38:44 +00:00
*/
public static function getServerProtocol () {
2015-02-10 12:02:48 +00:00
return \OC :: $server -> getRequest () -> getServerProtocol ();
2012-06-01 08:38:44 +00:00
}
2012-09-09 10:54:47 +00:00
/**
2013-10-31 18:00:53 +00:00
* Returns the request uri , even if the website uses one or more reverse proxies
2014-04-21 13:44:54 +00:00
* @ return string the request uri
2015-02-10 12:02:48 +00:00
* @ deprecated Use \OCP\IRequest :: getRequestUri
2012-09-09 10:54:47 +00:00
*/
public static function getRequestUri () {
2015-02-10 12:02:48 +00:00
return \OC :: $server -> getRequest () -> getRequestUri ();
2012-09-09 10:54:47 +00:00
}
/**
2013-10-31 18:00:53 +00:00
* Returns the script name , even if the website uses one or more reverse proxies
2014-05-11 17:05:28 +00:00
* @ return string the script name
2015-02-10 12:02:48 +00:00
* @ deprecated Use \OCP\IRequest :: getScriptName
2012-09-09 10:54:47 +00:00
*/
public static function getScriptName () {
2015-02-10 12:02:48 +00:00
return \OC :: $server -> getRequest () -> getScriptName ();
2012-09-09 10:54:47 +00:00
}
2012-05-01 22:20:45 +00:00
/**
2013-10-31 18:00:53 +00:00
* Creates path to an image
2012-12-25 17:17:32 +00:00
* @ param string $app app
* @ param string $image image name
2013-10-31 18:00:53 +00:00
* @ return string the url
2012-05-01 22:20:45 +00:00
*/
2012-09-08 14:18:47 +00:00
public static function imagePath ( $app , $image ) {
2012-05-01 22:20:45 +00:00
return ( \OC_Helper :: imagePath ( $app , $image ));
}
/**
2013-10-31 18:00:53 +00:00
* Make a human file size ( 2048 to 2 kB )
2012-12-25 17:17:32 +00:00
* @ param int $bytes file size in bytes
2013-10-31 18:00:53 +00:00
* @ return string a human readable file size
2012-05-01 22:20:45 +00:00
*/
2012-09-07 13:22:01 +00:00
public static function humanFileSize ( $bytes ) {
2012-05-01 22:20:45 +00:00
return ( \OC_Helper :: humanFileSize ( $bytes ));
}
/**
2013-10-31 18:00:53 +00:00
* Make a computer file size ( 2 kB to 2048 )
2012-12-25 17:17:32 +00:00
* @ param string $str file size in a fancy format
2013-10-31 18:00:53 +00:00
* @ return int a file size in bytes
2012-05-01 22:20:45 +00:00
*
* Inspired by : http :// www . php . net / manual / en / function . filesize . php #92418
*/
2012-09-07 13:22:01 +00:00
public static function computerFileSize ( $str ) {
2012-05-01 22:20:45 +00:00
return ( \OC_Helper :: computerFileSize ( $str ));
}
2012-05-05 08:18:45 +00:00
/**
2013-10-31 18:00:53 +00:00
* connects a function to a hook
2012-12-25 17:17:32 +00:00
* @ param string $signalclass class name of emitter
* @ param string $signalname name of signal
* @ param string $slotclass class name of slot
* @ param string $slotname name of slot
2013-10-31 18:00:53 +00:00
* @ return bool
2012-05-05 08:18:45 +00:00
*
* This function makes it very easy to connect to use hooks .
*
* TODO : write example
*/
2012-09-07 13:22:01 +00:00
static public function connectHook ( $signalclass , $signalname , $slotclass , $slotname ) {
2012-05-05 08:18:45 +00:00
return ( \OC_Hook :: connect ( $signalclass , $signalname , $slotclass , $slotname ));
}
2012-05-01 22:20:45 +00:00
2012-05-05 08:18:45 +00:00
/**
2013-10-31 18:00:53 +00:00
* Emits a signal . To get data from the slot use references !
2012-12-25 17:17:32 +00:00
* @ param string $signalclass class name of emitter
* @ param string $signalname name of signal
2014-04-21 13:44:54 +00:00
* @ param array $params default : array () array with additional data
2013-10-31 18:00:53 +00:00
* @ return bool true if slots exists or false if not
2012-05-05 08:18:45 +00:00
*
* TODO : write example
*/
2012-09-07 13:22:01 +00:00
static public function emitHook ( $signalclass , $signalname , $params = array ()) {
2012-05-05 08:18:45 +00:00
return ( \OC_Hook :: emit ( $signalclass , $signalname , $params ));
}
2012-05-01 20:59:38 +00:00
2012-06-09 13:05:14 +00:00
/**
2012-08-29 18:34:44 +00:00
* Register an get / post call . This is important to prevent CSRF attacks
2012-06-09 13:05:14 +00:00
* TODO : write example
*/
2012-09-07 13:22:01 +00:00
public static function callRegister () {
2012-06-09 13:05:14 +00:00
return ( \OC_Util :: callRegister ());
}
/**
* Check an ajax get / post call if the request token is valid . exit if not .
* Todo : Write howto
*/
2012-09-07 13:22:01 +00:00
public static function callCheck () {
2013-01-06 22:59:02 +00:00
\OC_Util :: callCheck ();
2012-06-09 13:05:14 +00:00
}
2012-07-02 18:24:26 +00:00
/**
2013-10-31 18:00:53 +00:00
* Used to sanitize HTML
2012-07-02 18:24:26 +00:00
*
2013-02-11 16:44:02 +00:00
* This function is used to sanitize HTML and should be applied on any
* string or array of strings before displaying it on a web page .
2012-07-02 18:24:26 +00:00
*
2014-05-11 20:51:30 +00:00
* @ param string | array $value
* @ return string | array an array of sanitized strings or a single sinitized string , depends on the input parameter .
2012-07-02 18:24:26 +00:00
*/
2012-09-07 13:22:01 +00:00
public static function sanitizeHTML ( $value ) {
2012-07-02 18:24:26 +00:00
return ( \OC_Util :: sanitizeHTML ( $value ));
}
2013-10-31 18:00:53 +00:00
2013-07-04 16:21:49 +00:00
/**
2013-10-31 18:00:53 +00:00
* Public function to encode url parameters
2013-07-04 16:21:49 +00:00
*
* This function is used to encode path to file before output .
* Encoding is done according to RFC 3986 with one exception :
2013-10-31 18:00:53 +00:00
* Character '/' is preserved as is .
2013-07-04 16:21:49 +00:00
*
* @ param string $component part of URI to encode
2013-10-31 18:00:53 +00:00
* @ return string
2013-07-04 16:21:49 +00:00
*/
public static function encodePath ( $component ) {
return ( \OC_Util :: encodePath ( $component ));
}
2012-07-02 18:24:26 +00:00
/**
2013-10-31 18:00:53 +00:00
* 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
*/
2012-09-07 13:22:01 +00:00
public static function mb_array_change_key_case ( $input , $case = MB_CASE_LOWER , $encoding = 'UTF-8' ) {
2012-07-02 18:24:26 +00:00
return ( \OC_Helper :: mb_array_change_key_case ( $input , $case , $encoding ));
}
/**
2013-10-31 18:00:53 +00:00
* replaces a copy of string delimited by the start and ( optionally ) length parameters with the string given in replacement .
*
* @ param string $string The input string . Opposite to the PHP build - in function does not accept an array .
* @ 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
* @ return string
*/
2012-07-02 18:24:26 +00:00
public static function mb_substr_replace ( $string , $replacement , $start , $length = null , $encoding = 'UTF-8' ) {
return ( \OC_Helper :: mb_substr_replace ( $string , $replacement , $start , $length , $encoding ));
}
/**
2013-10-31 18:00:53 +00:00
* Replace all occurrences of the search string with the replacement string
*
* @ param string $search The value being searched for , otherwise known as the needle . String .
* @ param string $replace The replacement string .
* @ 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 18:24:26 +00:00
public static function mb_str_replace ( $search , $replace , $subject , $encoding = 'UTF-8' , & $count = null ) {
return ( \OC_Helper :: mb_str_replace ( $search , $replace , $subject , $encoding , $count ));
2012-06-19 15:20:19 +00:00
}
2012-07-24 08:54:56 +00:00
/**
2013-10-31 18:00:53 +00:00
* performs a search in a nested array
*
* @ param array $haystack the array to be searched
* @ param string $needle the search string
* @ param int $index optional , only search this key name
* @ return mixed the key of the matching field , otherwise false
*/
2012-07-24 08:54:56 +00:00
public static function recursiveArraySearch ( $haystack , $needle , $index = null ) {
return ( \OC_Helper :: recursiveArraySearch ( $haystack , $needle , $index ));
}
2012-12-20 16:16:01 +00:00
2013-01-18 19:09:03 +00:00
/**
2013-10-31 18:00:53 +00:00
* calculates the maximum upload size respecting system settings , free space and user quota
2013-01-18 19:09:03 +00:00
*
2014-01-27 14:56:57 +00:00
* @ param string $dir the current folder where the user currently operates
* @ param int $free the number of bytes free on the storage holding $dir , if not set this will be received from the storage directly
2014-05-11 20:51:30 +00:00
* @ return int number of bytes representing
2013-01-18 19:09:03 +00:00
*/
2014-01-27 14:56:57 +00:00
public static function maxUploadFilesize ( $dir , $free = null ) {
return \OC_Helper :: maxUploadFilesize ( $dir , $free );
2013-01-18 19:09:03 +00:00
}
2013-12-08 14:59:46 +00:00
/**
* Calculate free space left within user quota
2014-04-21 13:44:54 +00:00
* @ param string $dir the current folder where the user currently operates
* @ return int number of bytes representing
2013-12-08 14:59:46 +00:00
*/
public static function freeSpace ( $dir ) {
return \OC_Helper :: freeSpace ( $dir );
}
/**
* Calculate PHP upload limit
*
2014-05-11 20:51:30 +00:00
* @ return int number of bytes representing
2013-12-08 14:59:46 +00:00
*/
public static function uploadLimit () {
return \OC_Helper :: uploadLimit ();
}
2014-01-10 15:14:37 +00:00
/**
* Returns whether the given file name is valid
2014-05-11 20:51:30 +00:00
* @ param string $file file name to check
2014-01-10 15:14:37 +00:00
* @ return bool true if the file name is valid , false otherwise
2015-02-18 17:35:27 +00:00
* @ deprecated use \OC\Files\View :: verifyPath ()
2014-01-10 15:14:37 +00:00
*/
public static function isValidFileName ( $file ) {
return \OC_Util :: isValidFileName ( $file );
}
2014-03-19 10:42:22 +00:00
/**
2014-05-19 15:50:53 +00:00
* Generates a cryptographic secure pseudo - random string
2014-05-11 20:51:30 +00:00
* @ param int $length of the random string
* @ return string
2014-08-26 17:02:40 +00:00
* @ deprecated Use \OC :: $server -> getSecureRandom () -> getMediumStrengthGenerator () -> generate ( $length ); instead
2014-03-19 10:42:22 +00:00
*/
public static function generateRandomBytes ( $length = 30 ) {
return \OC_Util :: generateRandomBytes ( $length );
}
2014-05-12 10:19:07 +00:00
2014-02-18 11:29:05 +00:00
/**
* Compare two strings to provide a natural sort
2014-11-25 15:28:41 +00:00
* @ param string $a first string to compare
* @ param string $b second string to compare
2014-02-18 11:29:05 +00:00
* @ return - 1 if $b comes before $a , 1 if $a comes before $b
* or 0 if the strings are identical
*/
public static function naturalSortCompare ( $a , $b ) {
return \OC\NaturalSort :: getInstance () -> compare ( $a , $b );
}
2014-05-12 10:19:07 +00:00
/**
2014-05-19 15:50:53 +00:00
* check if a password is required for each public link
2014-05-12 10:19:07 +00:00
* @ return boolean
*/
public static function isPublicLinkPasswordRequired () {
return \OC_Util :: isPublicLinkPasswordRequired ();
}
2014-06-10 16:01:07 +00:00
2014-07-23 14:42:33 +00:00
/**
* check if share API enforces a default expire date
* @ return boolean
*/
public static function isDefaultExpireDateEnforced () {
return \OC_Util :: isDefaultExpireDateEnforced ();
}
2014-06-10 16:01:07 +00:00
/**
* Checks whether the current version needs upgrade .
*
* @ return bool true if upgrade is needed , false otherwise
*/
public static function needUpgrade () {
2014-09-08 12:56:11 +00:00
return \OC_Util :: needUpgrade ( \OC :: $server -> getConfig ());
2014-06-10 16:01:07 +00:00
}
2012-05-01 19:07:08 +00:00
}