nextcloud/lib/util.php

408 lines
13 KiB
PHP
Raw Normal View History

2011-07-27 21:07:28 +04:00
<?php
/**
* Class for utility functions
*
*/
2011-07-29 23:36:03 +04:00
class OC_Util {
2011-07-27 21:07:28 +04:00
public static $scripts=array();
public static $styles=array();
public static $headers=array();
private static $rootMounted=false;
2011-07-27 21:07:28 +04:00
private static $fsSetup=false;
// Can be set up
public static function setupFS( $user = "", $root = "files" ){ // configure the initial filesystem based on the configuration
if(self::$fsSetup){ //setting up the filesystem twice can only lead to trouble
2011-07-27 21:07:28 +04:00
return false;
}
$CONFIG_DATADIRECTORY_ROOT = OC_Config::getValue( "datadirectory", OC::$SERVERROOT."/data" );
$CONFIG_BACKUPDIRECTORY = OC_Config::getValue( "backupdirectory", OC::$SERVERROOT."/backup" );
2011-07-27 21:07:28 +04:00
// Check if config folder is writable.
if(!is_writable(OC::$SERVERROOT."/config/")) {
$tmpl = new OC_Template( '', 'error', 'guest' );
$tmpl->assign('errors',array(1=>array('error'=>"Can't write into config directory 'config'",'hint'=>"You can usually fix this by giving the webserver user write access to the config directory in owncloud")));
$tmpl->printPage();
exit;
}
// Check if apps folder is writable.
if(OC_Config::getValue('writable_appsdir', true) && !is_writable(OC::$SERVERROOT."/apps/")) {
$tmpl = new OC_Template( '', 'error', 'guest' );
$tmpl->assign('errors',array(1=>array('error'=>"Can't write into apps directory 'apps'",'hint'=>"You can usually fix this by giving the webserver user write access to the config directory in owncloud")));
$tmpl->printPage();
exit;
}
// Create root dir.
2011-07-27 21:07:28 +04:00
if(!is_dir($CONFIG_DATADIRECTORY_ROOT)){
$success=@mkdir($CONFIG_DATADIRECTORY_ROOT);
if(!$success) {
$tmpl = new OC_Template( '', 'error', 'guest' );
2012-04-14 20:44:32 +04:00
$tmpl->assign('errors',array(1=>array('error'=>"Can't create data directory (".$CONFIG_DATADIRECTORY_ROOT.")",'hint'=>"You can usually fix this by giving the webserver write access to the ownCloud directory '".OC::$SERVERROOT."' (in a terminal, use the command 'chown -R www-data:www-data /path/to/your/owncloud/install/data' ")));
$tmpl->printPage();
exit;
}
2011-07-27 21:07:28 +04:00
}
// If we are not forced to load a specific user we load the one that is logged in
2011-07-29 23:36:03 +04:00
if( $user == "" && OC_User::isLoggedIn()){
$user = OC_User::getUser();
2011-07-27 21:07:28 +04:00
}
//first set up the local "root" storage
if(!self::$rootMounted){
OC_Filesystem::mount('OC_Filestorage_Local',array('datadir'=>$CONFIG_DATADIRECTORY_ROOT),'/');
self::$rootMounted=true;
}
2011-07-27 21:07:28 +04:00
if( $user != "" ){ //if we aren't logged in, there is no use to set up the filesystem
OC::$CONFIG_DATADIRECTORY = $CONFIG_DATADIRECTORY_ROOT."/$user/$root";
if( !is_dir( OC::$CONFIG_DATADIRECTORY )){
mkdir( OC::$CONFIG_DATADIRECTORY, 0755, true );
2011-07-27 21:07:28 +04:00
}
//jail the user into his "home" directory
2012-01-20 03:40:52 +04:00
OC_Filesystem::init('/'.$user.'/'.$root);
$quotaProxy=new OC_FileProxy_Quota();
OC_FileProxy::register($quotaProxy);
2011-07-27 21:07:28 +04:00
self::$fsSetup=true;
}
}
public static function tearDownFS(){
2011-07-29 23:36:03 +04:00
OC_Filesystem::tearDown();
2011-07-27 21:07:28 +04:00
self::$fsSetup=false;
}
/**
* get the current installed version of ownCloud
* @return array
*/
public static function getVersion(){
2012-06-10 22:31:31 +04:00
return array(4,00,2);
}
/**
* get the current installed version string of ownCloud
* @return string
*/
public static function getVersionString(){
2012-06-10 22:31:31 +04:00
return '4.0.2';
2011-07-27 21:07:28 +04:00
}
/**
* get the current installed edition of ownCloud. There is the community edition that just returns an empty string and the enterprise edition that returns "Enterprise".
* @return string
*/
public static function getEditionString(){
return '';
}
2011-07-27 21:07:28 +04:00
/**
* add a javascript file
*
2012-05-01 23:07:08 +04:00
* @param appid $application
* @param filename $file
2011-07-27 21:07:28 +04:00
*/
public static function addScript( $application, $file = null ){
if( is_null( $file )){
$file = $application;
$application = "";
}
if( !empty( $application )){
self::$scripts[] = "$application/js/$file";
}else{
self::$scripts[] = "js/$file";
}
}
/**
* add a css file
*
2012-05-01 23:07:08 +04:00
* @param appid $application
* @param filename $file
2011-07-27 21:07:28 +04:00
*/
public static function addStyle( $application, $file = null ){
if( is_null( $file )){
$file = $application;
$application = "";
}
if( !empty( $application )){
self::$styles[] = "$application/css/$file";
}else{
self::$styles[] = "css/$file";
}
}
/**
* @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
2011-07-27 21:07:28 +04:00
* @param string $text the text content for the element
*/
public static function addHeader( $tag, $attributes, $text=''){
self::$headers[]=array('tag'=>$tag,'attributes'=>$attributes,'text'=>$text);
}
2012-04-16 14:21:12 +04:00
/**
* formats a timestamp in the "right" way
*
* @param int timestamp $timestamp
* @param bool dateOnly option to ommit time from the result
*/
public static function formatDate( $timestamp,$dateOnly=false){
if(isset($_SESSION['timezone'])){//adjust to clients timezone if we know it
$systemTimeZone = intval(date('O'));
$systemTimeZone=(round($systemTimeZone/100,0)*60)+($systemTimeZone%100);
$clientTimeZone=$_SESSION['timezone']*60;
$offset=$clientTimeZone-$systemTimeZone;
$timestamp=$timestamp+$offset*60;
}
$timeformat=$dateOnly?'F j, Y':'F j, Y, H:i';
return date($timeformat,$timestamp);
}
2011-07-27 21:07:28 +04:00
/**
* Shows a pagenavi widget where you can jump to different pages.
*
* @param int $pagecount
* @param int $page
* @param string $url
2011-07-29 23:36:03 +04:00
* @return OC_Template
2011-07-27 21:07:28 +04:00
*/
public static function getPageNavi($pagecount,$page,$url) {
$pagelinkcount=8;
if ($pagecount>1) {
$pagestart=$page-$pagelinkcount;
if($pagestart<0) $pagestart=0;
$pagestop=$page+$pagelinkcount;
if($pagestop>$pagecount) $pagestop=$pagecount;
2011-07-29 23:36:03 +04:00
$tmpl = new OC_Template( '', 'part.pagenavi', '' );
2011-07-27 21:07:28 +04:00
$tmpl->assign('page',$page);
$tmpl->assign('pagecount',$pagecount);
$tmpl->assign('pagestart',$pagestart);
$tmpl->assign('pagestop',$pagestop);
$tmpl->assign('url',$url);
return $tmpl;
}
}
/**
* check if the current server configuration is suitable for ownCloud
* @return array arrays with error messages and hints
*/
public static function checkServer(){
$CONFIG_DATADIRECTORY_ROOT = OC_Config::getValue( "datadirectory", OC::$SERVERROOT."/data" );
$CONFIG_BACKUPDIRECTORY = OC_Config::getValue( "backupdirectory", OC::$SERVERROOT."/backup" );
2011-07-29 23:36:03 +04:00
$CONFIG_INSTALLED = OC_Config::getValue( "installed", false );
2011-07-27 21:07:28 +04:00
$errors=array();
//check for database drivers
2012-01-03 15:37:33 +04:00
if(!(is_callable('sqlite_open') or class_exists('SQLite3')) and !is_callable('mysql_connect') and !is_callable('pg_connect')){
$errors[]=array('error'=>'No database drivers (sqlite, mysql, or postgresql) installed.<br/>','hint'=>'');//TODO: sane hint
2011-07-27 21:07:28 +04:00
}
2011-07-29 23:36:03 +04:00
$CONFIG_DBTYPE = OC_Config::getValue( "dbtype", "sqlite" );
$CONFIG_DBNAME = OC_Config::getValue( "dbname", "owncloud" );
2011-07-27 21:07:28 +04:00
//common hint for all file permissons error messages
$permissionsHint="Permissions can usually be fixed by giving the webserver write access to the ownCloud directory";
2011-07-27 21:07:28 +04:00
//check for correct file permissions
if(!stristr(PHP_OS, 'WIN')){
2011-09-28 13:44:46 +04:00
$permissionsModHint="Please change the permissions to 0770 so that the directory cannot be listed by other users.";
$prems=substr(decoct(@fileperms($CONFIG_DATADIRECTORY_ROOT)),-3);
2011-07-27 21:07:28 +04:00
if(substr($prems,-1)!='0'){
2011-07-29 23:36:03 +04:00
OC_Helper::chmodr($CONFIG_DATADIRECTORY_ROOT,0770);
2011-07-27 21:07:28 +04:00
clearstatcache();
$prems=substr(decoct(@fileperms($CONFIG_DATADIRECTORY_ROOT)),-3);
2011-07-27 21:07:28 +04:00
if(substr($prems,2,1)!='0'){
2011-09-28 13:44:46 +04:00
$errors[]=array('error'=>'Data directory ('.$CONFIG_DATADIRECTORY_ROOT.') is readable for other users<br/>','hint'=>$permissionsModHint);
2011-07-27 21:07:28 +04:00
}
}
2011-07-29 23:36:03 +04:00
if( OC_Config::getValue( "enablebackup", false )){
$prems=substr(decoct(@fileperms($CONFIG_BACKUPDIRECTORY)),-3);
2011-07-27 21:07:28 +04:00
if(substr($prems,-1)!='0'){
2011-07-29 23:36:03 +04:00
OC_Helper::chmodr($CONFIG_BACKUPDIRECTORY,0770);
2011-07-27 21:07:28 +04:00
clearstatcache();
$prems=substr(decoct(@fileperms($CONFIG_BACKUPDIRECTORY)),-3);
2011-07-27 21:07:28 +04:00
if(substr($prems,2,1)!='0'){
2011-09-28 13:44:46 +04:00
$errors[]=array('error'=>'Data directory ('.$CONFIG_BACKUPDIRECTORY.') is readable for other users<br/>','hint'=>$permissionsModHint);
2011-07-27 21:07:28 +04:00
}
}
}
}else{
2011-09-18 22:57:05 +04:00
//TODO: permissions checks for windows hosts
2011-07-27 21:07:28 +04:00
}
if(is_dir($CONFIG_DATADIRECTORY_ROOT) and !is_writable($CONFIG_DATADIRECTORY_ROOT)){
$errors[]=array('error'=>'Data directory ('.$CONFIG_DATADIRECTORY_ROOT.') not writable by ownCloud<br/>','hint'=>$permissionsHint);
}
2011-09-27 21:08:38 +04:00
// check if all required php modules are present
if(!class_exists('ZipArchive')){
2011-09-29 17:53:58 +04:00
$errors[]=array('error'=>'PHP module zip not installed.<br/>','hint'=>'Please ask your server administrator to install the module.');
2011-09-27 21:08:38 +04:00
}
if(!function_exists('mb_detect_encoding')){
$errors[]=array('error'=>'PHP module mb multibyte not installed.<br/>','hint'=>'Please ask your server administrator to install the module.');
}
2011-09-28 13:47:29 +04:00
if(!function_exists('ctype_digit')){
$errors[]=array('error'=>'PHP module ctype is not installed.<br/>','hint'=>'Please ask your server administrator to install the module.');
}
2012-04-17 21:06:45 +04:00
if(!function_exists('json_encode')){
$errors[]=array('error'=>'PHP module JSON is not installed.<br/>','hint'=>'Please ask your server administrator to install the module.');
}
2012-04-17 21:09:41 +04:00
if(!function_exists('imagepng')){
$errors[]=array('error'=>'PHP module GD is not installed.<br/>','hint'=>'Please ask your server administrator to install the module.');
}
if(floatval(phpversion())<5.3){
$errors[]=array('error'=>'PHP 5.3 is required.<br/>','hint'=>'Please ask your server administrator to update PHP to version 5.3 or higher. PHP 5.2 is no longer supported by ownCloud and the PHP community.');
}
2012-06-01 22:01:23 +04:00
if(!defined('PDO::ATTR_DRIVER_NAME')){
$errors[]=array('error'=>'PHP PDO module is not installed.<br/>','hint'=>'Please ask your server administrator to install the module.');
}
2011-07-27 21:07:28 +04:00
return $errors;
}
public static function displayLoginPage($parameters = array()){
if(isset($_COOKIE["username"])){
$parameters["username"] = $_COOKIE["username"];
} else {
$parameters["username"] = '';
}
2012-04-27 01:17:46 +04:00
$sectoken=rand(1000000,9999999);
$_SESSION['sectoken']=$sectoken;
$parameters["sectoken"] = $sectoken;
OC_Template::printGuestPage("", "login", $parameters);
}
2011-09-28 13:44:46 +04:00
/**
* Check if the app is enabled, redirects to home if not
*/
public static function checkAppEnabled($app){
if( !OC_App::isEnabled($app)){
header( 'Location: '.OC_Helper::linkToAbsolute( '', 'index.php' ));
exit();
}
}
/**
* Check if the user is logged in, redirects to home if not. With
* redirect URL parameter to the request URI.
*/
public static function checkLoggedIn(){
// Check if we are a user
if( !OC_User::isLoggedIn()){
header( 'Location: '.OC_Helper::linkToAbsolute( '', 'index.php' ).'?redirect_url='.urlencode($_SERVER["REQUEST_URI"]));
exit();
}
}
/**
* Check if the user is a admin, redirects to home if not
*/
public static function checkAdminUser(){
// Check if we are a user
self::checkLoggedIn();
if( !OC_Group::inGroup( OC_User::getUser(), 'admin' )){
header( 'Location: '.OC_Helper::linkToAbsolute( '', 'index.php' ));
exit();
}
}
/**
* Redirect to the user default page
*/
public static function redirectToDefaultPage(){
2012-06-11 17:21:37 +04:00
OC_Log::write('core','redirectToDefaultPage',OC_Log::DEBUG);
if(isset($_REQUEST['redirect_url']) && (substr($_REQUEST['redirect_url'], 0, strlen(OC::$WEBROOT)) == OC::$WEBROOT || $_REQUEST['redirect_url'][0] == '/')) {
header( 'Location: '.$_REQUEST['redirect_url']);
2011-10-04 21:27:57 +04:00
} else {
2012-04-18 10:20:51 +04:00
header( 'Location: '.OC::$WEBROOT.'/'.OC_Appconfig::getValue('core', 'defaultpage', '?app=files'));
2011-10-04 21:27:57 +04:00
}
exit();
}
2012-06-14 15:52:22 +04:00
/**
* @brief Register an get/post call. This is important to prevent CSRF attacks
* Todo: Write howto
* @return $token Generated token.
*/
public static function callRegister(){
//mamimum time before token exires
$maxtime=(60*60); // 1 hour
// generate a random token.
$token=mt_rand(1000,9000).mt_rand(1000,9000).mt_rand(1000,9000);
// store the token together with a timestamp in the session.
$_SESSION['requesttoken-'.$token]=time();
// cleanup old tokens garbage collector
// only run every 20th time so we don<6F>t waste cpu cycles
if(rand(0,20)==0) {
foreach($_SESSION as $key=>$value) {
// search all tokens in the session
if(substr($key,0,12)=='requesttoken') {
if($value+$maxtime<time()){
// remove outdated tokens
unset($_SESSION[$key]);
}
}
}
}
// return the token
return($token);
}
/**
* @brief Check an ajax get/post call if the request token is valid.
* @return boolean False if request token is not set or is invalid.
*/
public static function isCallRegistered(){
//mamimum time before token exires
$maxtime=(60*60); // 1 hour
if(isset($_GET['requesttoken'])) {
$token=$_GET['requesttoken'];
}elseif(isset($_POST['requesttoken'])){
$token=$_POST['requesttoken'];
}elseif(isset($_SERVER['HTTP_REQUESTTOKEN'])){
$token=$_SERVER['HTTP_REQUESTTOKEN'];
}else{
//no token found.
return false;
}
if(isset($_SESSION['requesttoken-'.$token])) {
$timestamp=$_SESSION['requesttoken-'.$token];
if($timestamp+$maxtime<time()){
return false;
}else{
//token valid
return true;
}
}else{
return false;
}
}
/**
* @brief Check an ajax get/post call if the request token is valid. exit if not.
* Todo: Write howto
*/
public static function callCheck(){
if(!OC_Util::isCallRegistered()) {
exit;
}
}
2011-07-27 21:07:28 +04:00
}
2012-06-14 15:52:22 +04:00