401 lines
12 KiB
PHP
401 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* Copyright (c) 2014 Lukas Reschke <lukas@owncloud.com>
|
|
* This file is licensed under the Affero General Public License version 3 or
|
|
* later.
|
|
* See the COPYING-README file.
|
|
*/
|
|
|
|
namespace OC;
|
|
|
|
use bantu\IniGetWrapper\IniGetWrapper;
|
|
use Exception;
|
|
use OCP\IConfig;
|
|
use OCP\IL10N;
|
|
|
|
class Setup {
|
|
/** @var \OCP\IConfig */
|
|
protected $config;
|
|
/** @var IniGetWrapper */
|
|
protected $iniWrapper;
|
|
/** @var IL10N */
|
|
protected $l10n;
|
|
/** @var \OC_Defaults */
|
|
protected $defaults;
|
|
|
|
/**
|
|
* @param IConfig $config
|
|
* @param IniGetWrapper $iniWrapper
|
|
* @param \OC_Defaults $defaults
|
|
*/
|
|
function __construct(IConfig $config,
|
|
IniGetWrapper $iniWrapper,
|
|
IL10N $l10n,
|
|
\OC_Defaults $defaults) {
|
|
$this->config = $config;
|
|
$this->iniWrapper = $iniWrapper;
|
|
$this->l10n = $l10n;
|
|
$this->defaults = $defaults;
|
|
}
|
|
|
|
static $dbSetupClasses = array(
|
|
'mysql' => '\OC\Setup\MySQL',
|
|
'pgsql' => '\OC\Setup\PostgreSQL',
|
|
'oci' => '\OC\Setup\OCI',
|
|
'mssql' => '\OC\Setup\MSSQL',
|
|
'sqlite' => '\OC\Setup\Sqlite',
|
|
'sqlite3' => '\OC\Setup\Sqlite',
|
|
);
|
|
|
|
/**
|
|
* Wrapper around the "class_exists" PHP function to be able to mock it
|
|
* @param string $name
|
|
* @return bool
|
|
*/
|
|
public function class_exists($name) {
|
|
return class_exists($name);
|
|
}
|
|
|
|
/**
|
|
* Wrapper around the "is_callable" PHP function to be able to mock it
|
|
* @param string $name
|
|
* @return bool
|
|
*/
|
|
public function is_callable($name) {
|
|
return is_callable($name);
|
|
}
|
|
|
|
/**
|
|
* Get the available and supported databases of this instance
|
|
*
|
|
* @param bool $allowAllDatabases
|
|
* @return array
|
|
* @throws Exception
|
|
*/
|
|
public function getSupportedDatabases($allowAllDatabases = false) {
|
|
$availableDatabases = array(
|
|
'sqlite' => array(
|
|
'type' => 'class',
|
|
'call' => 'SQLite3',
|
|
'name' => 'SQLite'
|
|
),
|
|
'mysql' => array(
|
|
'type' => 'function',
|
|
'call' => 'mysql_connect',
|
|
'name' => 'MySQL/MariaDB'
|
|
),
|
|
'pgsql' => array(
|
|
'type' => 'function',
|
|
'call' => 'pg_connect',
|
|
'name' => 'PostgreSQL'
|
|
),
|
|
'oci' => array(
|
|
'type' => 'function',
|
|
'call' => 'oci_connect',
|
|
'name' => 'Oracle'
|
|
),
|
|
'mssql' => array(
|
|
'type' => 'function',
|
|
'call' => 'sqlsrv_connect',
|
|
'name' => 'MS SQL'
|
|
)
|
|
);
|
|
if ($allowAllDatabases) {
|
|
$configuredDatabases = array_keys($availableDatabases);
|
|
} else {
|
|
$configuredDatabases = $this->config->getSystemValue('supportedDatabases',
|
|
array('sqlite', 'mysql', 'pgsql'));
|
|
}
|
|
if(!is_array($configuredDatabases)) {
|
|
throw new Exception('Supported databases are not properly configured.');
|
|
}
|
|
|
|
$supportedDatabases = array();
|
|
|
|
foreach($configuredDatabases as $database) {
|
|
if(array_key_exists($database, $availableDatabases)) {
|
|
$working = false;
|
|
if($availableDatabases[$database]['type'] === 'class') {
|
|
$working = $this->class_exists($availableDatabases[$database]['call']);
|
|
} elseif ($availableDatabases[$database]['type'] === 'function') {
|
|
$working = $this->is_callable($availableDatabases[$database]['call']);
|
|
}
|
|
if($working) {
|
|
$supportedDatabases[$database] = $availableDatabases[$database]['name'];
|
|
}
|
|
}
|
|
}
|
|
|
|
return $supportedDatabases;
|
|
}
|
|
|
|
/**
|
|
* Gathers system information like database type and does
|
|
* a few system checks.
|
|
*
|
|
* @return array of system info, including an "errors" value
|
|
* in case of errors/warnings
|
|
*/
|
|
public function getSystemInfo($allowAllDatabases = false) {
|
|
$databases = $this->getSupportedDatabases($allowAllDatabases);
|
|
|
|
$dataDir = $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data');
|
|
|
|
$errors = array();
|
|
|
|
// Create data directory to test whether the .htaccess works
|
|
// Notice that this is not necessarily the same data directory as the one
|
|
// that will effectively be used.
|
|
@mkdir($dataDir);
|
|
$htAccessWorking = true;
|
|
if (is_dir($dataDir) && is_writable($dataDir)) {
|
|
// Protect data directory here, so we can test if the protection is working
|
|
\OC\Setup::protectDataDirectory();
|
|
|
|
try {
|
|
$htAccessWorking = \OC_Util::isHtaccessWorking();
|
|
} catch (\OC\HintException $e) {
|
|
$errors[] = array(
|
|
'error' => $e->getMessage(),
|
|
'hint' => $e->getHint()
|
|
);
|
|
$htAccessWorking = false;
|
|
}
|
|
}
|
|
|
|
if (\OC_Util::runningOnMac()) {
|
|
$errors[] = array(
|
|
'error' => $this->l10n->t(
|
|
'Mac OS X is not supported and %s will not work properly on this platform. ' .
|
|
'Use it at your own risk! ',
|
|
$this->defaults->getName()
|
|
),
|
|
'hint' => $this->l10n->t('For the best results, please consider using a GNU/Linux server instead.')
|
|
);
|
|
}
|
|
|
|
if($this->iniWrapper->getString('open_basedir') !== '' && PHP_INT_SIZE === 4) {
|
|
$errors[] = array(
|
|
'error' => $this->l10n->t(
|
|
'It seems that this %s instance is running on a 32-bit PHP environment and the open_basedir has been configured in php.ini. ' .
|
|
'This will lead to problems with files over 4 GB and is highly discouraged.',
|
|
$this->defaults->getName()
|
|
),
|
|
'hint' => $this->l10n->t('Please remove the open_basedir setting within your php.ini or switch to 64-bit PHP.')
|
|
);
|
|
}
|
|
|
|
return array(
|
|
'hasSQLite' => isset($databases['sqlite']),
|
|
'hasMySQL' => isset($databases['mysql']),
|
|
'hasPostgreSQL' => isset($databases['pgsql']),
|
|
'hasOracle' => isset($databases['oci']),
|
|
'hasMSSQL' => isset($databases['mssql']),
|
|
'databases' => $databases,
|
|
'directory' => $dataDir,
|
|
'htaccessWorking' => $htAccessWorking,
|
|
'errors' => $errors,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param $options
|
|
* @return array
|
|
*/
|
|
public function install($options) {
|
|
$l = $this->l10n;
|
|
|
|
$error = array();
|
|
$dbType = $options['dbtype'];
|
|
|
|
if(empty($options['adminlogin'])) {
|
|
$error[] = $l->t('Set an admin username.');
|
|
}
|
|
if(empty($options['adminpass'])) {
|
|
$error[] = $l->t('Set an admin password.');
|
|
}
|
|
if(empty($options['directory'])) {
|
|
$options['directory'] = \OC::$SERVERROOT."/data";
|
|
}
|
|
|
|
if (!isset(self::$dbSetupClasses[$dbType])) {
|
|
$dbType = 'sqlite';
|
|
}
|
|
|
|
$username = htmlspecialchars_decode($options['adminlogin']);
|
|
$password = htmlspecialchars_decode($options['adminpass']);
|
|
$dataDir = htmlspecialchars_decode($options['directory']);
|
|
|
|
$class = self::$dbSetupClasses[$dbType];
|
|
/** @var \OC\Setup\AbstractDatabase $dbSetup */
|
|
$dbSetup = new $class($l, 'db_structure.xml');
|
|
$error = array_merge($error, $dbSetup->validate($options));
|
|
|
|
// validate the data directory
|
|
if (
|
|
(!is_dir($dataDir) and !mkdir($dataDir)) or
|
|
!is_writable($dataDir)
|
|
) {
|
|
$error[] = $l->t("Can't create or write into the data directory %s", array($dataDir));
|
|
}
|
|
|
|
if(count($error) != 0) {
|
|
return $error;
|
|
}
|
|
|
|
$request = \OC::$server->getRequest();
|
|
|
|
//no errors, good
|
|
if(isset($options['trusted_domains'])
|
|
&& is_array($options['trusted_domains'])) {
|
|
$trustedDomains = $options['trusted_domains'];
|
|
} else {
|
|
$trustedDomains = [$request->getInsecureServerHost()];
|
|
}
|
|
|
|
if (\OC_Util::runningOnWindows()) {
|
|
$dataDir = rtrim(realpath($dataDir), '\\');
|
|
}
|
|
|
|
//use sqlite3 when available, otherwise sqlite2 will be used.
|
|
if($dbType=='sqlite' and class_exists('SQLite3')) {
|
|
$dbType='sqlite3';
|
|
}
|
|
|
|
//generate a random salt that is used to salt the local user passwords
|
|
$salt = \OC::$server->getSecureRandom()->getLowStrengthGenerator()->generate(30);
|
|
// generate a secret
|
|
$secret = \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate(48);
|
|
|
|
//write the config file
|
|
$this->config->setSystemValues([
|
|
'passwordsalt' => $salt,
|
|
'secret' => $secret,
|
|
'trusted_domains' => $trustedDomains,
|
|
'datadirectory' => $dataDir,
|
|
'overwrite.cli.url' => $request->getServerProtocol() . '://' . $request->getInsecureServerHost() . \OC::$WEBROOT,
|
|
'dbtype' => $dbType,
|
|
'version' => implode('.', \OC_Util::getVersion()),
|
|
]);
|
|
|
|
try {
|
|
$dbSetup->initialize($options);
|
|
$dbSetup->setupDatabase($username);
|
|
} catch (\OC\DatabaseSetupException $e) {
|
|
$error[] = array(
|
|
'error' => $e->getMessage(),
|
|
'hint' => $e->getHint()
|
|
);
|
|
return($error);
|
|
} catch (Exception $e) {
|
|
$error[] = array(
|
|
'error' => 'Error while trying to create admin user: ' . $e->getMessage(),
|
|
'hint' => ''
|
|
);
|
|
return($error);
|
|
}
|
|
|
|
//create the user and group
|
|
$user = null;
|
|
try {
|
|
$user = \OC::$server->getUserManager()->createUser($username, $password);
|
|
if (!$user) {
|
|
$error[] = "User <$username> could not be created.";
|
|
}
|
|
} catch(Exception $exception) {
|
|
$error[] = $exception->getMessage();
|
|
}
|
|
|
|
if(count($error) == 0) {
|
|
$config = \OC::$server->getConfig();
|
|
$config->setAppValue('core', 'installedat', microtime(true));
|
|
$config->setAppValue('core', 'lastupdatedat', microtime(true));
|
|
|
|
$group =\OC::$server->getGroupManager()->createGroup('admin');
|
|
$group->addUser($user);
|
|
\OC_User::login($username, $password);
|
|
|
|
//guess what this does
|
|
\OC_Installer::installShippedApps();
|
|
|
|
// create empty file in data dir, so we can later find
|
|
// out that this is indeed an ownCloud data directory
|
|
file_put_contents($config->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').'/.ocdata', '');
|
|
|
|
// Update htaccess files for apache hosts
|
|
if (isset($_SERVER['SERVER_SOFTWARE']) && strstr($_SERVER['SERVER_SOFTWARE'], 'Apache')) {
|
|
self::updateHtaccess();
|
|
self::protectDataDirectory();
|
|
}
|
|
|
|
//try to write logtimezone
|
|
if (date_default_timezone_get()) {
|
|
OC_Config::setValue('logtimezone', date_default_timezone_get());
|
|
}
|
|
|
|
//and we are done
|
|
$config->setSystemValue('installed', true);
|
|
}
|
|
|
|
return $error;
|
|
}
|
|
|
|
/**
|
|
* @return string Absolute path to htaccess
|
|
*/
|
|
private function pathToHtaccess() {
|
|
return \OC::$SERVERROOT.'/.htaccess';
|
|
}
|
|
|
|
/**
|
|
* Checks if the .htaccess contains the current version parameter
|
|
*
|
|
* @return bool
|
|
*/
|
|
private function isCurrentHtaccess() {
|
|
$version = \OC_Util::getVersion();
|
|
unset($version[3]);
|
|
|
|
return !strpos(
|
|
file_get_contents($this->pathToHtaccess()),
|
|
'Version: '.implode('.', $version)
|
|
) === false;
|
|
}
|
|
|
|
/**
|
|
* Append the correct ErrorDocument path for Apache hosts
|
|
*
|
|
* @throws \OC\HintException If .htaccess does not include the current version
|
|
*/
|
|
public static function updateHtaccess() {
|
|
$setupHelper = new \OC\Setup(\OC::$server->getConfig(), \OC::$server->getIniWrapper(), \OC::$server->getL10N('lib'), new \OC_Defaults());
|
|
if(!$setupHelper->isCurrentHtaccess()) {
|
|
throw new \OC\HintException('.htaccess file has the wrong version. Please upload the correct version. Maybe you forgot to replace it after updating?');
|
|
}
|
|
|
|
$content = "\n";
|
|
$content.= "ErrorDocument 403 ".\OC::$WEBROOT."/core/templates/403.php\n";//custom 403 error page
|
|
$content.= "ErrorDocument 404 ".\OC::$WEBROOT."/core/templates/404.php";//custom 404 error page
|
|
@file_put_contents($setupHelper->pathToHtaccess(), $content, FILE_APPEND); //suppress errors in case we don't have permissions for it
|
|
}
|
|
|
|
public static function protectDataDirectory() {
|
|
//Require all denied
|
|
$now = date('Y-m-d H:i:s');
|
|
$content = "# Generated by ownCloud on $now\n";
|
|
$content.= "# line below if for Apache 2.4\n";
|
|
$content.= "<ifModule mod_authz_core.c>\n";
|
|
$content.= "Require all denied\n";
|
|
$content.= "</ifModule>\n\n";
|
|
$content.= "# line below if for Apache 2.2\n";
|
|
$content.= "<ifModule !mod_authz_core.c>\n";
|
|
$content.= "deny from all\n";
|
|
$content.= "Satisfy All\n";
|
|
$content.= "</ifModule>\n\n";
|
|
$content.= "# section for Apache 2.2 and 2.4\n";
|
|
$content.= "IndexIgnore *\n";
|
|
file_put_contents(\OC_Config::getValue('datadirectory', \OC::$SERVERROOT.'/data').'/.htaccess', $content);
|
|
file_put_contents(\OC_Config::getValue('datadirectory', \OC::$SERVERROOT.'/data').'/index.html', '');
|
|
}
|
|
}
|