nextcloud/lib/private/setup.php

306 lines
8.4 KiB
PHP
Raw Normal View History

2011-04-17 02:45:05 +04:00
<?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.
*/
use OCP\IConfig;
2011-04-17 02:45:05 +04:00
2011-07-29 23:36:03 +04:00
class OC_Setup {
/** @var IConfig */
protected $config;
/**
* @param IConfig $config
*/
function __construct(IConfig $config) {
$this->config = $config;
}
2013-06-27 22:19:51 +04:00
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',
);
2013-02-09 22:23:36 +04:00
/**
* @return OC_L10N
*/
2013-02-09 22:23:36 +04:00
public static function getTrans(){
2014-08-31 12:05:59 +04:00
return \OC::$server->getL10N('lib');
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
*/
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
*
* @throws Exception
* @return array
*/
public function getSupportedDatabases() {
$availableDatabases = array(
'sqlite' => array(
'type' => 'class',
'call' => 'SQLite3',
'name' => 'SQLite'
),
'mysql' => array(
'type' => 'function',
'call' => 'mysql_connect',
'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'
),
'mssql' => array(
'type' => 'function',
'call' => 'sqlsrv_connect',
'name' => 'MS SQL'
)
);
2014-10-27 21:53:12 +03:00
$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;
}
/**
* @param $options
* @return array
*/
public static function install($options) {
2013-02-09 22:23:36 +04:00
$l = self::getTrans();
$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'])) {
$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 */
2013-06-27 22:19:51 +04:00
$dbSetup = new $class(self::getTrans(), 'db_structure.xml');
$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
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 = \OC::$server->getSecureRandom()->getLowStrengthGenerator()->generate(30);
// generate a secret
$secret = \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate(48);
2011-05-07 00:50:18 +04:00
//write the config file
\OC::$server->getConfig()->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 {
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
try {
OC_User::createUser($username, $password);
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) {
2014-02-13 19:28:49 +04:00
$appConfig = \OC::$server->getAppConfig();
$appConfig->setValue('core', 'installedat', microtime(true));
$appConfig->setValue('core', 'lastupdatedat', microtime(true));
2012-10-27 00:46:12 +04:00
OC_Group::createGroup('admin');
OC_Group::addToGroup($username, 'admin');
OC_User::login($username, $password);
2012-10-27 00:46:12 +04:00
//guess what this does
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
file_put_contents(OC_Config::getValue('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();
}
//and we are done
OC_Config::setValue('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() {
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());
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?');
}
2014-02-28 16:32:09 +04:00
$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', '');
}
2011-04-17 02:45:05 +04:00
}