2012-09-07 12:09:41 +00:00
< ? php
/**
* ownCloud
*
* @ author Michael Gapczynski
* @ copyright 2012 Michael Gapczynski mtgap @ owncloud . com
*
* 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 />.
*/
/**
* Class to configure the config / mount . php and data / $user / mount . php files
*/
class OC_Mount_Config {
const MOUNT_TYPE_GLOBAL = 'global' ;
const MOUNT_TYPE_GROUP = 'group' ;
const MOUNT_TYPE_USER = 'user' ;
/**
* Get details on each of the external storage backends , used for the mount config UI
* If a custom UI is needed , add the key 'custom' and a javascript file with that name will be loaded
* If the configuration parameter should be secret , add a '*' to the beginning of the value
* If the configuration parameter is a boolean , add a '!' to the beginning of the value
* If the configuration parameter is optional , add a '&' to the beginning of the value
* If the configuration parameter is hidden , add a '#' to the begining of the value
* @ return array
*/
public static function getBackends () {
2012-12-10 20:44:43 +00:00
$backends [ 'OC_Filestorage_Local' ] = array (
2012-11-30 15:27:11 +00:00
'backend' => 'Local' ,
'configuration' => array (
2012-12-10 20:44:43 +00:00
'datadir' => 'Location' ));
$backends [ 'OC_Filestorage_AmazonS3' ] = array (
'backend' => 'Amazon S3' ,
'configuration' => array (
'key' => 'Key' ,
'secret' => '*Secret' ,
'bucket' => 'Bucket' ));
$backends [ 'OC_Filestorage_Dropbox' ] = array (
'backend' => 'Dropbox' ,
'configuration' => array (
'configured' => '#configured' ,
'app_key' => 'App key' ,
'app_secret' => 'App secret' ,
'token' => '#token' ,
'token_secret' => '#token_secret' ),
'custom' => 'dropbox' );
if ( OC_Mount_Config :: checkphpftp ()) $backends [ 'OC_Filestorage_FTP' ] = array (
'backend' => 'FTP' ,
'configuration' => array (
'host' => 'URL' ,
'user' => 'Username' ,
'password' => '*Password' ,
'root' => '&Root' ,
'secure' => '!Secure ftps://' ));
$backends [ 'OC_Filestorage_Google' ] = array (
'backend' => 'Google Drive' ,
'configuration' => array (
'configured' => '#configured' ,
'token' => '#token' ,
'token_secret' => '#token secret' ),
'custom' => 'google' );
$backends [ 'OC_Filestorage_SWIFT' ] = array (
'backend' => 'OpenStack Swift' ,
'configuration' => array (
'host' => 'URL' ,
'user' => 'Username' ,
'token' => '*Token' ,
'root' => '&Root' ,
'secure' => '!Secure ftps://' ));
if ( OC_Mount_Config :: checksmbclient ()) $backends [ 'OC_Filestorage_SMB' ] = array (
'backend' => 'SMB / CIFS' ,
'configuration' => array (
'host' => 'URL' ,
'user' => 'Username' ,
'password' => '*Password' ,
'share' => 'Share' ,
'root' => '&Root' ));
$backends [ 'OC_Filestorage_DAV' ] = array (
'backend' => 'ownCloud / WebDAV' ,
'configuration' => array (
'host' => 'URL' ,
'user' => 'Username' ,
'password' => '*Password' ,
'root' => '&Root' ,
'secure' => '!Secure https://' ));
return ( $backends );
2012-09-07 12:09:41 +00:00
}
/**
* Get the system mount points
* The returned array is not in the same format as getUserMountPoints ()
* @ return array
*/
public static function getSystemMountPoints () {
$mountPoints = self :: readData ( false );
$backends = self :: getBackends ();
$system = array ();
if ( isset ( $mountPoints [ self :: MOUNT_TYPE_GROUP ])) {
foreach ( $mountPoints [ self :: MOUNT_TYPE_GROUP ] as $group => $mounts ) {
foreach ( $mounts as $mountPoint => $mount ) {
// Remove '/$user/files/' from mount point
$mountPoint = substr ( $mountPoint , 13 );
// Merge the mount point into the current mount points
if ( isset ( $system [ $mountPoint ]) && $system [ $mountPoint ][ 'configuration' ] == $mount [ 'options' ]) {
2012-11-30 15:27:11 +00:00
$system [ $mountPoint ][ 'applicable' ][ 'groups' ]
= array_merge ( $system [ $mountPoint ][ 'applicable' ][ 'groups' ], array ( $group ));
2012-09-07 12:09:41 +00:00
} else {
2012-11-30 15:27:11 +00:00
$system [ $mountPoint ] = array (
'class' => $mount [ 'class' ],
'backend' => $backends [ $mount [ 'class' ]][ 'backend' ],
'configuration' => $mount [ 'options' ],
'applicable' => array ( 'groups' => array ( $group ), 'users' => array ()));
2012-09-07 12:09:41 +00:00
}
}
}
}
if ( isset ( $mountPoints [ self :: MOUNT_TYPE_USER ])) {
foreach ( $mountPoints [ self :: MOUNT_TYPE_USER ] as $user => $mounts ) {
foreach ( $mounts as $mountPoint => $mount ) {
// Remove '/$user/files/' from mount point
$mountPoint = substr ( $mountPoint , 13 );
// Merge the mount point into the current mount points
if ( isset ( $system [ $mountPoint ]) && $system [ $mountPoint ][ 'configuration' ] == $mount [ 'options' ]) {
2012-11-30 15:27:11 +00:00
$system [ $mountPoint ][ 'applicable' ][ 'users' ]
= array_merge ( $system [ $mountPoint ][ 'applicable' ][ 'users' ], array ( $user ));
2012-09-07 12:09:41 +00:00
} else {
2012-11-30 15:27:11 +00:00
$system [ $mountPoint ] = array ( 'class' => $mount [ 'class' ],
'backend' => $backends [ $mount [ 'class' ]][ 'backend' ],
'configuration' => $mount [ 'options' ],
'applicable' => array ( 'groups' => array (), 'users' => array ( $user )));
2012-09-07 12:09:41 +00:00
}
}
}
}
return $system ;
}
/**
* Get the personal mount points of the current user
* The returned array is not in the same format as getUserMountPoints ()
* @ return array
*/
public static function getPersonalMountPoints () {
$mountPoints = self :: readData ( true );
$backends = self :: getBackends ();
$uid = OCP\User :: getUser ();
$personal = array ();
if ( isset ( $mountPoints [ self :: MOUNT_TYPE_USER ][ $uid ])) {
foreach ( $mountPoints [ self :: MOUNT_TYPE_USER ][ $uid ] as $mountPoint => $mount ) {
// Remove '/uid/files/' from mount point
2012-11-30 15:27:11 +00:00
$personal [ substr ( $mountPoint , strlen ( $uid ) + 8 )] = array ( 'class' => $mount [ 'class' ],
'backend' => $backends [ $mount [ 'class' ]][ 'backend' ],
'configuration' => $mount [ 'options' ]);
2012-09-07 12:09:41 +00:00
}
}
return $personal ;
}
2012-10-12 12:52:22 +00:00
/**
* Add directory for mount point to the filesystem
* @ param OC_Fileview instance $view
* @ param string path to mount point
2012-10-09 13:05:49 +00:00
*/
private static function addMountPointDirectory ( $view , $path ) {
$dir = '' ;
foreach ( explode ( '/' , $path ) as $pathPart ) {
$dir = $dir . '/' . $pathPart ;
if ( ! $view -> file_exists ( $dir )) {
$view -> mkdir ( $dir );
2012-10-14 19:04:08 +00:00
}
2012-10-09 13:05:49 +00:00
}
}
2012-10-14 19:04:08 +00:00
2012-09-07 12:09:41 +00:00
/**
* Add a mount point to the filesystem
* @ param string Mount point
* @ param string Backend class
* @ param array Backend parameters for the class
* @ param string MOUNT_TYPE_GROUP | MOUNT_TYPE_USER
* @ param string User or group to apply mount to
* @ param bool Personal or system mount point i . e . is this being called from the personal or admin page
* @ return bool
*/
2012-11-30 15:27:11 +00:00
public static function addMountPoint ( $mountPoint ,
$class ,
$classOptions ,
$mountType ,
$applicable ,
$isPersonal = false ) {
2012-09-07 12:09:41 +00:00
if ( $isPersonal ) {
// Verify that the mount point applies for the current user
// Prevent non-admin users from mounting local storage
if ( $applicable != OCP\User :: getUser () || $class == 'OC_Filestorage_Local' ) {
return false ;
}
2012-10-09 13:05:49 +00:00
$view = new OC_FilesystemView ( '/' . OCP\User :: getUser () . '/files' );
self :: addMountPointDirectory ( $view , ltrim ( $mountPoint , '/' ));
2012-09-07 12:09:41 +00:00
$mountPoint = '/' . $applicable . '/files/' . ltrim ( $mountPoint , '/' );
} else {
2012-10-09 13:05:49 +00:00
$view = new OC_FilesystemView ( '/' );
switch ( $mountType ) {
case 'user' :
if ( $applicable == " all " ) {
$users = OCP\User :: getUsers ();
foreach ( $users as $user ) {
$path = $user . '/files/' . ltrim ( $mountPoint , '/' );
self :: addMountPointDirectory ( $view , $path );
}
} else {
$path = $applicable . '/files/' . ltrim ( $mountPoint , '/' );
self :: addMountPointDirectory ( $view , $path );
}
break ;
2012-10-14 19:04:08 +00:00
case 'group' :
2012-10-09 13:05:49 +00:00
$groupMembers = OC_Group :: usersInGroups ( array ( $applicable ));
foreach ( $groupMembers as $user ) {
$path = $user . '/files/' . ltrim ( $mountPoint , '/' );
self :: addMountPointDirectory ( $view , $path );
}
break ;
}
2012-09-07 12:09:41 +00:00
$mountPoint = '/$user/files/' . ltrim ( $mountPoint , '/' );
}
$mount = array ( $applicable => array ( $mountPoint => array ( 'class' => $class , 'options' => $classOptions )));
$mountPoints = self :: readData ( $isPersonal );
// Merge the new mount point into the current mount points
if ( isset ( $mountPoints [ $mountType ])) {
if ( isset ( $mountPoints [ $mountType ][ $applicable ])) {
2012-11-30 15:27:11 +00:00
$mountPoints [ $mountType ][ $applicable ]
= array_merge ( $mountPoints [ $mountType ][ $applicable ], $mount [ $applicable ]);
2012-09-07 12:09:41 +00:00
} else {
$mountPoints [ $mountType ] = array_merge ( $mountPoints [ $mountType ], $mount );
}
} else {
$mountPoints [ $mountType ] = $mount ;
}
self :: writeData ( $isPersonal , $mountPoints );
return true ;
}
/**
*
* @ param string Mount point
* @ param string MOUNT_TYPE_GROUP | MOUNT_TYPE_USER
* @ param string User or group to remove mount from
* @ param bool Personal or system mount point
* @ return bool
*/
public static function removeMountPoint ( $mountPoint , $mountType , $applicable , $isPersonal = false ) {
// Verify that the mount point applies for the current user
if ( $isPersonal ) {
if ( $applicable != OCP\User :: getUser ()) {
return false ;
}
$mountPoint = '/' . $applicable . '/files/' . ltrim ( $mountPoint , '/' );
} else {
$mountPoint = '/$user/files/' . ltrim ( $mountPoint , '/' );
}
$mountPoints = self :: readData ( $isPersonal );
// Remove mount point
unset ( $mountPoints [ $mountType ][ $applicable ][ $mountPoint ]);
// Unset parent arrays if empty
if ( empty ( $mountPoints [ $mountType ][ $applicable ])) {
unset ( $mountPoints [ $mountType ][ $applicable ]);
if ( empty ( $mountPoints [ $mountType ])) {
unset ( $mountPoints [ $mountType ]);
}
}
self :: writeData ( $isPersonal , $mountPoints );
return true ;
}
/**
* Read the mount points in the config file into an array
* @ param bool Personal or system config file
* @ return array
*/
private static function readData ( $isPersonal ) {
if ( $isPersonal ) {
$file = OC_User :: getHome ( OCP\User :: getUser ()) . '/mount.php' ;
} else {
$file = OC :: $SERVERROOT . '/config/mount.php' ;
}
if ( is_file ( $file )) {
2012-10-22 19:40:33 +00:00
$mountPoints = include $file ;
2012-09-07 12:09:41 +00:00
if ( is_array ( $mountPoints )) {
return $mountPoints ;
}
}
return array ();
}
/**
* Write the mount points to the config file
* @ param bool Personal or system config file
* @ param array Mount points
*/
private static function writeData ( $isPersonal , $data ) {
if ( $isPersonal ) {
$file = OC_User :: getHome ( OCP\User :: getUser ()) . '/mount.php' ;
} else {
$file = OC :: $SERVERROOT . '/config/mount.php' ;
}
$content = " <?php return array ( \n " ;
if ( isset ( $data [ self :: MOUNT_TYPE_GROUP ])) {
$content .= " \t 'group' => array ( \n " ;
foreach ( $data [ self :: MOUNT_TYPE_GROUP ] as $group => $mounts ) {
$content .= " \t \t ' " . $group . " ' => array ( \n " ;
foreach ( $mounts as $mountPoint => $mount ) {
2012-11-02 18:53:02 +00:00
$content .= " \t \t \t ' " . $mountPoint . " ' => " . str_replace ( " \n " , '' , var_export ( $mount , true )) . " , \n " ;
2012-09-07 12:09:41 +00:00
}
$content .= " \t \t ), \n " ;
}
$content .= " \t ), \n " ;
}
if ( isset ( $data [ self :: MOUNT_TYPE_USER ])) {
$content .= " \t 'user' => array ( \n " ;
foreach ( $data [ self :: MOUNT_TYPE_USER ] as $user => $mounts ) {
$content .= " \t \t ' " . $user . " ' => array ( \n " ;
foreach ( $mounts as $mountPoint => $mount ) {
$content .= " \t \t \t ' " . $mountPoint . " ' => " . str_replace ( " \n " , '' , var_export ( $mount , true )) . " , \n " ;
}
$content .= " \t \t ), \n " ;
}
$content .= " \t ), \n " ;
}
$content .= " ); \n ?> " ;
@ file_put_contents ( $file , $content );
}
/**
* Returns all user uploaded ssl root certificates
* @ return array
*/
public static function getCertificates () {
$view = \OCP\Files :: getStorage ( 'files_external' );
$path = \OCP\Config :: getSystemValue ( 'datadirectory' ) . $view -> getAbsolutePath ( " " ) . 'uploads/' ;
2012-11-05 20:37:59 +00:00
\OCP\Util :: writeLog ( 'files_external' , 'checking path ' . $path , \OCP\Util :: INFO );
2012-11-30 15:27:11 +00:00
if ( ! is_dir ( $path )) {
2012-11-05 20:37:59 +00:00
//path might not exist (e.g. non-standard OC_User::getHome() value)
//in this case create full path using 3rd (recursive=true) parameter.
mkdir ( $path , 0777 , true );
}
2012-09-07 12:09:41 +00:00
$result = array ();
$handle = opendir ( $path );
2012-11-30 15:27:11 +00:00
if ( ! $handle ) {
2012-10-12 12:52:22 +00:00
return array ();
}
2012-09-07 12:09:41 +00:00
while ( false !== ( $file = readdir ( $handle ))) {
2012-11-30 15:27:11 +00:00
if ( $file != '.' && $file != '..' ) $result [] = $file ;
2012-09-07 12:09:41 +00:00
}
return $result ;
}
/**
* creates certificate bundle
*/
public static function createCertificateBundle () {
$view = \OCP\Files :: getStorage ( " files_external " );
$path = \OCP\Config :: getSystemValue ( 'datadirectory' ) . $view -> getAbsolutePath ( " " );
$certs = OC_Mount_Config :: getCertificates ();
$fh_certs = fopen ( $path . " /rootcerts.crt " , 'w' );
foreach ( $certs as $cert ) {
$file = $path . '/uploads/' . $cert ;
$fh = fopen ( $file , " r " );
$data = fread ( $fh , filesize ( $file ));
fclose ( $fh );
if ( strpos ( $data , 'BEGIN CERTIFICATE' )) {
fwrite ( $fh_certs , $data );
2012-09-21 14:54:08 +00:00
fwrite ( $fh_certs , " \r \n " );
2012-09-07 12:09:41 +00:00
}
}
fclose ( $fh_certs );
return true ;
}
2012-12-10 20:10:28 +00:00
/**
* check if smbclient is installed
*/
public static function checksmbclient () {
$output = shell_exec ( 'which smbclient' );
return ( empty ( $output ) ? false : true );
}
/**
* check if php - ftp is installed
*/
public static function checkphpftp () {
if ( function_exists ( 'ftp_login' )) {
return ( true );
} else {
return ( false );
}
}
/**
* check dependencies
*/
public static function checkDependencies () {
$l = new OC_L10N ;
$txt = '' ;
if ( ! OC_Mount_Config :: checksmbclient ()) $txt .= $l -> t ( '<b>Warning:</b> "smbclient" is not installed. Mounting of CIFS/SMB shares is not possible. Please ask your system administrator to install it.' ) . '<br />' ;
if ( ! OC_Mount_Config :: checkphpftp ()) $txt .= $l -> t ( '<b>Warning:</b> The FTP support in PHP is not enabled or installed. Mounting of FTP shares is not possible. Please ask your system administrator to install it.' ) . '<br />' ;
return ( $txt );
}
2012-09-07 12:09:41 +00:00
}