nextcloud/lib/private/setup.php

458 lines
13 KiB
PHP
Raw Normal View History

2011-04-17 02:45:05 +04:00
<?php
/**
2015-03-26 13:44:34 +03:00
* @author Administrator <Administrator@WINDOWS-2012>
* @author Arthur Schiwon <blizzz@owncloud.com>
* @author Bart Visscher <bartv@thisnet.nl>
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @author Brice Maron <brice@bmaron.net>
* @author François Kubler <francois@kubler.org>
* @author Jakob Sack <mail@jakobsack.de>
* @author Joas Schilling <nickvergessen@owncloud.com>
* @author Lukas Reschke <lukas@owncloud.com>
* @author Martin Mattel <martin.mattel@diemattels.at>
* @author Robin Appelman <icewind@owncloud.com>
* @author Sean Comeau <sean@ftlnetworks.ca>
* @author Serge Martin <edb@sigluy.net>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vincent Petry <pvince81@owncloud.com>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
2015-02-21 22:51:50 +03:00
namespace OC;
use bantu\IniGetWrapper\IniGetWrapper;
2015-02-21 22:51:50 +03:00
use Exception;
use OCP\IConfig;
use OCP\IL10N;
use OCP\ILogger;
use OCP\Security\ISecureRandom;
2011-04-17 02:45:05 +04:00
2015-02-21 22:51:50 +03:00
class Setup {
/** @var \OCP\IConfig */
protected $config;
/** @var IniGetWrapper */
protected $iniWrapper;
/** @var IL10N */
protected $l10n;
/** @var \OC_Defaults */
protected $defaults;
/** @var ILogger */
protected $logger;
/** @var ISecureRandom */
protected $random;
/**
* @param IConfig $config
* @param IniGetWrapper $iniWrapper
* @param \OC_Defaults $defaults
*/
function __construct(IConfig $config,
IniGetWrapper $iniWrapper,
IL10N $l10n,
\OC_Defaults $defaults,
ILogger $logger,
ISecureRandom $random
) {
$this->config = $config;
$this->iniWrapper = $iniWrapper;
$this->l10n = $l10n;
$this->defaults = $defaults;
$this->logger = $logger;
$this->random = $random;
}
2013-06-27 22:19:51 +04:00
static $dbSetupClasses = array(
'mysql' => '\OC\Setup\MySQL',
'pgsql' => '\OC\Setup\PostgreSQL',
'oci' => '\OC\Setup\OCI',
'sqlite' => '\OC\Setup\Sqlite',
'sqlite3' => '\OC\Setup\Sqlite',
);
2013-02-09 22:23:36 +04:00
/**
* Wrapper around the "class_exists" PHP function to be able to mock it
* @param string $name
* @return bool
*/
protected 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
*/
protected function is_callable($name) {
return is_callable($name);
}
/**
* Wrapper around \PDO::getAvailableDrivers
*
* @return array
*/
protected function getAvailableDbDriversForPdo() {
return \PDO::getAvailableDrivers();
}
/**
* Get the available and supported databases of this instance
*
2015-03-11 17:47:24 +03:00
* @param bool $allowAllDatabases
* @return array
2015-03-11 17:47:24 +03:00
* @throws Exception
*/
2015-03-11 17:47:24 +03:00
public function getSupportedDatabases($allowAllDatabases = false) {
$availableDatabases = array(
'sqlite' => array(
'type' => 'class',
'call' => 'SQLite3',
'name' => 'SQLite'
),
'mysql' => array(
'type' => 'pdo',
'call' => 'mysql',
'name' => 'MySQL/MariaDB'
),
'pgsql' => array(
'type' => 'function',
2014-10-30 12:37:59 +03:00
'call' => 'pg_connect',
'name' => 'PostgreSQL'
),
'oci' => array(
'type' => 'function',
'call' => 'oci_connect',
'name' => 'Oracle'
)
);
2015-03-11 17:47:24 +03:00
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;
$type = $availableDatabases[$database]['type'];
$call = $availableDatabases[$database]['call'];
if($type === 'class') {
$working = $this->class_exists($call);
} elseif ($type === 'function') {
$working = $this->is_callable($call);
} elseif($type === 'pdo') {
$working = in_array($call, $this->getAvailableDbDriversForPdo(), TRUE);
}
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
*/
2015-03-11 17:47:24 +03:00
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 {
$util = new \OC_Util();
$htAccessWorking = $util->isHtaccessWorking(\OC::$server->getConfig());
} 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']),
'databases' => $databases,
'directory' => $dataDir,
'htaccessWorking' => $htAccessWorking,
'errors' => $errors,
);
}
/**
* @param $options
* @return array
*/
public function install($options) {
$l = $this->l10n;
2013-02-09 22:23:36 +04:00
$error = array();
2014-10-27 21:53:12 +03:00
$dbType = $options['dbtype'];
2012-08-29 10:38:33 +04:00
if(empty($options['adminlogin'])) {
2013-02-09 22:23:36 +04:00
$error[] = $l->t('Set an admin username.');
}
if(empty($options['adminpass'])) {
2013-02-09 22:23:36 +04:00
$error[] = $l->t('Set an admin password.');
}
if(empty($options['directory'])) {
2015-02-21 22:51:50 +03:00
$options['directory'] = \OC::$SERVERROOT."/data";
}
2011-08-07 23:06:53 +04:00
2014-10-27 21:53:12 +03:00
if (!isset(self::$dbSetupClasses[$dbType])) {
$dbType = 'sqlite';
2012-10-27 00:46:12 +04:00
}
$username = htmlspecialchars_decode($options['adminlogin']);
$password = htmlspecialchars_decode($options['adminpass']);
2014-10-27 21:53:12 +03:00
$dataDir = htmlspecialchars_decode($options['directory']);
2014-10-27 21:53:12 +03:00
$class = self::$dbSetupClasses[$dbType];
/** @var \OC\Setup\AbstractDatabase $dbSetup */
$dbSetup = new $class($l, 'db_structure.xml', $this->config,
$this->logger, $this->random);
2013-06-27 22:19:51 +04:00
$error = array_merge($error, $dbSetup->validate($options));
2012-10-27 00:46:12 +04:00
// validate the data directory
if (
2014-10-27 21:53:12 +03:00
(!is_dir($dataDir) and !mkdir($dataDir)) or
!is_writable($dataDir)
) {
2014-10-27 21:53:12 +03:00
$error[] = $l->t("Can't create or write into the data directory %s", array($dataDir));
}
if(count($error) != 0) {
return $error;
2012-10-27 00:46:12 +04:00
}
$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()];
}
2012-10-27 00:46:12 +04:00
2015-02-21 22:51:50 +03:00
if (\OC_Util::runningOnWindows()) {
2014-10-27 21:53:12 +03:00
$dataDir = rtrim(realpath($dataDir), '\\');
2012-10-27 00:46:12 +04:00
}
2014-10-27 21:53:12 +03:00
//use sqlite3 when available, otherwise sqlite2 will be used.
if($dbType=='sqlite' and class_exists('SQLite3')) {
$dbType='sqlite3';
2011-04-17 02:45:05 +04:00
}
//generate a random salt that is used to salt the local user passwords
$salt = $this->random->getLowStrengthGenerator()->generate(30);
// generate a secret
$secret = $this->random->getMediumStrengthGenerator()->generate(48);
2011-05-07 00:50:18 +04:00
//write the config file
$this->config->setSystemValues([
'passwordsalt' => $salt,
'secret' => $secret,
'trusted_domains' => $trustedDomains,
'datadirectory' => $dataDir,
2015-02-21 22:51:50 +03:00
'overwrite.cli.url' => $request->getServerProtocol() . '://' . $request->getInsecureServerHost() . \OC::$WEBROOT,
'dbtype' => $dbType,
2015-02-21 22:51:50 +03:00
'version' => implode('.', \OC_Util::getVersion()),
]);
try {
2013-06-27 22:19:51 +04:00
$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);
}
2012-10-27 00:46:12 +04:00
//create the user and group
2015-02-21 22:51:50 +03:00
$user = null;
try {
2015-02-21 22:51:50 +03:00
$user = \OC::$server->getUserManager()->createUser($username, $password);
if (!$user) {
$error[] = "User <$username> could not be created.";
}
2014-10-27 21:53:12 +03:00
} catch(Exception $exception) {
$error[] = $exception->getMessage();
2012-10-27 00:46:12 +04:00
}
if(count($error) == 0) {
2015-02-21 22:51:50 +03:00
$config = \OC::$server->getConfig();
$config->setAppValue('core', 'installedat', microtime(true));
$config->setAppValue('core', 'lastupdatedat', microtime(true));
2012-10-27 00:46:12 +04:00
2015-02-21 22:51:50 +03:00
$group =\OC::$server->getGroupManager()->createGroup('admin');
$group->addUser($user);
\OC_User::login($username, $password);
2012-10-27 00:46:12 +04:00
//guess what this does
2015-02-21 22:51:50 +03:00
\OC_Installer::installShippedApps();
2013-02-09 22:23:36 +04:00
// create empty file in data dir, so we can later find
// out that this is indeed an ownCloud data directory
2015-02-21 22:51:50 +03:00
file_put_contents($config->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').'/.ocdata', '');
// Update .htaccess files
Setup::updateHtaccess();
Setup::protectDataDirectory();
//try to write logtimezone
if (date_default_timezone_get()) {
$config->setSystemValue('logtimezone', date_default_timezone_get());
}
//and we are done
2015-02-21 22:51:50 +03:00
$config->setSystemValue('installed', true);
}
2012-10-27 00:46:12 +04:00
return $error;
}
2013-02-12 04:05:47 +04:00
/**
* @return string Absolute path to htaccess
*/
private function pathToHtaccess() {
2015-02-21 22:51:50 +03:00
return \OC::$SERVERROOT.'/.htaccess';
}
/**
* Append the correct ErrorDocument path for Apache hosts
*/
public static function updateHtaccess() {
2015-12-08 10:17:04 +03:00
// From CLI we don't know the defined web root. Thus we can't write any
// directives into the .htaccess file.
if(\OC::$CLI) {
return;
}
$setupHelper = new \OC\Setup(\OC::$server->getConfig(), \OC::$server->getIniWrapper(),
\OC::$server->getL10N('lib'), new \OC_Defaults(), \OC::$server->getLogger(),
\OC::$server->getSecureRandom());
$htaccessContent = file_get_contents($setupHelper->pathToHtaccess());
$content = '';
if (strpos($htaccessContent, 'ErrorDocument 403') === false) {
//custom 403 error page
$content.= "\nErrorDocument 403 ".\OC::$WEBROOT."/core/templates/403.php";
}
if (strpos($htaccessContent, 'ErrorDocument 404') === false) {
//custom 404 error page
$content.= "\nErrorDocument 404 ".\OC::$WEBROOT."/core/templates/404.php";
}
// Add rewrite base
$webRoot = !empty(\OC::$WEBROOT) ? \OC::$WEBROOT : '/';
$content.="\n<IfModule mod_rewrite.c>";
$content.="\n RewriteBase ".$webRoot;
$content .= "\n <IfModule mod_env.c>";
$content .= "\n SetEnv front_controller_active true";
$content .= "\n <IfModule mod_dir.c>";
$content .= "\n DirectorySlash off";
$content .= "\n </IfModule>";
$content.="\n </IfModule>";
$content.="\n</IfModule>";
if ($content !== '') {
//suppress errors in case we don't have permissions for it
@file_put_contents($setupHelper->pathToHtaccess(), $content . "\n", FILE_APPEND);
}
}
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";
$baseDir = \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data');
file_put_contents($baseDir . '/.htaccess', $content);
file_put_contents($baseDir . '/index.html', '');
}
2011-04-17 02:45:05 +04:00
}