aboutsummaryrefslogtreecommitdiffstats
path: root/lib/util.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/util.php')
-rw-r--r--lib/util.php245
1 files changed, 245 insertions, 0 deletions
diff --git a/lib/util.php b/lib/util.php
new file mode 100644
index 00000000000..8beb4a884bc
--- /dev/null
+++ b/lib/util.php
@@ -0,0 +1,245 @@
+<?php
+
+/**
+ * Class for utility functions
+ *
+ */
+class OC_UTIL {
+ public static $scripts=array();
+ public static $styles=array();
+ public static $headers=array();
+ 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
+ return false;
+ }
+
+ // Global Variables
+ global $SERVERROOT;
+ global $CONFIG_DATADIRECTORY;
+
+ $CONFIG_DATADIRECTORY_ROOT = OC_CONFIG::getValue( "datadirectory", "$SERVERROOT/data" );
+ $CONFIG_BACKUPDIRECTORY = OC_CONFIG::getValue( "backupdirectory", "$SERVERROOT/backup" );
+
+ // Create root dir
+ if(!is_dir($CONFIG_DATADIRECTORY_ROOT)){
+ @mkdir($CONFIG_DATADIRECTORY_ROOT) or die("Can't create data directory ($CONFIG_DATADIRECTORY_ROOT), you can usually fix this by setting the owner of '$SERVERROOT' to the user that the web server uses (www-data for debian/ubuntu)");
+ }
+
+ // If we are not forced to load a specific user we load the one that is logged in
+ if( $user == "" && OC_USER::isLoggedIn()){
+ $user = OC_USER::getUser();
+ }
+
+ if( $user != "" ){ //if we aren't logged in, there is no use to set up the filesystem
+ //first set up the local "root" storage and the backupstorage if needed
+ $rootStorage=OC_FILESYSTEM::createStorage('local',array('datadir'=>$CONFIG_DATADIRECTORY_ROOT));
+// if( OC_CONFIG::getValue( "enablebackup", false )){
+// // This creates the Directorys recursively
+// if(!is_dir( "$CONFIG_BACKUPDIRECTORY/$user/$root" )){
+// mkdir( "$CONFIG_BACKUPDIRECTORY/$user/$root", 0755, true );
+// }
+// $backupStorage=OC_FILESYSTEM::createStorage('local',array('datadir'=>$CONFIG_BACKUPDIRECTORY));
+// $backup=new OC_FILEOBSERVER_BACKUP(array('storage'=>$backupStorage));
+// $rootStorage->addObserver($backup);
+// }
+ OC_FILESYSTEM::mount($rootStorage,'/');
+
+ $CONFIG_DATADIRECTORY = "$CONFIG_DATADIRECTORY_ROOT/$user/$root";
+ if( !is_dir( $CONFIG_DATADIRECTORY )){
+ mkdir( $CONFIG_DATADIRECTORY, 0755, true );
+ }
+
+// TODO: find a cool way for doing this
+// //set up the other storages according to the system settings
+// foreach($CONFIG_FILESYSTEM as $storageConfig){
+// if(OC_FILESYSTEM::hasStorageType($storageConfig['type'])){
+// $arguments=$storageConfig;
+// unset($arguments['type']);
+// unset($arguments['mountpoint']);
+// $storage=OC_FILESYSTEM::createStorage($storageConfig['type'],$arguments);
+// if($storage){
+// OC_FILESYSTEM::mount($storage,$storageConfig['mountpoint']);
+// }
+// }
+// }
+
+ //jail the user into his "home" directory
+ OC_FILESYSTEM::chroot("/$user/$root");
+ self::$fsSetup=true;
+ }
+ }
+
+ public static function tearDownFS(){
+ OC_FILESYSTEM::tearDown();
+ self::$fsSetup=false;
+ }
+
+ /**
+ * get the current installed version of ownCloud
+ * @return array
+ */
+ public static function getVersion(){
+ return array(1,60,0);
+ }
+
+ /**
+ * add a javascript file
+ *
+ * @param url $url
+ */
+ 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
+ *
+ * @param url $url
+ */
+ 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 attrobutes for the element
+ * @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);
+ }
+
+ /**
+ * 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(exec('date +%z'));
+ $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);
+ }
+
+ /**
+ * Shows a pagenavi widget where you can jump to different pages.
+ *
+ * @param int $pagecount
+ * @param int $page
+ * @param string $url
+ * @return OC_TEMPLATE
+ */
+ 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;
+
+ $tmpl = new OC_TEMPLATE( '', 'part.pagenavi', '' );
+ $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(){
+ global $SERVERROOT;
+ global $CONFIG_DATADIRECTORY;
+
+ $CONFIG_DATADIRECTORY_ROOT = OC_CONFIG::getValue( "datadirectory", "$SERVERROOT/data" );;
+ $CONFIG_BACKUPDIRECTORY = OC_CONFIG::getValue( "backupdirectory", "$SERVERROOT/backup" );
+ $CONFIG_INSTALLED = OC_CONFIG::getValue( "installed", false );
+ $errors=array();
+
+ //check for database drivers
+ if(!is_callable('sqlite_open') and !is_callable('mysql_connect')){
+ $errors[]=array('error'=>'No database drivers (sqlite or mysql) installed.<br/>','hint'=>'');//TODO: sane hint
+ }
+ $CONFIG_DBTYPE = OC_CONFIG::getValue( "dbtype", "sqlite" );
+ $CONFIG_DBNAME = OC_CONFIG::getValue( "dbname", "owncloud" );
+
+ //try to get the username the httpd server runs on, used in hints
+ $stat=stat($_SERVER['DOCUMENT_ROOT']);
+ if(is_callable('posix_getpwuid')){
+ $serverUser=posix_getpwuid($stat['uid']);
+ $serverUser='\''.$serverUser['name'].'\'';
+ }else{
+ $serverUser='\'www-data\' for ubuntu/debian';//TODO: try to detect the distro and give a guess based on that
+ }
+
+ //common hint for all file permissons error messages
+ $permissionsHint="Permissions can usually be fixed by setting the owner of the file or directory to the user the web server runs as ($serverUser)";
+
+ //check for correct file permissions
+ if(!stristr(PHP_OS, 'WIN')){
+ $prems=substr(decoct(fileperms($CONFIG_DATADIRECTORY_ROOT)),-3);
+ if(substr($prems,-1)!='0'){
+ OC_HELPER::chmodr($CONFIG_DATADIRECTORY_ROOT,0770);
+ clearstatcache();
+ $prems=substr(decoct(fileperms($CONFIG_DATADIRECTORY_ROOT)),-3);
+ if(substr($prems,2,1)!='0'){
+ $errors[]=array('error'=>'Data directory ('.$CONFIG_DATADIRECTORY_ROOT.') is readable from the web<br/>','hint'=>$permissionsHint);
+ }
+ }
+ if( OC_CONFIG::getValue( "enablebackup", false )){
+ $prems=substr(decoct(fileperms($CONFIG_BACKUPDIRECTORY)),-3);
+ if(substr($prems,-1)!='0'){
+ OC_HELPER::chmodr($CONFIG_BACKUPDIRECTORY,0770);
+ clearstatcache();
+ $prems=substr(decoct(fileperms($CONFIG_BACKUPDIRECTORY)),-3);
+ if(substr($prems,2,1)!='0'){
+ $errors[]=array('error'=>'Data directory ('.$CONFIG_BACKUPDIRECTORY.') is readable from the web<br/>','hint'=>$permissionsHint);
+ }
+ }
+ }
+ }else{
+ //TODO: premisions checks for windows hosts
+ }
+ 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);
+ }
+
+ //TODO: check for php modules
+
+ return $errors;
+ }
+}
+