2012-04-23 17:50:30 +04:00
< ? php
/**
* ownCloud
*
* @ author Frank Karlitschek
2012-05-26 21:14:24 +04:00
* @ copyright 2012 Frank Karlitschek frank @ owncloud . org
2012-04-23 17:50:30 +04: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 />.
*
*/
/**
* Public interface of ownCloud for apps to use .
* Utility Class .
*
*/
2012-07-02 22:24:26 +04:00
// use OCP namespace for all classes that are considered public.
2012-04-23 17:50:30 +04:00
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP ;
2012-05-19 12:36:57 +04:00
/**
* This class provides different helper functions to make the life of a developer easier
*/
2012-04-23 17:50:30 +04:00
class Util {
2012-05-01 19:38:27 +04:00
// consts for Logging
const DEBUG = 0 ;
const INFO = 1 ;
const WARN = 2 ;
const ERROR = 3 ;
const FATAL = 4 ;
2012-05-01 23:07:08 +04:00
/**
2012-05-07 00:02:16 +04:00
* @ brief get the current installed version of ownCloud
2012-05-01 23:07:08 +04:00
* @ return array
*/
2012-09-07 17:22:01 +04:00
public static function getVersion () {
2012-05-01 23:07:08 +04:00
return ( \OC_Util :: getVersion ());
}
2012-04-23 17:50:30 +04:00
/**
2012-07-02 22:24:26 +04:00
* @ brief send an email
2012-04-23 17:50:30 +04:00
* @ param string $toaddress
* @ param string $toname
* @ param string $subject
* @ param string $mailtext
* @ param string $fromaddress
* @ param string $fromname
* @ param bool $html
*/
2012-05-07 00:02:16 +04:00
public static function sendMail ( $toaddress , $toname , $subject , $mailtext , $fromaddress , $fromname , $html = 0 , $altbody = '' , $ccaddress = '' , $ccname = '' , $bcc = '' ) {
2012-04-23 17:50:30 +04:00
// call the internal mail class
2012-05-07 00:02:16 +04:00
\OC_MAIL :: send ( $toaddress , $toname , $subject , $mailtext , $fromaddress , $fromname , $html = 0 , $altbody = '' , $ccaddress = '' , $ccname = '' , $bcc = '' );
2012-04-23 17:50:30 +04:00
}
2012-09-08 18:18:47 +04:00
/**
2012-05-07 00:02:16 +04:00
* @ brief write a message in the log
2012-05-01 11:39:12 +04:00
* @ param string $app
* @ param string $message
* @ param int level
2012-09-08 18:18:47 +04:00
*/
public static function writeLog ( $app , $message , $level ) {
// call the internal log class
\OC_LOG :: write ( $app , $message , $level );
}
2012-05-01 11:39:12 +04:00
/**
2012-05-07 00:02:16 +04:00
* @ brief add a css file
2012-05-01 11:39:12 +04:00
* @ param url $url
*/
2012-09-07 17:22:01 +04:00
public static function addStyle ( $application , $file = null ) {
2012-05-07 00:02:16 +04:00
\OC_Util :: addStyle ( $application , $file );
2012-09-08 18:18:47 +04:00
}
2012-05-07 00:02:16 +04:00
2012-05-01 23:07:08 +04:00
/**
2012-05-07 00:02:16 +04:00
* @ brief add a javascript file
2012-05-01 23:07:08 +04:00
* @ param appid $application
* @ param filename $file
*/
2012-09-07 17:22:01 +04:00
public static function addScript ( $application , $file = null ) {
2012-05-07 00:02:16 +04:00
\OC_Util :: addScript ( $application , $file );
2012-09-08 18:18:47 +04:00
}
2012-04-23 17:50:30 +04:00
2012-05-01 23:07:08 +04:00
/**
* @ brief Add a custom element to the header
* @ param string tag tag name of the element
* @ param array $attributes array of attributes for the element
* @ param string $text the text content for the element
*/
2012-09-07 17:22:01 +04:00
public static function addHeader ( $tag , $attributes , $text = '' ) {
2012-05-09 17:17:40 +04:00
\OC_Util :: addHeader ( $tag , $attributes , $text );
2012-05-01 23:07:08 +04:00
}
2012-04-23 17:50:30 +04:00
2012-05-01 23:07:08 +04:00
/**
2012-05-07 00:02:16 +04:00
* @ brief formats a timestamp in the " right " way
2012-05-01 23:07:08 +04:00
* @ param int timestamp $timestamp
* @ param bool dateOnly option to ommit time from the result
*/
2012-11-02 22:53:02 +04:00
public static function formatDate ( $timestamp , $dateOnly = false ) {
return ( \OC_Util :: formatDate ( $timestamp , $dateOnly ));
2012-05-01 23:07:08 +04:00
}
2012-04-23 17:50:30 +04:00
2012-05-02 01:19:39 +04:00
/**
* @ brief Creates an absolute url
* @ param $app app
* @ param $file file
2012-09-03 20:13:45 +04:00
* @ param $args array with param => value , will be appended to the returned url
2012-09-29 00:27:52 +04:00
* The value of $args will be urlencoded
2012-05-02 01:19:39 +04:00
* @ returns the url
*
* Returns a absolute url to the given app and file .
*/
2012-09-03 20:13:45 +04:00
public static function linkToAbsolute ( $app , $file , $args = array () ) {
return ( \OC_Helper :: linkToAbsolute ( $app , $file , $args ));
2012-05-02 01:19:39 +04:00
}
2012-05-02 00:59:38 +04:00
2012-05-07 22:22:55 +04:00
/**
* @ brief Creates an absolute url for remote use
* @ param $service id
* @ returns the url
*
* Returns a absolute url to the given app and file .
*/
public static function linkToRemote ( $service ) {
return ( \OC_Helper :: linkToRemote ( $service ));
}
2012-08-27 23:46:05 +04:00
/**
* @ brief Creates an absolute url for public use
* @ param $service id
* @ returns the url
*
* Returns a absolute url to the given app and file .
*/
public static function linkToPublic ( $service ) {
return \OC_Helper :: linkToPublic ( $service );
}
2012-06-14 14:57:30 +04:00
/**
* @ brief Creates an url
* @ param $app app
* @ param $file file
2012-09-03 20:13:45 +04:00
* @ param $args array with param => value , will be appended to the returned url
2012-09-29 00:27:52 +04:00
* The value of $args will be urlencoded
2012-06-14 14:57:30 +04:00
* @ returns the url
*
* Returns a url to the given app and file .
*/
2012-09-07 17:22:01 +04:00
public static function linkTo ( $app , $file , $args = array () ) {
2012-09-03 20:13:45 +04:00
return ( \OC_Helper :: linkTo ( $app , $file , $args ));
2012-05-02 01:19:39 +04:00
}
2012-05-02 00:59:38 +04:00
2012-05-02 01:19:39 +04:00
/**
* @ brief Returns the server host
* @ returns the server host
*
* Returns the server host , even if the website uses one or more
* reverse proxies
*/
public static function getServerHost () {
2012-08-07 00:16:45 +04:00
return ( \OC_Request :: serverHost ());
2012-05-02 01:19:39 +04:00
}
2012-05-02 00:59:38 +04:00
2012-06-01 12:38:44 +04:00
/**
* @ brief Returns the server protocol
* @ returns the server protocol
*
* Returns the server protocol . It respects reverse proxy servers and load balancers
*/
public static function getServerProtocol () {
2012-08-07 00:16:45 +04:00
return ( \OC_Request :: serverProtocol ());
2012-06-01 12:38:44 +04:00
}
2012-05-02 02:20:45 +04:00
/**
* @ brief Creates path to an image
* @ param $app app
* @ param $image image name
* @ returns the url
*
* Returns the path to the image .
*/
2012-09-08 18:18:47 +04:00
public static function imagePath ( $app , $image ) {
2012-05-02 02:20:45 +04:00
return ( \OC_Helper :: imagePath ( $app , $image ));
}
/**
* @ brief Make a human file size
* @ param $bytes file size in bytes
* @ returns a human readable file size
*
* Makes 2048 to 2 kB .
*/
2012-09-07 17:22:01 +04:00
public static function humanFileSize ( $bytes ) {
2012-05-02 02:20:45 +04:00
return ( \OC_Helper :: humanFileSize ( $bytes ));
}
/**
* @ brief Make a computer file size
* @ param $str file size in a fancy format
* @ returns a file size in bytes
*
* Makes 2 kB to 2048.
*
* Inspired by : http :// www . php . net / manual / en / function . filesize . php #92418
*/
2012-09-07 17:22:01 +04:00
public static function computerFileSize ( $str ) {
2012-05-02 02:20:45 +04:00
return ( \OC_Helper :: computerFileSize ( $str ));
}
2012-05-05 12:18:45 +04:00
/**
* @ brief connects a function to a hook
* @ param $signalclass class name of emitter
* @ param $signalname name of signal
* @ param $slotclass class name of slot
* @ param $slotname name of slot
* @ returns true / false
*
* This function makes it very easy to connect to use hooks .
*
* TODO : write example
*/
2012-09-07 17:22:01 +04:00
static public function connectHook ( $signalclass , $signalname , $slotclass , $slotname ) {
2012-05-05 12:18:45 +04:00
return ( \OC_Hook :: connect ( $signalclass , $signalname , $slotclass , $slotname ));
}
2012-05-02 02:20:45 +04:00
2012-05-05 12:18:45 +04:00
/**
* @ brief emitts a signal
* @ param $signalclass class name of emitter
* @ param $signalname name of signal
* @ param $params defautl : array () array with additional data
* @ returns true if slots exists or false if not
*
* Emits a signal . To get data from the slot use references !
*
* TODO : write example
*/
2012-09-07 17:22:01 +04:00
static public function emitHook ( $signalclass , $signalname , $params = array ()) {
2012-05-05 12:18:45 +04:00
return ( \OC_Hook :: emit ( $signalclass , $signalname , $params ));
}
2012-05-02 00:59:38 +04:00
2012-06-09 17:05:14 +04:00
/**
2012-08-29 22:34:44 +04:00
* Register an get / post call . This is important to prevent CSRF attacks
2012-06-09 17:05:14 +04:00
* TODO : write example
*/
2012-09-07 17:22:01 +04:00
public static function callRegister () {
2012-06-09 17:05:14 +04: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 17:22:01 +04:00
public static function callCheck () {
2012-06-09 17:05:14 +04:00
return ( \OC_Util :: callCheck ());
}
2012-07-02 22:24:26 +04:00
/**
* @ brief Used to sanitize HTML
*
* 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 .
*
* @ param string or array of strings
* @ return array with sanitized strings or a single sinitized string , depends on the input parameter .
*/
2012-09-07 17:22:01 +04:00
public static function sanitizeHTML ( $value ) {
2012-07-02 22:24:26 +04:00
return ( \OC_Util :: sanitizeHTML ( $value ));
}
/**
* @ brief Returns an array with all keys from input lowercased or uppercased . Numbered indices are left as is .
*
* @ param $input The array to work on
* @ param $case Either MB_CASE_UPPER or MB_CASE_LOWER ( default )
* @ param $encoding The encoding parameter is the character encoding . Defaults to UTF - 8
* @ return array
*
*
*/
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
return ( \OC_Helper :: mb_array_change_key_case ( $input , $case , $encoding ));
}
/**
* @ brief replaces a copy of string delimited by the start and ( optionally ) length parameters with the string given in replacement .
*
* @ param $input The input string . . Opposite to the PHP build - in function does not accept an array .
* @ param $replacement The replacement string .
* @ param $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 $length Length of the part to be replaced
* @ param $encoding The encoding parameter is the character encoding . Defaults to UTF - 8
* @ return string
*
*/
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 ));
}
/**
* @ brief Replace all occurrences of the search string with the replacement string
*
* @ param $search The value being searched for , otherwise known as the needle . String .
* @ param $replace The replacement string .
* @ param $subject The string or array being searched and replaced on , otherwise known as the haystack .
* @ param $encoding The encoding parameter is the character encoding . Defaults to UTF - 8
* @ param $count If passed , this will be set to the number of replacements performed .
* @ return string
*
*/
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 19:20:19 +04:00
}
2012-07-24 12:54:56 +04:00
/**
* @ brief performs a search in a nested array
* @ param haystack the array to be searched
* @ param needle the search string
* @ param $index optional , only search this key name
* @ return the key of the matching field , otherwise false
*/
public static function recursiveArraySearch ( $haystack , $needle , $index = null ) {
return ( \OC_Helper :: recursiveArraySearch ( $haystack , $needle , $index ));
}
2012-05-01 23:07:08 +04:00
}