nextcloud / server

lib/private/Setup/AbstractDatabase.php

Indentation +104 added lines, -104 removed lines

@@ -38,118 +38,118 @@
 
 abstract class AbstractDatabase {
 
-	/** @var IL10N */
-	protected $trans;
-	/** @var string */
-	protected $dbUser;
-	/** @var string */
-	protected $dbPassword;
-	/** @var string */
-	protected $dbName;
-	/** @var string */
-	protected $dbHost;
-	/** @var string */
-	protected $dbPort;
-	/** @var string */
-	protected $tablePrefix;
-	/** @var SystemConfig */
-	protected $config;
-	/** @var ILogger */
-	protected $logger;
-	/** @var ISecureRandom */
-	protected $random;
+    /** @var IL10N */
+    protected $trans;
+    /** @var string */
+    protected $dbUser;
+    /** @var string */
+    protected $dbPassword;
+    /** @var string */
+    protected $dbName;
+    /** @var string */
+    protected $dbHost;
+    /** @var string */
+    protected $dbPort;
+    /** @var string */
+    protected $tablePrefix;
+    /** @var SystemConfig */
+    protected $config;
+    /** @var ILogger */
+    protected $logger;
+    /** @var ISecureRandom */
+    protected $random;
 
-	public function __construct(IL10N $trans, SystemConfig $config, ILogger $logger, ISecureRandom $random) {
-		$this->trans = $trans;
-		$this->config = $config;
-		$this->logger = $logger;
-		$this->random = $random;
-	}
+    public function __construct(IL10N $trans, SystemConfig $config, ILogger $logger, ISecureRandom $random) {
+        $this->trans = $trans;
+        $this->config = $config;
+        $this->logger = $logger;
+        $this->random = $random;
+    }
 
-	public function validate($config) {
-		$errors = [];
-		if (empty($config['dbuser']) && empty($config['dbname'])) {
-			$errors[] = $this->trans->t("%s enter the database username and name.", [$this->dbprettyname]);
-		} elseif (empty($config['dbuser'])) {
-			$errors[] = $this->trans->t("%s enter the database username.", [$this->dbprettyname]);
-		} elseif (empty($config['dbname'])) {
-			$errors[] = $this->trans->t("%s enter the database name.", [$this->dbprettyname]);
-		}
-		if (substr_count($config['dbname'], '.') >= 1) {
-			$errors[] = $this->trans->t("%s you may not use dots in the database name", [$this->dbprettyname]);
-		}
-		return $errors;
-	}
+    public function validate($config) {
+        $errors = [];
+        if (empty($config['dbuser']) && empty($config['dbname'])) {
+            $errors[] = $this->trans->t("%s enter the database username and name.", [$this->dbprettyname]);
+        } elseif (empty($config['dbuser'])) {
+            $errors[] = $this->trans->t("%s enter the database username.", [$this->dbprettyname]);
+        } elseif (empty($config['dbname'])) {
+            $errors[] = $this->trans->t("%s enter the database name.", [$this->dbprettyname]);
+        }
+        if (substr_count($config['dbname'], '.') >= 1) {
+            $errors[] = $this->trans->t("%s you may not use dots in the database name", [$this->dbprettyname]);
+        }
+        return $errors;
+    }
 
-	public function initialize($config) {
-		$dbUser = $config['dbuser'];
-		$dbPass = $config['dbpass'];
-		$dbName = $config['dbname'];
-		$dbHost = !empty($config['dbhost']) ? $config['dbhost'] : 'localhost';
-		$dbPort = !empty($config['dbport']) ? $config['dbport'] : '';
-		$dbTablePrefix = isset($config['dbtableprefix']) ? $config['dbtableprefix'] : 'oc_';
+    public function initialize($config) {
+        $dbUser = $config['dbuser'];
+        $dbPass = $config['dbpass'];
+        $dbName = $config['dbname'];
+        $dbHost = !empty($config['dbhost']) ? $config['dbhost'] : 'localhost';
+        $dbPort = !empty($config['dbport']) ? $config['dbport'] : '';
+        $dbTablePrefix = isset($config['dbtableprefix']) ? $config['dbtableprefix'] : 'oc_';
 
-		$this->config->setValues([
-			'dbname' => $dbName,
-			'dbhost' => $dbHost,
-			'dbport' => $dbPort,
-			'dbtableprefix' => $dbTablePrefix,
-		]);
+        $this->config->setValues([
+            'dbname' => $dbName,
+            'dbhost' => $dbHost,
+            'dbport' => $dbPort,
+            'dbtableprefix' => $dbTablePrefix,
+        ]);
 
-		$this->dbUser = $dbUser;
-		$this->dbPassword = $dbPass;
-		$this->dbName = $dbName;
-		$this->dbHost = $dbHost;
-		$this->dbPort = $dbPort;
-		$this->tablePrefix = $dbTablePrefix;
-	}
+        $this->dbUser = $dbUser;
+        $this->dbPassword = $dbPass;
+        $this->dbName = $dbName;
+        $this->dbHost = $dbHost;
+        $this->dbPort = $dbPort;
+        $this->tablePrefix = $dbTablePrefix;
+    }
 
-	/**
-	 * @param array $configOverwrite
-	 * @return \OC\DB\Connection
-	 */
-	protected function connect(array $configOverwrite = []) {
-		$connectionParams = [
-			'host' => $this->dbHost,
-			'user' => $this->dbUser,
-			'password' => $this->dbPassword,
-			'tablePrefix' => $this->tablePrefix,
-			'dbname' => $this->dbName
-		];
+    /**
+     * @param array $configOverwrite
+     * @return \OC\DB\Connection
+     */
+    protected function connect(array $configOverwrite = []) {
+        $connectionParams = [
+            'host' => $this->dbHost,
+            'user' => $this->dbUser,
+            'password' => $this->dbPassword,
+            'tablePrefix' => $this->tablePrefix,
+            'dbname' => $this->dbName
+        ];
 
-		// adding port support through installer
-		if (!empty($this->dbPort)) {
-			if (ctype_digit($this->dbPort)) {
-				$connectionParams['port'] = $this->dbPort;
-			} else {
-				$connectionParams['unix_socket'] = $this->dbPort;
-			}
-		} elseif (strpos($this->dbHost, ':')) {
-			// Host variable may carry a port or socket.
-			list($host, $portOrSocket) = explode(':', $this->dbHost, 2);
-			if (ctype_digit($portOrSocket)) {
-				$connectionParams['port'] = $portOrSocket;
-			} else {
-				$connectionParams['unix_socket'] = $portOrSocket;
-			}
-			$connectionParams['host'] = $host;
-		}
+        // adding port support through installer
+        if (!empty($this->dbPort)) {
+            if (ctype_digit($this->dbPort)) {
+                $connectionParams['port'] = $this->dbPort;
+            } else {
+                $connectionParams['unix_socket'] = $this->dbPort;
+            }
+        } elseif (strpos($this->dbHost, ':')) {
+            // Host variable may carry a port or socket.
+            list($host, $portOrSocket) = explode(':', $this->dbHost, 2);
+            if (ctype_digit($portOrSocket)) {
+                $connectionParams['port'] = $portOrSocket;
+            } else {
+                $connectionParams['unix_socket'] = $portOrSocket;
+            }
+            $connectionParams['host'] = $host;
+        }
 
-		$connectionParams = array_merge($connectionParams, $configOverwrite);
-		$cf = new ConnectionFactory($this->config);
-		return $cf->getConnection($this->config->getValue('dbtype', 'sqlite'), $connectionParams);
-	}
+        $connectionParams = array_merge($connectionParams, $configOverwrite);
+        $cf = new ConnectionFactory($this->config);
+        return $cf->getConnection($this->config->getValue('dbtype', 'sqlite'), $connectionParams);
+    }
 
-	/**
-	 * @param string $userName
-	 */
-	abstract public function setupDatabase($userName);
+    /**
+     * @param string $userName
+     */
+    abstract public function setupDatabase($userName);
 
-	public function runMigrations() {
-		if (!is_dir(\OC::$SERVERROOT."/core/Migrations")) {
-			return;
-		}
-		$ms = new MigrationService('core', \OC::$server->getDatabaseConnection());
-		$ms->migrate('latest', true);
-	}
+    public function runMigrations() {
+        if (!is_dir(\OC::$SERVERROOT."/core/Migrations")) {
+            return;
+        }
+        $ms = new MigrationService('core', \OC::$server->getDatabaseConnection());
+        $ms->migrate('latest', true);
+    }
 }

lib/private/DB/MigrationService.php

Indentation +573 added lines, -573 removed lines

@@ -46,577 +46,577 @@
 
 class MigrationService {
 
-	/** @var boolean */
-	private $migrationTableCreated;
-	/** @var array */
-	private $migrations;
-	/** @var IOutput */
-	private $output;
-	/** @var Connection */
-	private $connection;
-	/** @var string */
-	private $appName;
-	/** @var bool */
-	private $checkOracle;
-
-	/**
-	 * MigrationService constructor.
-	 *
-	 * @param $appName
-	 * @param IDBConnection $connection
-	 * @param AppLocator $appLocator
-	 * @param IOutput|null $output
-	 * @throws \Exception
-	 */
-	public function __construct($appName, IDBConnection $connection, IOutput $output = null, AppLocator $appLocator = null) {
-		$this->appName = $appName;
-		$this->connection = $connection;
-		$this->output = $output;
-		if (null === $this->output) {
-			$this->output = new SimpleOutput(\OC::$server->getLogger(), $appName);
-		}
-
-		if ($appName === 'core') {
-			$this->migrationsPath = \OC::$SERVERROOT . '/core/Migrations';
-			$this->migrationsNamespace = 'OC\\Core\\Migrations';
-			$this->checkOracle = true;
-		} else {
-			if (null === $appLocator) {
-				$appLocator = new AppLocator();
-			}
-			$appPath = $appLocator->getAppPath($appName);
-			$namespace = App::buildAppNamespace($appName);
-			$this->migrationsPath = "$appPath/lib/Migration";
-			$this->migrationsNamespace = $namespace . '\\Migration';
-
-			$infoParser = new InfoParser();
-			$info = $infoParser->parse($appPath . '/appinfo/info.xml');
-			if (!isset($info['dependencies']['database'])) {
-				$this->checkOracle = true;
-			} else {
-				$this->checkOracle = false;
-				foreach ($info['dependencies']['database'] as $database) {
-					if (\is_string($database) && $database === 'oci') {
-						$this->checkOracle = true;
-					} elseif (\is_array($database) && isset($database['@value']) && $database['@value'] === 'oci') {
-						$this->checkOracle = true;
-					}
-				}
-			}
-		}
-	}
-
-	/**
-	 * Returns the name of the app for which this migration is executed
-	 *
-	 * @return string
-	 */
-	public function getApp() {
-		return $this->appName;
-	}
-
-	/**
-	 * @return bool
-	 * @codeCoverageIgnore - this will implicitly tested on installation
-	 */
-	private function createMigrationTable() {
-		if ($this->migrationTableCreated) {
-			return false;
-		}
-
-		if ($this->connection->tableExists('migrations')) {
-			$this->migrationTableCreated = true;
-			return false;
-		}
-
-		$schema = new SchemaWrapper($this->connection);
-
-		/**
-		 * We drop the table when it has different columns or the definition does not
-		 * match. E.g. ownCloud uses a length of 177 for app and 14 for version.
-		 */
-		try {
-			$table = $schema->getTable('migrations');
-			$columns = $table->getColumns();
-
-			if (count($columns) === 2) {
-				try {
-					$column = $table->getColumn('app');
-					$schemaMismatch = $column->getLength() !== 255;
-
-					if (!$schemaMismatch) {
-						$column = $table->getColumn('version');
-						$schemaMismatch = $column->getLength() !== 255;
-					}
-				} catch (SchemaException $e) {
-					// One of the columns is missing
-					$schemaMismatch = true;
-				}
-
-				if (!$schemaMismatch) {
-					// Table exists and schema matches: return back!
-					$this->migrationTableCreated = true;
-					return false;
-				}
-			}
-
-			// Drop the table, when it didn't match our expectations.
-			$this->connection->dropTable('migrations');
-
-			// Recreate the schema after the table was dropped.
-			$schema = new SchemaWrapper($this->connection);
-		} catch (SchemaException $e) {
-			// Table not found, no need to panic, we will create it.
-		}
-
-		$table = $schema->createTable('migrations');
-		$table->addColumn('app', Types::STRING, ['length' => 255]);
-		$table->addColumn('version', Types::STRING, ['length' => 255]);
-		$table->setPrimaryKey(['app', 'version']);
-
-		$this->connection->migrateToSchema($schema->getWrappedSchema());
-
-		$this->migrationTableCreated = true;
-
-		return true;
-	}
-
-	/**
-	 * Returns all versions which have already been applied
-	 *
-	 * @return string[]
-	 * @codeCoverageIgnore - no need to test this
-	 */
-	public function getMigratedVersions() {
-		$this->createMigrationTable();
-		$qb = $this->connection->getQueryBuilder();
-
-		$qb->select('version')
-			->from('migrations')
-			->where($qb->expr()->eq('app', $qb->createNamedParameter($this->getApp())))
-			->orderBy('version');
-
-		$result = $qb->execute();
-		$rows = $result->fetchAll(\PDO::FETCH_COLUMN);
-		$result->closeCursor();
-
-		return $rows;
-	}
-
-	/**
-	 * Returns all versions which are available in the migration folder
-	 *
-	 * @return array
-	 */
-	public function getAvailableVersions() {
-		$this->ensureMigrationsAreLoaded();
-		return array_map('strval', array_keys($this->migrations));
-	}
-
-	protected function findMigrations() {
-		$directory = realpath($this->migrationsPath);
-		if ($directory === false || !file_exists($directory) || !is_dir($directory)) {
-			return [];
-		}
-
-		$iterator = new \RegexIterator(
-			new \RecursiveIteratorIterator(
-				new \RecursiveDirectoryIterator($directory, \FilesystemIterator::SKIP_DOTS),
-				\RecursiveIteratorIterator::LEAVES_ONLY
-			),
-			'#^.+\\/Version[^\\/]{1,255}\\.php$#i',
-			\RegexIterator::GET_MATCH);
-
-		$files = array_keys(iterator_to_array($iterator));
-		uasort($files, function ($a, $b) {
-			preg_match('/^Version(\d+)Date(\d+)\\.php$/', basename($a), $matchA);
-			preg_match('/^Version(\d+)Date(\d+)\\.php$/', basename($b), $matchB);
-			if (!empty($matchA) && !empty($matchB)) {
-				if ($matchA[1] !== $matchB[1]) {
-					return ($matchA[1] < $matchB[1]) ? -1 : 1;
-				}
-				return ($matchA[2] < $matchB[2]) ? -1 : 1;
-			}
-			return (basename($a) < basename($b)) ? -1 : 1;
-		});
-
-		$migrations = [];
-
-		foreach ($files as $file) {
-			$className = basename($file, '.php');
-			$version = (string) substr($className, 7);
-			if ($version === '0') {
-				throw new \InvalidArgumentException(
-					"Cannot load a migrations with the name '$version' because it is a reserved number"
-				);
-			}
-			$migrations[$version] = sprintf('%s\\%s', $this->migrationsNamespace, $className);
-		}
-
-		return $migrations;
-	}
-
-	/**
-	 * @param string $to
-	 * @return string[]
-	 */
-	private function getMigrationsToExecute($to) {
-		$knownMigrations = $this->getMigratedVersions();
-		$availableMigrations = $this->getAvailableVersions();
-
-		$toBeExecuted = [];
-		foreach ($availableMigrations as $v) {
-			if ($to !== 'latest' && $v > $to) {
-				continue;
-			}
-			if ($this->shallBeExecuted($v, $knownMigrations)) {
-				$toBeExecuted[] = $v;
-			}
-		}
-
-		return $toBeExecuted;
-	}
-
-	/**
-	 * @param string $m
-	 * @param string[] $knownMigrations
-	 * @return bool
-	 */
-	private function shallBeExecuted($m, $knownMigrations) {
-		if (in_array($m, $knownMigrations)) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * @param string $version
-	 */
-	private function markAsExecuted($version) {
-		$this->connection->insertIfNotExist('*PREFIX*migrations', [
-			'app' => $this->appName,
-			'version' => $version
-		]);
-	}
-
-	/**
-	 * Returns the name of the table which holds the already applied versions
-	 *
-	 * @return string
-	 */
-	public function getMigrationsTableName() {
-		return $this->connection->getPrefix() . 'migrations';
-	}
-
-	/**
-	 * Returns the namespace of the version classes
-	 *
-	 * @return string
-	 */
-	public function getMigrationsNamespace() {
-		return $this->migrationsNamespace;
-	}
-
-	/**
-	 * Returns the directory which holds the versions
-	 *
-	 * @return string
-	 */
-	public function getMigrationsDirectory() {
-		return $this->migrationsPath;
-	}
-
-	/**
-	 * Return the explicit version for the aliases; current, next, prev, latest
-	 *
-	 * @param string $alias
-	 * @return mixed|null|string
-	 */
-	public function getMigration($alias) {
-		switch ($alias) {
-			case 'current':
-				return $this->getCurrentVersion();
-			case 'next':
-				return $this->getRelativeVersion($this->getCurrentVersion(), 1);
-			case 'prev':
-				return $this->getRelativeVersion($this->getCurrentVersion(), -1);
-			case 'latest':
-				$this->ensureMigrationsAreLoaded();
-
-				$migrations = $this->getAvailableVersions();
-				return @end($migrations);
-		}
-		return '0';
-	}
-
-	/**
-	 * @param string $version
-	 * @param int $delta
-	 * @return null|string
-	 */
-	private function getRelativeVersion($version, $delta) {
-		$this->ensureMigrationsAreLoaded();
-
-		$versions = $this->getAvailableVersions();
-		array_unshift($versions, 0);
-		$offset = array_search($version, $versions, true);
-		if ($offset === false || !isset($versions[$offset + $delta])) {
-			// Unknown version or delta out of bounds.
-			return null;
-		}
-
-		return (string) $versions[$offset + $delta];
-	}
-
-	/**
-	 * @return string
-	 */
-	private function getCurrentVersion() {
-		$m = $this->getMigratedVersions();
-		if (count($m) === 0) {
-			return '0';
-		}
-		$migrations = array_values($m);
-		return @end($migrations);
-	}
-
-	/**
-	 * @param string $version
-	 * @return string
-	 * @throws \InvalidArgumentException
-	 */
-	private function getClass($version) {
-		$this->ensureMigrationsAreLoaded();
-
-		if (isset($this->migrations[$version])) {
-			return $this->migrations[$version];
-		}
-
-		throw new \InvalidArgumentException("Version $version is unknown.");
-	}
-
-	/**
-	 * Allows to set an IOutput implementation which is used for logging progress and messages
-	 *
-	 * @param IOutput $output
-	 */
-	public function setOutput(IOutput $output) {
-		$this->output = $output;
-	}
-
-	/**
-	 * Applies all not yet applied versions up to $to
-	 *
-	 * @param string $to
-	 * @param bool $schemaOnly
-	 * @throws \InvalidArgumentException
-	 */
-	public function migrate($to = 'latest', $schemaOnly = false) {
-		if ($schemaOnly) {
-			$this->migrateSchemaOnly($to);
-			return;
-		}
-
-		// read known migrations
-		$toBeExecuted = $this->getMigrationsToExecute($to);
-		foreach ($toBeExecuted as $version) {
-			$this->executeStep($version, $schemaOnly);
-		}
-	}
-
-	/**
-	 * Applies all not yet applied versions up to $to
-	 *
-	 * @param string $to
-	 * @throws \InvalidArgumentException
-	 */
-	public function migrateSchemaOnly($to = 'latest') {
-		// read known migrations
-		$toBeExecuted = $this->getMigrationsToExecute($to);
-
-		if (empty($toBeExecuted)) {
-			return;
-		}
-
-		$toSchema = null;
-		foreach ($toBeExecuted as $version) {
-			$instance = $this->createInstance($version);
-
-			$toSchema = $instance->changeSchema($this->output, function () use ($toSchema) {
-				return $toSchema ?: new SchemaWrapper($this->connection);
-			}, ['tablePrefix' => $this->connection->getPrefix()]) ?: $toSchema;
-
-			$this->markAsExecuted($version);
-		}
-
-		if ($toSchema instanceof SchemaWrapper) {
-			$targetSchema = $toSchema->getWrappedSchema();
-			if ($this->checkOracle) {
-				$beforeSchema = $this->connection->createSchema();
-				$this->ensureOracleIdentifierLengthLimit($beforeSchema, $targetSchema, strlen($this->connection->getPrefix()));
-			}
-			$this->connection->migrateToSchema($targetSchema);
-			$toSchema->performDropTableCalls();
-		}
-	}
-
-	/**
-	 * Get the human readable descriptions for the migration steps to run
-	 *
-	 * @param string $to
-	 * @return string[] [$name => $description]
-	 */
-	public function describeMigrationStep($to = 'latest') {
-		$toBeExecuted = $this->getMigrationsToExecute($to);
-		$description = [];
-		foreach ($toBeExecuted as $version) {
-			$migration = $this->createInstance($version);
-			if ($migration->name()) {
-				$description[$migration->name()] = $migration->description();
-			}
-		}
-		return $description;
-	}
-
-	/**
-	 * @param string $version
-	 * @return IMigrationStep
-	 * @throws \InvalidArgumentException
-	 */
-	protected function createInstance($version) {
-		$class = $this->getClass($version);
-		try {
-			$s = \OC::$server->query($class);
-
-			if (!$s instanceof IMigrationStep) {
-				throw new \InvalidArgumentException('Not a valid migration');
-			}
-		} catch (QueryException $e) {
-			if (class_exists($class)) {
-				$s = new $class();
-			} else {
-				throw new \InvalidArgumentException("Migration step '$class' is unknown");
-			}
-		}
-
-		return $s;
-	}
-
-	/**
-	 * Executes one explicit version
-	 *
-	 * @param string $version
-	 * @param bool $schemaOnly
-	 * @throws \InvalidArgumentException
-	 */
-	public function executeStep($version, $schemaOnly = false) {
-		$instance = $this->createInstance($version);
-
-		if (!$schemaOnly) {
-			$instance->preSchemaChange($this->output, function () {
-				return new SchemaWrapper($this->connection);
-			}, ['tablePrefix' => $this->connection->getPrefix()]);
-		}
-
-		$toSchema = $instance->changeSchema($this->output, function () {
-			return new SchemaWrapper($this->connection);
-		}, ['tablePrefix' => $this->connection->getPrefix()]);
-
-		if ($toSchema instanceof SchemaWrapper) {
-			$targetSchema = $toSchema->getWrappedSchema();
-			if ($this->checkOracle) {
-				$sourceSchema = $this->connection->createSchema();
-				$this->ensureOracleIdentifierLengthLimit($sourceSchema, $targetSchema, strlen($this->connection->getPrefix()));
-			}
-			$this->connection->migrateToSchema($targetSchema);
-			$toSchema->performDropTableCalls();
-		}
-
-		if (!$schemaOnly) {
-			$instance->postSchemaChange($this->output, function () {
-				return new SchemaWrapper($this->connection);
-			}, ['tablePrefix' => $this->connection->getPrefix()]);
-		}
-
-		$this->markAsExecuted($version);
-	}
-
-	public function ensureOracleIdentifierLengthLimit(Schema $sourceSchema, Schema $targetSchema, int $prefixLength) {
-		$sequences = $targetSchema->getSequences();
-
-		foreach ($targetSchema->getTables() as $table) {
-			try {
-				$sourceTable = $sourceSchema->getTable($table->getName());
-			} catch (SchemaException $e) {
-				if (\strlen($table->getName()) - $prefixLength > 27) {
-					throw new \InvalidArgumentException('Table name "'  . $table->getName() . '" is too long.');
-				}
-				$sourceTable = null;
-			}
-
-			foreach ($table->getColumns() as $thing) {
-				if ((!$sourceTable instanceof Table || !$sourceTable->hasColumn($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Column name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
-				}
-
-				if ($thing->getNotnull() && $thing->getDefault() === ''
-					&& $sourceTable instanceof Table && !$sourceTable->hasColumn($thing->getName())) {
-					throw new \InvalidArgumentException('Column name "'  . $table->getName() . '"."' . $thing->getName() . '" is NotNull, but has empty string or null as default.');
-				}
-			}
-
-			foreach ($table->getIndexes() as $thing) {
-				if ((!$sourceTable instanceof Table || !$sourceTable->hasIndex($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Index name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
-				}
-			}
-
-			foreach ($table->getForeignKeys() as $thing) {
-				if ((!$sourceTable instanceof Table || !$sourceTable->hasForeignKey($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Foreign key name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
-				}
-			}
-
-			$primaryKey = $table->getPrimaryKey();
-			if ($primaryKey instanceof Index && (!$sourceTable instanceof Table || !$sourceTable->hasPrimaryKey())) {
-				$indexName = strtolower($primaryKey->getName());
-				$isUsingDefaultName = $indexName === 'primary';
-
-				if ($this->connection->getDatabasePlatform() instanceof PostgreSqlPlatform) {
-					$defaultName = $table->getName() . '_pkey';
-					$isUsingDefaultName = strtolower($defaultName) === $indexName;
-
-					if ($isUsingDefaultName) {
-						$sequenceName = $table->getName() . '_' . implode('_', $primaryKey->getColumns()) . '_seq';
-						$sequences = array_filter($sequences, function (Sequence $sequence) use ($sequenceName) {
-							return $sequence->getName() !== $sequenceName;
-						});
-					}
-				} elseif ($this->connection->getDatabasePlatform() instanceof OraclePlatform) {
-					$defaultName = $table->getName() . '_seq';
-					$isUsingDefaultName = strtolower($defaultName) === $indexName;
-				}
-
-				if (!$isUsingDefaultName && \strlen($indexName) > 30) {
-					throw new \InvalidArgumentException('Primary index name  on "'  . $table->getName() . '" is too long.');
-				}
-				if ($isUsingDefaultName && \strlen($table->getName()) - $prefixLength >= 23) {
-					throw new \InvalidArgumentException('Primary index name  on "'  . $table->getName() . '" is too long.');
-				}
-			}
-		}
-
-		foreach ($sequences as $sequence) {
-			if (!$sourceSchema->hasSequence($sequence->getName()) && \strlen($sequence->getName()) > 30) {
-				throw new \InvalidArgumentException('Sequence name "'  . $sequence->getName() . '" is too long.');
-			}
-		}
-	}
-
-	private function ensureMigrationsAreLoaded() {
-		if (empty($this->migrations)) {
-			$this->migrations = $this->findMigrations();
-		}
-	}
+    /** @var boolean */
+    private $migrationTableCreated;
+    /** @var array */
+    private $migrations;
+    /** @var IOutput */
+    private $output;
+    /** @var Connection */
+    private $connection;
+    /** @var string */
+    private $appName;
+    /** @var bool */
+    private $checkOracle;
+
+    /**
+     * MigrationService constructor.
+     *
+     * @param $appName
+     * @param IDBConnection $connection
+     * @param AppLocator $appLocator
+     * @param IOutput|null $output
+     * @throws \Exception
+     */
+    public function __construct($appName, IDBConnection $connection, IOutput $output = null, AppLocator $appLocator = null) {
+        $this->appName = $appName;
+        $this->connection = $connection;
+        $this->output = $output;
+        if (null === $this->output) {
+            $this->output = new SimpleOutput(\OC::$server->getLogger(), $appName);
+        }
+
+        if ($appName === 'core') {
+            $this->migrationsPath = \OC::$SERVERROOT . '/core/Migrations';
+            $this->migrationsNamespace = 'OC\\Core\\Migrations';
+            $this->checkOracle = true;
+        } else {
+            if (null === $appLocator) {
+                $appLocator = new AppLocator();
+            }
+            $appPath = $appLocator->getAppPath($appName);
+            $namespace = App::buildAppNamespace($appName);
+            $this->migrationsPath = "$appPath/lib/Migration";
+            $this->migrationsNamespace = $namespace . '\\Migration';
+
+            $infoParser = new InfoParser();
+            $info = $infoParser->parse($appPath . '/appinfo/info.xml');
+            if (!isset($info['dependencies']['database'])) {
+                $this->checkOracle = true;
+            } else {
+                $this->checkOracle = false;
+                foreach ($info['dependencies']['database'] as $database) {
+                    if (\is_string($database) && $database === 'oci') {
+                        $this->checkOracle = true;
+                    } elseif (\is_array($database) && isset($database['@value']) && $database['@value'] === 'oci') {
+                        $this->checkOracle = true;
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Returns the name of the app for which this migration is executed
+     *
+     * @return string
+     */
+    public function getApp() {
+        return $this->appName;
+    }
+
+    /**
+     * @return bool
+     * @codeCoverageIgnore - this will implicitly tested on installation
+     */
+    private function createMigrationTable() {
+        if ($this->migrationTableCreated) {
+            return false;
+        }
+
+        if ($this->connection->tableExists('migrations')) {
+            $this->migrationTableCreated = true;
+            return false;
+        }
+
+        $schema = new SchemaWrapper($this->connection);
+
+        /**
+         * We drop the table when it has different columns or the definition does not
+         * match. E.g. ownCloud uses a length of 177 for app and 14 for version.
+         */
+        try {
+            $table = $schema->getTable('migrations');
+            $columns = $table->getColumns();
+
+            if (count($columns) === 2) {
+                try {
+                    $column = $table->getColumn('app');
+                    $schemaMismatch = $column->getLength() !== 255;
+
+                    if (!$schemaMismatch) {
+                        $column = $table->getColumn('version');
+                        $schemaMismatch = $column->getLength() !== 255;
+                    }
+                } catch (SchemaException $e) {
+                    // One of the columns is missing
+                    $schemaMismatch = true;
+                }
+
+                if (!$schemaMismatch) {
+                    // Table exists and schema matches: return back!
+                    $this->migrationTableCreated = true;
+                    return false;
+                }
+            }
+
+            // Drop the table, when it didn't match our expectations.
+            $this->connection->dropTable('migrations');
+
+            // Recreate the schema after the table was dropped.
+            $schema = new SchemaWrapper($this->connection);
+        } catch (SchemaException $e) {
+            // Table not found, no need to panic, we will create it.
+        }
+
+        $table = $schema->createTable('migrations');
+        $table->addColumn('app', Types::STRING, ['length' => 255]);
+        $table->addColumn('version', Types::STRING, ['length' => 255]);
+        $table->setPrimaryKey(['app', 'version']);
+
+        $this->connection->migrateToSchema($schema->getWrappedSchema());
+
+        $this->migrationTableCreated = true;
+
+        return true;
+    }
+
+    /**
+     * Returns all versions which have already been applied
+     *
+     * @return string[]
+     * @codeCoverageIgnore - no need to test this
+     */
+    public function getMigratedVersions() {
+        $this->createMigrationTable();
+        $qb = $this->connection->getQueryBuilder();
+
+        $qb->select('version')
+            ->from('migrations')
+            ->where($qb->expr()->eq('app', $qb->createNamedParameter($this->getApp())))
+            ->orderBy('version');
+
+        $result = $qb->execute();
+        $rows = $result->fetchAll(\PDO::FETCH_COLUMN);
+        $result->closeCursor();
+
+        return $rows;
+    }
+
+    /**
+     * Returns all versions which are available in the migration folder
+     *
+     * @return array
+     */
+    public function getAvailableVersions() {
+        $this->ensureMigrationsAreLoaded();
+        return array_map('strval', array_keys($this->migrations));
+    }
+
+    protected function findMigrations() {
+        $directory = realpath($this->migrationsPath);
+        if ($directory === false || !file_exists($directory) || !is_dir($directory)) {
+            return [];
+        }
+
+        $iterator = new \RegexIterator(
+            new \RecursiveIteratorIterator(
+                new \RecursiveDirectoryIterator($directory, \FilesystemIterator::SKIP_DOTS),
+                \RecursiveIteratorIterator::LEAVES_ONLY
+            ),
+            '#^.+\\/Version[^\\/]{1,255}\\.php$#i',
+            \RegexIterator::GET_MATCH);
+
+        $files = array_keys(iterator_to_array($iterator));
+        uasort($files, function ($a, $b) {
+            preg_match('/^Version(\d+)Date(\d+)\\.php$/', basename($a), $matchA);
+            preg_match('/^Version(\d+)Date(\d+)\\.php$/', basename($b), $matchB);
+            if (!empty($matchA) && !empty($matchB)) {
+                if ($matchA[1] !== $matchB[1]) {
+                    return ($matchA[1] < $matchB[1]) ? -1 : 1;
+                }
+                return ($matchA[2] < $matchB[2]) ? -1 : 1;
+            }
+            return (basename($a) < basename($b)) ? -1 : 1;
+        });
+
+        $migrations = [];
+
+        foreach ($files as $file) {
+            $className = basename($file, '.php');
+            $version = (string) substr($className, 7);
+            if ($version === '0') {
+                throw new \InvalidArgumentException(
+                    "Cannot load a migrations with the name '$version' because it is a reserved number"
+                );
+            }
+            $migrations[$version] = sprintf('%s\\%s', $this->migrationsNamespace, $className);
+        }
+
+        return $migrations;
+    }
+
+    /**
+     * @param string $to
+     * @return string[]
+     */
+    private function getMigrationsToExecute($to) {
+        $knownMigrations = $this->getMigratedVersions();
+        $availableMigrations = $this->getAvailableVersions();
+
+        $toBeExecuted = [];
+        foreach ($availableMigrations as $v) {
+            if ($to !== 'latest' && $v > $to) {
+                continue;
+            }
+            if ($this->shallBeExecuted($v, $knownMigrations)) {
+                $toBeExecuted[] = $v;
+            }
+        }
+
+        return $toBeExecuted;
+    }
+
+    /**
+     * @param string $m
+     * @param string[] $knownMigrations
+     * @return bool
+     */
+    private function shallBeExecuted($m, $knownMigrations) {
+        if (in_array($m, $knownMigrations)) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * @param string $version
+     */
+    private function markAsExecuted($version) {
+        $this->connection->insertIfNotExist('*PREFIX*migrations', [
+            'app' => $this->appName,
+            'version' => $version
+        ]);
+    }
+
+    /**
+     * Returns the name of the table which holds the already applied versions
+     *
+     * @return string
+     */
+    public function getMigrationsTableName() {
+        return $this->connection->getPrefix() . 'migrations';
+    }
+
+    /**
+     * Returns the namespace of the version classes
+     *
+     * @return string
+     */
+    public function getMigrationsNamespace() {
+        return $this->migrationsNamespace;
+    }
+
+    /**
+     * Returns the directory which holds the versions
+     *
+     * @return string
+     */
+    public function getMigrationsDirectory() {
+        return $this->migrationsPath;
+    }
+
+    /**
+     * Return the explicit version for the aliases; current, next, prev, latest
+     *
+     * @param string $alias
+     * @return mixed|null|string
+     */
+    public function getMigration($alias) {
+        switch ($alias) {
+            case 'current':
+                return $this->getCurrentVersion();
+            case 'next':
+                return $this->getRelativeVersion($this->getCurrentVersion(), 1);
+            case 'prev':
+                return $this->getRelativeVersion($this->getCurrentVersion(), -1);
+            case 'latest':
+                $this->ensureMigrationsAreLoaded();
+
+                $migrations = $this->getAvailableVersions();
+                return @end($migrations);
+        }
+        return '0';
+    }
+
+    /**
+     * @param string $version
+     * @param int $delta
+     * @return null|string
+     */
+    private function getRelativeVersion($version, $delta) {
+        $this->ensureMigrationsAreLoaded();
+
+        $versions = $this->getAvailableVersions();
+        array_unshift($versions, 0);
+        $offset = array_search($version, $versions, true);
+        if ($offset === false || !isset($versions[$offset + $delta])) {
+            // Unknown version or delta out of bounds.
+            return null;
+        }
+
+        return (string) $versions[$offset + $delta];
+    }
+
+    /**
+     * @return string
+     */
+    private function getCurrentVersion() {
+        $m = $this->getMigratedVersions();
+        if (count($m) === 0) {
+            return '0';
+        }
+        $migrations = array_values($m);
+        return @end($migrations);
+    }
+
+    /**
+     * @param string $version
+     * @return string
+     * @throws \InvalidArgumentException
+     */
+    private function getClass($version) {
+        $this->ensureMigrationsAreLoaded();
+
+        if (isset($this->migrations[$version])) {
+            return $this->migrations[$version];
+        }
+
+        throw new \InvalidArgumentException("Version $version is unknown.");
+    }
+
+    /**
+     * Allows to set an IOutput implementation which is used for logging progress and messages
+     *
+     * @param IOutput $output
+     */
+    public function setOutput(IOutput $output) {
+        $this->output = $output;
+    }
+
+    /**
+     * Applies all not yet applied versions up to $to
+     *
+     * @param string $to
+     * @param bool $schemaOnly
+     * @throws \InvalidArgumentException
+     */
+    public function migrate($to = 'latest', $schemaOnly = false) {
+        if ($schemaOnly) {
+            $this->migrateSchemaOnly($to);
+            return;
+        }
+
+        // read known migrations
+        $toBeExecuted = $this->getMigrationsToExecute($to);
+        foreach ($toBeExecuted as $version) {
+            $this->executeStep($version, $schemaOnly);
+        }
+    }
+
+    /**
+     * Applies all not yet applied versions up to $to
+     *
+     * @param string $to
+     * @throws \InvalidArgumentException
+     */
+    public function migrateSchemaOnly($to = 'latest') {
+        // read known migrations
+        $toBeExecuted = $this->getMigrationsToExecute($to);
+
+        if (empty($toBeExecuted)) {
+            return;
+        }
+
+        $toSchema = null;
+        foreach ($toBeExecuted as $version) {
+            $instance = $this->createInstance($version);
+
+            $toSchema = $instance->changeSchema($this->output, function () use ($toSchema) {
+                return $toSchema ?: new SchemaWrapper($this->connection);
+            }, ['tablePrefix' => $this->connection->getPrefix()]) ?: $toSchema;
+
+            $this->markAsExecuted($version);
+        }
+
+        if ($toSchema instanceof SchemaWrapper) {
+            $targetSchema = $toSchema->getWrappedSchema();
+            if ($this->checkOracle) {
+                $beforeSchema = $this->connection->createSchema();
+                $this->ensureOracleIdentifierLengthLimit($beforeSchema, $targetSchema, strlen($this->connection->getPrefix()));
+            }
+            $this->connection->migrateToSchema($targetSchema);
+            $toSchema->performDropTableCalls();
+        }
+    }
+
+    /**
+     * Get the human readable descriptions for the migration steps to run
+     *
+     * @param string $to
+     * @return string[] [$name => $description]
+     */
+    public function describeMigrationStep($to = 'latest') {
+        $toBeExecuted = $this->getMigrationsToExecute($to);
+        $description = [];
+        foreach ($toBeExecuted as $version) {
+            $migration = $this->createInstance($version);
+            if ($migration->name()) {
+                $description[$migration->name()] = $migration->description();
+            }
+        }
+        return $description;
+    }
+
+    /**
+     * @param string $version
+     * @return IMigrationStep
+     * @throws \InvalidArgumentException
+     */
+    protected function createInstance($version) {
+        $class = $this->getClass($version);
+        try {
+            $s = \OC::$server->query($class);
+
+            if (!$s instanceof IMigrationStep) {
+                throw new \InvalidArgumentException('Not a valid migration');
+            }
+        } catch (QueryException $e) {
+            if (class_exists($class)) {
+                $s = new $class();
+            } else {
+                throw new \InvalidArgumentException("Migration step '$class' is unknown");
+            }
+        }
+
+        return $s;
+    }
+
+    /**
+     * Executes one explicit version
+     *
+     * @param string $version
+     * @param bool $schemaOnly
+     * @throws \InvalidArgumentException
+     */
+    public function executeStep($version, $schemaOnly = false) {
+        $instance = $this->createInstance($version);
+
+        if (!$schemaOnly) {
+            $instance->preSchemaChange($this->output, function () {
+                return new SchemaWrapper($this->connection);
+            }, ['tablePrefix' => $this->connection->getPrefix()]);
+        }
+
+        $toSchema = $instance->changeSchema($this->output, function () {
+            return new SchemaWrapper($this->connection);
+        }, ['tablePrefix' => $this->connection->getPrefix()]);
+
+        if ($toSchema instanceof SchemaWrapper) {
+            $targetSchema = $toSchema->getWrappedSchema();
+            if ($this->checkOracle) {
+                $sourceSchema = $this->connection->createSchema();
+                $this->ensureOracleIdentifierLengthLimit($sourceSchema, $targetSchema, strlen($this->connection->getPrefix()));
+            }
+            $this->connection->migrateToSchema($targetSchema);
+            $toSchema->performDropTableCalls();
+        }
+
+        if (!$schemaOnly) {
+            $instance->postSchemaChange($this->output, function () {
+                return new SchemaWrapper($this->connection);
+            }, ['tablePrefix' => $this->connection->getPrefix()]);
+        }
+
+        $this->markAsExecuted($version);
+    }
+
+    public function ensureOracleIdentifierLengthLimit(Schema $sourceSchema, Schema $targetSchema, int $prefixLength) {
+        $sequences = $targetSchema->getSequences();
+
+        foreach ($targetSchema->getTables() as $table) {
+            try {
+                $sourceTable = $sourceSchema->getTable($table->getName());
+            } catch (SchemaException $e) {
+                if (\strlen($table->getName()) - $prefixLength > 27) {
+                    throw new \InvalidArgumentException('Table name "'  . $table->getName() . '" is too long.');
+                }
+                $sourceTable = null;
+            }
+
+            foreach ($table->getColumns() as $thing) {
+                if ((!$sourceTable instanceof Table || !$sourceTable->hasColumn($thing->getName())) && \strlen($thing->getName()) > 30) {
+                    throw new \InvalidArgumentException('Column name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+                }
+
+                if ($thing->getNotnull() && $thing->getDefault() === ''
+                    && $sourceTable instanceof Table && !$sourceTable->hasColumn($thing->getName())) {
+                    throw new \InvalidArgumentException('Column name "'  . $table->getName() . '"."' . $thing->getName() . '" is NotNull, but has empty string or null as default.');
+                }
+            }
+
+            foreach ($table->getIndexes() as $thing) {
+                if ((!$sourceTable instanceof Table || !$sourceTable->hasIndex($thing->getName())) && \strlen($thing->getName()) > 30) {
+                    throw new \InvalidArgumentException('Index name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+                }
+            }
+
+            foreach ($table->getForeignKeys() as $thing) {
+                if ((!$sourceTable instanceof Table || !$sourceTable->hasForeignKey($thing->getName())) && \strlen($thing->getName()) > 30) {
+                    throw new \InvalidArgumentException('Foreign key name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+                }
+            }
+
+            $primaryKey = $table->getPrimaryKey();
+            if ($primaryKey instanceof Index && (!$sourceTable instanceof Table || !$sourceTable->hasPrimaryKey())) {
+                $indexName = strtolower($primaryKey->getName());
+                $isUsingDefaultName = $indexName === 'primary';
+
+                if ($this->connection->getDatabasePlatform() instanceof PostgreSqlPlatform) {
+                    $defaultName = $table->getName() . '_pkey';
+                    $isUsingDefaultName = strtolower($defaultName) === $indexName;
+
+                    if ($isUsingDefaultName) {
+                        $sequenceName = $table->getName() . '_' . implode('_', $primaryKey->getColumns()) . '_seq';
+                        $sequences = array_filter($sequences, function (Sequence $sequence) use ($sequenceName) {
+                            return $sequence->getName() !== $sequenceName;
+                        });
+                    }
+                } elseif ($this->connection->getDatabasePlatform() instanceof OraclePlatform) {
+                    $defaultName = $table->getName() . '_seq';
+                    $isUsingDefaultName = strtolower($defaultName) === $indexName;
+                }
+
+                if (!$isUsingDefaultName && \strlen($indexName) > 30) {
+                    throw new \InvalidArgumentException('Primary index name  on "'  . $table->getName() . '" is too long.');
+                }
+                if ($isUsingDefaultName && \strlen($table->getName()) - $prefixLength >= 23) {
+                    throw new \InvalidArgumentException('Primary index name  on "'  . $table->getName() . '" is too long.');
+                }
+            }
+        }
+
+        foreach ($sequences as $sequence) {
+            if (!$sourceSchema->hasSequence($sequence->getName()) && \strlen($sequence->getName()) > 30) {
+                throw new \InvalidArgumentException('Sequence name "'  . $sequence->getName() . '" is too long.');
+            }
+        }
+    }
+
+    private function ensureMigrationsAreLoaded() {
+        if (empty($this->migrations)) {
+            $this->migrations = $this->findMigrations();
+        }
+    }
 }

Spacing +21 added lines, -21 removed lines

@@ -77,7 +77,7 @@ 
 		}
 
 		if ($appName === 'core') {
-			$this->migrationsPath = \OC::$SERVERROOT . '/core/Migrations';
+			$this->migrationsPath = \OC::$SERVERROOT.'/core/Migrations';
 			$this->migrationsNamespace = 'OC\\Core\\Migrations';
 			$this->checkOracle = true;
 		} else {
@@ -87,10 +87,10 @@ 
 			$appPath = $appLocator->getAppPath($appName);
 			$namespace = App::buildAppNamespace($appName);
 			$this->migrationsPath = "$appPath/lib/Migration";
-			$this->migrationsNamespace = $namespace . '\\Migration';
+			$this->migrationsNamespace = $namespace.'\\Migration';
 
 			$infoParser = new InfoParser();
-			$info = $infoParser->parse($appPath . '/appinfo/info.xml');
+			$info = $infoParser->parse($appPath.'/appinfo/info.xml');
 			if (!isset($info['dependencies']['database'])) {
 				$this->checkOracle = true;
 			} else {
@@ -228,7 +228,7 @@ 
 			\RegexIterator::GET_MATCH);
 
 		$files = array_keys(iterator_to_array($iterator));
-		uasort($files, function ($a, $b) {
+		uasort($files, function($a, $b) {
 			preg_match('/^Version(\d+)Date(\d+)\\.php$/', basename($a), $matchA);
 			preg_match('/^Version(\d+)Date(\d+)\\.php$/', basename($b), $matchB);
 			if (!empty($matchA) && !empty($matchB)) {
@@ -306,7 +306,7 @@ 
 	 * @return string
 	 */
 	public function getMigrationsTableName() {
-		return $this->connection->getPrefix() . 'migrations';
+		return $this->connection->getPrefix().'migrations';
 	}
 
 	/**
@@ -443,7 +443,7 @@ 
 		foreach ($toBeExecuted as $version) {
 			$instance = $this->createInstance($version);
 
-			$toSchema = $instance->changeSchema($this->output, function () use ($toSchema) {
+			$toSchema = $instance->changeSchema($this->output, function() use ($toSchema) {
 				return $toSchema ?: new SchemaWrapper($this->connection);
 			}, ['tablePrefix' => $this->connection->getPrefix()]) ?: $toSchema;
 
@@ -514,12 +514,12 @@ 
 		$instance = $this->createInstance($version);
 
 		if (!$schemaOnly) {
-			$instance->preSchemaChange($this->output, function () {
+			$instance->preSchemaChange($this->output, function() {
 				return new SchemaWrapper($this->connection);
 			}, ['tablePrefix' => $this->connection->getPrefix()]);
 		}
 
-		$toSchema = $instance->changeSchema($this->output, function () {
+		$toSchema = $instance->changeSchema($this->output, function() {
 			return new SchemaWrapper($this->connection);
 		}, ['tablePrefix' => $this->connection->getPrefix()]);
 
@@ -534,7 +534,7 @@ 
 		}
 
 		if (!$schemaOnly) {
-			$instance->postSchemaChange($this->output, function () {
+			$instance->postSchemaChange($this->output, function() {
 				return new SchemaWrapper($this->connection);
 			}, ['tablePrefix' => $this->connection->getPrefix()]);
 		}
@@ -550,31 +550,31 @@ 
 				$sourceTable = $sourceSchema->getTable($table->getName());
 			} catch (SchemaException $e) {
 				if (\strlen($table->getName()) - $prefixLength > 27) {
-					throw new \InvalidArgumentException('Table name "'  . $table->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Table name "'.$table->getName().'" is too long.');
 				}
 				$sourceTable = null;
 			}
 
 			foreach ($table->getColumns() as $thing) {
 				if ((!$sourceTable instanceof Table || !$sourceTable->hasColumn($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Column name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Column name "'.$table->getName().'"."'.$thing->getName().'" is too long.');
 				}
 
 				if ($thing->getNotnull() && $thing->getDefault() === ''
 					&& $sourceTable instanceof Table && !$sourceTable->hasColumn($thing->getName())) {
-					throw new \InvalidArgumentException('Column name "'  . $table->getName() . '"."' . $thing->getName() . '" is NotNull, but has empty string or null as default.');
+					throw new \InvalidArgumentException('Column name "'.$table->getName().'"."'.$thing->getName().'" is NotNull, but has empty string or null as default.');
 				}
 			}
 
 			foreach ($table->getIndexes() as $thing) {
 				if ((!$sourceTable instanceof Table || !$sourceTable->hasIndex($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Index name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Index name "'.$table->getName().'"."'.$thing->getName().'" is too long.');
 				}
 			}
 
 			foreach ($table->getForeignKeys() as $thing) {
 				if ((!$sourceTable instanceof Table || !$sourceTable->hasForeignKey($thing->getName())) && \strlen($thing->getName()) > 30) {
-					throw new \InvalidArgumentException('Foreign key name "'  . $table->getName() . '"."' . $thing->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Foreign key name "'.$table->getName().'"."'.$thing->getName().'" is too long.');
 				}
 			}
 
@@ -584,32 +584,32 @@ 
 				$isUsingDefaultName = $indexName === 'primary';
 
 				if ($this->connection->getDatabasePlatform() instanceof PostgreSqlPlatform) {
-					$defaultName = $table->getName() . '_pkey';
+					$defaultName = $table->getName().'_pkey';
 					$isUsingDefaultName = strtolower($defaultName) === $indexName;
 
 					if ($isUsingDefaultName) {
-						$sequenceName = $table->getName() . '_' . implode('_', $primaryKey->getColumns()) . '_seq';
-						$sequences = array_filter($sequences, function (Sequence $sequence) use ($sequenceName) {
+						$sequenceName = $table->getName().'_'.implode('_', $primaryKey->getColumns()).'_seq';
+						$sequences = array_filter($sequences, function(Sequence $sequence) use ($sequenceName) {
 							return $sequence->getName() !== $sequenceName;
 						});
 					}
 				} elseif ($this->connection->getDatabasePlatform() instanceof OraclePlatform) {
-					$defaultName = $table->getName() . '_seq';
+					$defaultName = $table->getName().'_seq';
 					$isUsingDefaultName = strtolower($defaultName) === $indexName;
 				}
 
 				if (!$isUsingDefaultName && \strlen($indexName) > 30) {
-					throw new \InvalidArgumentException('Primary index name  on "'  . $table->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Primary index name  on "'.$table->getName().'" is too long.');
 				}
 				if ($isUsingDefaultName && \strlen($table->getName()) - $prefixLength >= 23) {
-					throw new \InvalidArgumentException('Primary index name  on "'  . $table->getName() . '" is too long.');
+					throw new \InvalidArgumentException('Primary index name  on "'.$table->getName().'" is too long.');
 				}
 			}
 		}
 
 		foreach ($sequences as $sequence) {
 			if (!$sourceSchema->hasSequence($sequence->getName()) && \strlen($sequence->getName()) > 30) {
-				throw new \InvalidArgumentException('Sequence name "'  . $sequence->getName() . '" is too long.');
+				throw new \InvalidArgumentException('Sequence name "'.$sequence->getName().'" is too long.');
 			}
 		}
 	}

lib/private/Installer.php

Indentation +578 added lines, -578 removed lines

@@ -57,582 +57,582 @@
  * This class provides the functionality needed to install, update and remove apps
  */
 class Installer {
-	/** @var AppFetcher */
-	private $appFetcher;
-	/** @var IClientService */
-	private $clientService;
-	/** @var ITempManager */
-	private $tempManager;
-	/** @var ILogger */
-	private $logger;
-	/** @var IConfig */
-	private $config;
-	/** @var array - for caching the result of app fetcher */
-	private $apps = null;
-	/** @var bool|null - for caching the result of the ready status */
-	private $isInstanceReadyForUpdates = null;
-	/** @var bool */
-	private $isCLI;
-
-	/**
-	 * @param AppFetcher $appFetcher
-	 * @param IClientService $clientService
-	 * @param ITempManager $tempManager
-	 * @param ILogger $logger
-	 * @param IConfig $config
-	 */
-	public function __construct(
-		AppFetcher $appFetcher,
-		IClientService $clientService,
-		ITempManager $tempManager,
-		ILogger $logger,
-		IConfig $config,
-		bool $isCLI
-	) {
-		$this->appFetcher = $appFetcher;
-		$this->clientService = $clientService;
-		$this->tempManager = $tempManager;
-		$this->logger = $logger;
-		$this->config = $config;
-		$this->isCLI = $isCLI;
-	}
-
-	/**
-	 * Installs an app that is located in one of the app folders already
-	 *
-	 * @param string $appId App to install
-	 * @param bool $forceEnable
-	 * @throws \Exception
-	 * @return string app ID
-	 */
-	public function installApp(string $appId, bool $forceEnable = false): string {
-		$app = \OC_App::findAppInDirectories($appId);
-		if ($app === false) {
-			throw new \Exception('App not found in any app directory');
-		}
-
-		$basedir = $app['path'].'/'.$appId;
-		$info = OC_App::getAppInfo($basedir.'/appinfo/info.xml', true);
-
-		$l = \OC::$server->getL10N('core');
-
-		if (!is_array($info)) {
-			throw new \Exception(
-				$l->t('App "%s" cannot be installed because appinfo file cannot be read.',
-					[$appId]
-				)
-			);
-		}
-
-		$ignoreMaxApps = $this->config->getSystemValue('app_install_overwrite', []);
-		$ignoreMax = $forceEnable || in_array($appId, $ignoreMaxApps, true);
-
-		$version = implode('.', \OCP\Util::getVersion());
-		if (!\OC_App::isAppCompatible($version, $info, $ignoreMax)) {
-			throw new \Exception(
-				// TODO $l
-				$l->t('App "%s" cannot be installed because it is not compatible with this version of the server.',
-					[$info['name']]
-				)
-			);
-		}
-
-		// check for required dependencies
-		\OC_App::checkAppDependencies($this->config, $l, $info, $ignoreMax);
-		/** @var Coordinator $coordinator */
-		$coordinator = \OC::$server->get(Coordinator::class);
-		$coordinator->runLazyRegistration($appId);
-		\OC_App::registerAutoloading($appId, $basedir);
-
-		$previousVersion = $this->config->getAppValue($info['id'], 'installed_version', false);
-		if ($previousVersion) {
-			OC_App::executeRepairSteps($appId, $info['repair-steps']['pre-migration']);
-		}
-
-		//install the database
-		if (is_file($basedir.'/appinfo/database.xml')) {
-			if (\OC::$server->getConfig()->getAppValue($info['id'], 'installed_version') === null) {
-				OC_DB::createDbFromStructure($basedir.'/appinfo/database.xml');
-			} else {
-				OC_DB::updateDbFromStructure($basedir.'/appinfo/database.xml');
-			}
-		} else {
-			$ms = new \OC\DB\MigrationService($info['id'], \OC::$server->getDatabaseConnection());
-			$ms->migrate('latest', true);
-		}
-		if ($previousVersion) {
-			OC_App::executeRepairSteps($appId, $info['repair-steps']['post-migration']);
-		}
-
-		\OC_App::setupBackgroundJobs($info['background-jobs']);
-
-		//run appinfo/install.php
-		self::includeAppScript($basedir . '/appinfo/install.php');
-
-		$appData = OC_App::getAppInfo($appId);
-		OC_App::executeRepairSteps($appId, $appData['repair-steps']['install']);
-
-		//set the installed version
-		\OC::$server->getConfig()->setAppValue($info['id'], 'installed_version', OC_App::getAppVersion($info['id'], false));
-		\OC::$server->getConfig()->setAppValue($info['id'], 'enabled', 'no');
-
-		//set remote/public handlers
-		foreach ($info['remote'] as $name => $path) {
-			\OC::$server->getConfig()->setAppValue('core', 'remote_'.$name, $info['id'].'/'.$path);
-		}
-		foreach ($info['public'] as $name => $path) {
-			\OC::$server->getConfig()->setAppValue('core', 'public_'.$name, $info['id'].'/'.$path);
-		}
-
-		OC_App::setAppTypes($info['id']);
-
-		return $info['id'];
-	}
-
-	/**
-	 * Updates the specified app from the appstore
-	 *
-	 * @param string $appId
-	 * @param bool [$allowUnstable] Allow unstable releases
-	 * @return bool
-	 */
-	public function updateAppstoreApp($appId, $allowUnstable = false) {
-		if ($this->isUpdateAvailable($appId, $allowUnstable)) {
-			try {
-				$this->downloadApp($appId, $allowUnstable);
-			} catch (\Exception $e) {
-				$this->logger->logException($e, [
-					'level' => ILogger::ERROR,
-					'app' => 'core',
-				]);
-				return false;
-			}
-			return OC_App::updateApp($appId);
-		}
-
-		return false;
-	}
-
-	/**
-	 * Downloads an app and puts it into the app directory
-	 *
-	 * @param string $appId
-	 * @param bool [$allowUnstable]
-	 *
-	 * @throws \Exception If the installation was not successful
-	 */
-	public function downloadApp($appId, $allowUnstable = false) {
-		$appId = strtolower($appId);
-
-		$apps = $this->appFetcher->get($allowUnstable);
-		foreach ($apps as $app) {
-			if ($app['id'] === $appId) {
-				// Load the certificate
-				$certificate = new X509();
-				$certificate->loadCA(file_get_contents(__DIR__ . '/../../resources/codesigning/root.crt'));
-				$loadedCertificate = $certificate->loadX509($app['certificate']);
-
-				// Verify if the certificate has been revoked
-				$crl = new X509();
-				$crl->loadCA(file_get_contents(__DIR__ . '/../../resources/codesigning/root.crt'));
-				$crl->loadCRL(file_get_contents(__DIR__ . '/../../resources/codesigning/root.crl'));
-				if ($crl->validateSignature() !== true) {
-					throw new \Exception('Could not validate CRL signature');
-				}
-				$csn = $loadedCertificate['tbsCertificate']['serialNumber']->toString();
-				$revoked = $crl->getRevoked($csn);
-				if ($revoked !== false) {
-					throw new \Exception(
-						sprintf(
-							'Certificate "%s" has been revoked',
-							$csn
-						)
-					);
-				}
-
-				// Verify if the certificate has been issued by the Nextcloud Code Authority CA
-				if ($certificate->validateSignature() !== true) {
-					throw new \Exception(
-						sprintf(
-							'App with id %s has a certificate not issued by a trusted Code Signing Authority',
-							$appId
-						)
-					);
-				}
-
-				// Verify if the certificate is issued for the requested app id
-				$certInfo = openssl_x509_parse($app['certificate']);
-				if (!isset($certInfo['subject']['CN'])) {
-					throw new \Exception(
-						sprintf(
-							'App with id %s has a cert with no CN',
-							$appId
-						)
-					);
-				}
-				if ($certInfo['subject']['CN'] !== $appId) {
-					throw new \Exception(
-						sprintf(
-							'App with id %s has a cert issued to %s',
-							$appId,
-							$certInfo['subject']['CN']
-						)
-					);
-				}
-
-				// Download the release
-				$tempFile = $this->tempManager->getTemporaryFile('.tar.gz');
-				$timeout = $this->isCLI ? 0 : 120;
-				$client = $this->clientService->newClient();
-				$client->get($app['releases'][0]['download'], ['save_to' => $tempFile, 'timeout' => $timeout]);
-
-				// Check if the signature actually matches the downloaded content
-				$certificate = openssl_get_publickey($app['certificate']);
-				$verified = (bool)openssl_verify(file_get_contents($tempFile), base64_decode($app['releases'][0]['signature']), $certificate, OPENSSL_ALGO_SHA512);
-				openssl_free_key($certificate);
-
-				if ($verified === true) {
-					// Seems to match, let's proceed
-					$extractDir = $this->tempManager->getTemporaryFolder();
-					$archive = new TAR($tempFile);
-
-					if ($archive) {
-						if (!$archive->extract($extractDir)) {
-							$errorMessage = 'Could not extract app ' . $appId;
-
-							$archiveError = $archive->getError();
-							if ($archiveError instanceof \PEAR_Error) {
-								$errorMessage .= ': ' . $archiveError->getMessage();
-							}
-
-							throw new \Exception($errorMessage);
-						}
-						$allFiles = scandir($extractDir);
-						$folders = array_diff($allFiles, ['.', '..']);
-						$folders = array_values($folders);
-
-						if (count($folders) > 1) {
-							throw new \Exception(
-								sprintf(
-									'Extracted app %s has more than 1 folder',
-									$appId
-								)
-							);
-						}
-
-						// Check if appinfo/info.xml has the same app ID as well
-						$loadEntities = libxml_disable_entity_loader(false);
-						$xml = simplexml_load_file($extractDir . '/' . $folders[0] . '/appinfo/info.xml');
-						libxml_disable_entity_loader($loadEntities);
-						if ((string)$xml->id !== $appId) {
-							throw new \Exception(
-								sprintf(
-									'App for id %s has a wrong app ID in info.xml: %s',
-									$appId,
-									(string)$xml->id
-								)
-							);
-						}
-
-						// Check if the version is lower than before
-						$currentVersion = OC_App::getAppVersion($appId);
-						$newVersion = (string)$xml->version;
-						if (version_compare($currentVersion, $newVersion) === 1) {
-							throw new \Exception(
-								sprintf(
-									'App for id %s has version %s and tried to update to lower version %s',
-									$appId,
-									$currentVersion,
-									$newVersion
-								)
-							);
-						}
-
-						$baseDir = OC_App::getInstallPath() . '/' . $appId;
-						// Remove old app with the ID if existent
-						OC_Helper::rmdirr($baseDir);
-						// Move to app folder
-						if (@mkdir($baseDir)) {
-							$extractDir .= '/' . $folders[0];
-							OC_Helper::copyr($extractDir, $baseDir);
-						}
-						OC_Helper::copyr($extractDir, $baseDir);
-						OC_Helper::rmdirr($extractDir);
-						return;
-					} else {
-						throw new \Exception(
-							sprintf(
-								'Could not extract app with ID %s to %s',
-								$appId,
-								$extractDir
-							)
-						);
-					}
-				} else {
-					// Signature does not match
-					throw new \Exception(
-						sprintf(
-							'App with id %s has invalid signature',
-							$appId
-						)
-					);
-				}
-			}
-		}
-
-		throw new \Exception(
-			sprintf(
-				'Could not download app %s',
-				$appId
-			)
-		);
-	}
-
-	/**
-	 * Check if an update for the app is available
-	 *
-	 * @param string $appId
-	 * @param bool $allowUnstable
-	 * @return string|false false or the version number of the update
-	 */
-	public function isUpdateAvailable($appId, $allowUnstable = false) {
-		if ($this->isInstanceReadyForUpdates === null) {
-			$installPath = OC_App::getInstallPath();
-			if ($installPath === false || $installPath === null) {
-				$this->isInstanceReadyForUpdates = false;
-			} else {
-				$this->isInstanceReadyForUpdates = true;
-			}
-		}
-
-		if ($this->isInstanceReadyForUpdates === false) {
-			return false;
-		}
-
-		if ($this->isInstalledFromGit($appId) === true) {
-			return false;
-		}
-
-		if ($this->apps === null) {
-			$this->apps = $this->appFetcher->get($allowUnstable);
-		}
-
-		foreach ($this->apps as $app) {
-			if ($app['id'] === $appId) {
-				$currentVersion = OC_App::getAppVersion($appId);
-
-				if (!isset($app['releases'][0]['version'])) {
-					return false;
-				}
-				$newestVersion = $app['releases'][0]['version'];
-				if ($currentVersion !== '0' && version_compare($newestVersion, $currentVersion, '>')) {
-					return $newestVersion;
-				} else {
-					return false;
-				}
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Check if app has been installed from git
-	 * @param string $name name of the application to remove
-	 * @return boolean
-	 *
-	 * The function will check if the path contains a .git folder
-	 */
-	private function isInstalledFromGit($appId) {
-		$app = \OC_App::findAppInDirectories($appId);
-		if ($app === false) {
-			return false;
-		}
-		$basedir = $app['path'].'/'.$appId;
-		return file_exists($basedir.'/.git/');
-	}
-
-	/**
-	 * Check if app is already downloaded
-	 * @param string $name name of the application to remove
-	 * @return boolean
-	 *
-	 * The function will check if the app is already downloaded in the apps repository
-	 */
-	public function isDownloaded($name) {
-		foreach (\OC::$APPSROOTS as $dir) {
-			$dirToTest = $dir['path'];
-			$dirToTest .= '/';
-			$dirToTest .= $name;
-			$dirToTest .= '/';
-
-			if (is_dir($dirToTest)) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * Removes an app
-	 * @param string $appId ID of the application to remove
-	 * @return boolean
-	 *
-	 *
-	 * This function works as follows
-	 *   -# call uninstall repair steps
-	 *   -# removing the files
-	 *
-	 * The function will not delete preferences, tables and the configuration,
-	 * this has to be done by the function oc_app_uninstall().
-	 */
-	public function removeApp($appId) {
-		if ($this->isDownloaded($appId)) {
-			if (\OC::$server->getAppManager()->isShipped($appId)) {
-				return false;
-			}
-			$appDir = OC_App::getInstallPath() . '/' . $appId;
-			OC_Helper::rmdirr($appDir);
-			return true;
-		} else {
-			\OCP\Util::writeLog('core', 'can\'t remove app '.$appId.'. It is not installed.', ILogger::ERROR);
-
-			return false;
-		}
-	}
-
-	/**
-	 * Installs the app within the bundle and marks the bundle as installed
-	 *
-	 * @param Bundle $bundle
-	 * @throws \Exception If app could not get installed
-	 */
-	public function installAppBundle(Bundle $bundle) {
-		$appIds = $bundle->getAppIdentifiers();
-		foreach ($appIds as $appId) {
-			if (!$this->isDownloaded($appId)) {
-				$this->downloadApp($appId);
-			}
-			$this->installApp($appId);
-			$app = new OC_App();
-			$app->enable($appId);
-		}
-		$bundles = json_decode($this->config->getAppValue('core', 'installed.bundles', json_encode([])), true);
-		$bundles[] = $bundle->getIdentifier();
-		$this->config->setAppValue('core', 'installed.bundles', json_encode($bundles));
-	}
-
-	/**
-	 * Installs shipped apps
-	 *
-	 * This function installs all apps found in the 'apps' directory that should be enabled by default;
-	 * @param bool $softErrors When updating we ignore errors and simply log them, better to have a
-	 *                         working ownCloud at the end instead of an aborted update.
-	 * @return array Array of error messages (appid => Exception)
-	 */
-	public static function installShippedApps($softErrors = false) {
-		$appManager = \OC::$server->getAppManager();
-		$config = \OC::$server->getConfig();
-		$errors = [];
-		foreach (\OC::$APPSROOTS as $app_dir) {
-			if ($dir = opendir($app_dir['path'])) {
-				while (false !== ($filename = readdir($dir))) {
-					if ($filename[0] !== '.' and is_dir($app_dir['path']."/$filename")) {
-						if (file_exists($app_dir['path']."/$filename/appinfo/info.xml")) {
-							if ($config->getAppValue($filename, "installed_version", null) === null) {
-								$info = OC_App::getAppInfo($filename);
-								$enabled = isset($info['default_enable']);
-								if (($enabled || in_array($filename, $appManager->getAlwaysEnabledApps()))
-									  && $config->getAppValue($filename, 'enabled') !== 'no') {
-									if ($softErrors) {
-										try {
-											Installer::installShippedApp($filename);
-										} catch (HintException $e) {
-											if ($e->getPrevious() instanceof TableExistsException) {
-												$errors[$filename] = $e;
-												continue;
-											}
-											throw $e;
-										}
-									} else {
-										Installer::installShippedApp($filename);
-									}
-									$config->setAppValue($filename, 'enabled', 'yes');
-								}
-							}
-						}
-					}
-				}
-				closedir($dir);
-			}
-		}
-
-		return $errors;
-	}
-
-	/**
-	 * install an app already placed in the app folder
-	 * @param string $app id of the app to install
-	 * @return integer
-	 */
-	public static function installShippedApp($app) {
-		//install the database
-		$appPath = OC_App::getAppPath($app);
-		\OC_App::registerAutoloading($app, $appPath);
-
-		if (is_file("$appPath/appinfo/database.xml")) {
-			try {
-				OC_DB::createDbFromStructure("$appPath/appinfo/database.xml");
-			} catch (TableExistsException $e) {
-				throw new HintException(
-					'Failed to enable app ' . $app,
-					'Please ask for help via one of our <a href="https://nextcloud.com/support/" target="_blank" rel="noreferrer noopener">support channels</a>.',
-					0, $e
-				);
-			}
-		} else {
-			$ms = new \OC\DB\MigrationService($app, \OC::$server->getDatabaseConnection());
-			$ms->migrate('latest', true);
-		}
-
-		//run appinfo/install.php
-		self::includeAppScript("$appPath/appinfo/install.php");
-
-		$info = OC_App::getAppInfo($app);
-		if (is_null($info)) {
-			return false;
-		}
-		\OC_App::setupBackgroundJobs($info['background-jobs']);
-
-		OC_App::executeRepairSteps($app, $info['repair-steps']['install']);
-
-		$config = \OC::$server->getConfig();
-
-		$config->setAppValue($app, 'installed_version', OC_App::getAppVersion($app));
-		if (array_key_exists('ocsid', $info)) {
-			$config->setAppValue($app, 'ocsid', $info['ocsid']);
-		}
-
-		//set remote/public handlers
-		foreach ($info['remote'] as $name => $path) {
-			$config->setAppValue('core', 'remote_'.$name, $app.'/'.$path);
-		}
-		foreach ($info['public'] as $name => $path) {
-			$config->setAppValue('core', 'public_'.$name, $app.'/'.$path);
-		}
-
-		OC_App::setAppTypes($info['id']);
-
-		return $info['id'];
-	}
-
-	/**
-	 * @param string $script
-	 */
-	private static function includeAppScript($script) {
-		if (file_exists($script)) {
-			include $script;
-		}
-	}
+    /** @var AppFetcher */
+    private $appFetcher;
+    /** @var IClientService */
+    private $clientService;
+    /** @var ITempManager */
+    private $tempManager;
+    /** @var ILogger */
+    private $logger;
+    /** @var IConfig */
+    private $config;
+    /** @var array - for caching the result of app fetcher */
+    private $apps = null;
+    /** @var bool|null - for caching the result of the ready status */
+    private $isInstanceReadyForUpdates = null;
+    /** @var bool */
+    private $isCLI;
+
+    /**
+     * @param AppFetcher $appFetcher
+     * @param IClientService $clientService
+     * @param ITempManager $tempManager
+     * @param ILogger $logger
+     * @param IConfig $config
+     */
+    public function __construct(
+        AppFetcher $appFetcher,
+        IClientService $clientService,
+        ITempManager $tempManager,
+        ILogger $logger,
+        IConfig $config,
+        bool $isCLI
+    ) {
+        $this->appFetcher = $appFetcher;
+        $this->clientService = $clientService;
+        $this->tempManager = $tempManager;
+        $this->logger = $logger;
+        $this->config = $config;
+        $this->isCLI = $isCLI;
+    }
+
+    /**
+     * Installs an app that is located in one of the app folders already
+     *
+     * @param string $appId App to install
+     * @param bool $forceEnable
+     * @throws \Exception
+     * @return string app ID
+     */
+    public function installApp(string $appId, bool $forceEnable = false): string {
+        $app = \OC_App::findAppInDirectories($appId);
+        if ($app === false) {
+            throw new \Exception('App not found in any app directory');
+        }
+
+        $basedir = $app['path'].'/'.$appId;
+        $info = OC_App::getAppInfo($basedir.'/appinfo/info.xml', true);
+
+        $l = \OC::$server->getL10N('core');
+
+        if (!is_array($info)) {
+            throw new \Exception(
+                $l->t('App "%s" cannot be installed because appinfo file cannot be read.',
+                    [$appId]
+                )
+            );
+        }
+
+        $ignoreMaxApps = $this->config->getSystemValue('app_install_overwrite', []);
+        $ignoreMax = $forceEnable || in_array($appId, $ignoreMaxApps, true);
+
+        $version = implode('.', \OCP\Util::getVersion());
+        if (!\OC_App::isAppCompatible($version, $info, $ignoreMax)) {
+            throw new \Exception(
+                // TODO $l
+                $l->t('App "%s" cannot be installed because it is not compatible with this version of the server.',
+                    [$info['name']]
+                )
+            );
+        }
+
+        // check for required dependencies
+        \OC_App::checkAppDependencies($this->config, $l, $info, $ignoreMax);
+        /** @var Coordinator $coordinator */
+        $coordinator = \OC::$server->get(Coordinator::class);
+        $coordinator->runLazyRegistration($appId);
+        \OC_App::registerAutoloading($appId, $basedir);
+
+        $previousVersion = $this->config->getAppValue($info['id'], 'installed_version', false);
+        if ($previousVersion) {
+            OC_App::executeRepairSteps($appId, $info['repair-steps']['pre-migration']);
+        }
+
+        //install the database
+        if (is_file($basedir.'/appinfo/database.xml')) {
+            if (\OC::$server->getConfig()->getAppValue($info['id'], 'installed_version') === null) {
+                OC_DB::createDbFromStructure($basedir.'/appinfo/database.xml');
+            } else {
+                OC_DB::updateDbFromStructure($basedir.'/appinfo/database.xml');
+            }
+        } else {
+            $ms = new \OC\DB\MigrationService($info['id'], \OC::$server->getDatabaseConnection());
+            $ms->migrate('latest', true);
+        }
+        if ($previousVersion) {
+            OC_App::executeRepairSteps($appId, $info['repair-steps']['post-migration']);
+        }
+
+        \OC_App::setupBackgroundJobs($info['background-jobs']);
+
+        //run appinfo/install.php
+        self::includeAppScript($basedir . '/appinfo/install.php');
+
+        $appData = OC_App::getAppInfo($appId);
+        OC_App::executeRepairSteps($appId, $appData['repair-steps']['install']);
+
+        //set the installed version
+        \OC::$server->getConfig()->setAppValue($info['id'], 'installed_version', OC_App::getAppVersion($info['id'], false));
+        \OC::$server->getConfig()->setAppValue($info['id'], 'enabled', 'no');
+
+        //set remote/public handlers
+        foreach ($info['remote'] as $name => $path) {
+            \OC::$server->getConfig()->setAppValue('core', 'remote_'.$name, $info['id'].'/'.$path);
+        }
+        foreach ($info['public'] as $name => $path) {
+            \OC::$server->getConfig()->setAppValue('core', 'public_'.$name, $info['id'].'/'.$path);
+        }
+
+        OC_App::setAppTypes($info['id']);
+
+        return $info['id'];
+    }
+
+    /**
+     * Updates the specified app from the appstore
+     *
+     * @param string $appId
+     * @param bool [$allowUnstable] Allow unstable releases
+     * @return bool
+     */
+    public function updateAppstoreApp($appId, $allowUnstable = false) {
+        if ($this->isUpdateAvailable($appId, $allowUnstable)) {
+            try {
+                $this->downloadApp($appId, $allowUnstable);
+            } catch (\Exception $e) {
+                $this->logger->logException($e, [
+                    'level' => ILogger::ERROR,
+                    'app' => 'core',
+                ]);
+                return false;
+            }
+            return OC_App::updateApp($appId);
+        }
+
+        return false;
+    }
+
+    /**
+     * Downloads an app and puts it into the app directory
+     *
+     * @param string $appId
+     * @param bool [$allowUnstable]
+     *
+     * @throws \Exception If the installation was not successful
+     */
+    public function downloadApp($appId, $allowUnstable = false) {
+        $appId = strtolower($appId);
+
+        $apps = $this->appFetcher->get($allowUnstable);
+        foreach ($apps as $app) {
+            if ($app['id'] === $appId) {
+                // Load the certificate
+                $certificate = new X509();
+                $certificate->loadCA(file_get_contents(__DIR__ . '/../../resources/codesigning/root.crt'));
+                $loadedCertificate = $certificate->loadX509($app['certificate']);
+
+                // Verify if the certificate has been revoked
+                $crl = new X509();
+                $crl->loadCA(file_get_contents(__DIR__ . '/../../resources/codesigning/root.crt'));
+                $crl->loadCRL(file_get_contents(__DIR__ . '/../../resources/codesigning/root.crl'));
+                if ($crl->validateSignature() !== true) {
+                    throw new \Exception('Could not validate CRL signature');
+                }
+                $csn = $loadedCertificate['tbsCertificate']['serialNumber']->toString();
+                $revoked = $crl->getRevoked($csn);
+                if ($revoked !== false) {
+                    throw new \Exception(
+                        sprintf(
+                            'Certificate "%s" has been revoked',
+                            $csn
+                        )
+                    );
+                }
+
+                // Verify if the certificate has been issued by the Nextcloud Code Authority CA
+                if ($certificate->validateSignature() !== true) {
+                    throw new \Exception(
+                        sprintf(
+                            'App with id %s has a certificate not issued by a trusted Code Signing Authority',
+                            $appId
+                        )
+                    );
+                }
+
+                // Verify if the certificate is issued for the requested app id
+                $certInfo = openssl_x509_parse($app['certificate']);
+                if (!isset($certInfo['subject']['CN'])) {
+                    throw new \Exception(
+                        sprintf(
+                            'App with id %s has a cert with no CN',
+                            $appId
+                        )
+                    );
+                }
+                if ($certInfo['subject']['CN'] !== $appId) {
+                    throw new \Exception(
+                        sprintf(
+                            'App with id %s has a cert issued to %s',
+                            $appId,
+                            $certInfo['subject']['CN']
+                        )
+                    );
+                }
+
+                // Download the release
+                $tempFile = $this->tempManager->getTemporaryFile('.tar.gz');
+                $timeout = $this->isCLI ? 0 : 120;
+                $client = $this->clientService->newClient();
+                $client->get($app['releases'][0]['download'], ['save_to' => $tempFile, 'timeout' => $timeout]);
+
+                // Check if the signature actually matches the downloaded content
+                $certificate = openssl_get_publickey($app['certificate']);
+                $verified = (bool)openssl_verify(file_get_contents($tempFile), base64_decode($app['releases'][0]['signature']), $certificate, OPENSSL_ALGO_SHA512);
+                openssl_free_key($certificate);
+
+                if ($verified === true) {
+                    // Seems to match, let's proceed
+                    $extractDir = $this->tempManager->getTemporaryFolder();
+                    $archive = new TAR($tempFile);
+
+                    if ($archive) {
+                        if (!$archive->extract($extractDir)) {
+                            $errorMessage = 'Could not extract app ' . $appId;
+
+                            $archiveError = $archive->getError();
+                            if ($archiveError instanceof \PEAR_Error) {
+                                $errorMessage .= ': ' . $archiveError->getMessage();
+                            }
+
+                            throw new \Exception($errorMessage);
+                        }
+                        $allFiles = scandir($extractDir);
+                        $folders = array_diff($allFiles, ['.', '..']);
+                        $folders = array_values($folders);
+
+                        if (count($folders) > 1) {
+                            throw new \Exception(
+                                sprintf(
+                                    'Extracted app %s has more than 1 folder',
+                                    $appId
+                                )
+                            );
+                        }
+
+                        // Check if appinfo/info.xml has the same app ID as well
+                        $loadEntities = libxml_disable_entity_loader(false);
+                        $xml = simplexml_load_file($extractDir . '/' . $folders[0] . '/appinfo/info.xml');
+                        libxml_disable_entity_loader($loadEntities);
+                        if ((string)$xml->id !== $appId) {
+                            throw new \Exception(
+                                sprintf(
+                                    'App for id %s has a wrong app ID in info.xml: %s',
+                                    $appId,
+                                    (string)$xml->id
+                                )
+                            );
+                        }
+
+                        // Check if the version is lower than before
+                        $currentVersion = OC_App::getAppVersion($appId);
+                        $newVersion = (string)$xml->version;
+                        if (version_compare($currentVersion, $newVersion) === 1) {
+                            throw new \Exception(
+                                sprintf(
+                                    'App for id %s has version %s and tried to update to lower version %s',
+                                    $appId,
+                                    $currentVersion,
+                                    $newVersion
+                                )
+                            );
+                        }
+
+                        $baseDir = OC_App::getInstallPath() . '/' . $appId;
+                        // Remove old app with the ID if existent
+                        OC_Helper::rmdirr($baseDir);
+                        // Move to app folder
+                        if (@mkdir($baseDir)) {
+                            $extractDir .= '/' . $folders[0];
+                            OC_Helper::copyr($extractDir, $baseDir);
+                        }
+                        OC_Helper::copyr($extractDir, $baseDir);
+                        OC_Helper::rmdirr($extractDir);
+                        return;
+                    } else {
+                        throw new \Exception(
+                            sprintf(
+                                'Could not extract app with ID %s to %s',
+                                $appId,
+                                $extractDir
+                            )
+                        );
+                    }
+                } else {
+                    // Signature does not match
+                    throw new \Exception(
+                        sprintf(
+                            'App with id %s has invalid signature',
+                            $appId
+                        )
+                    );
+                }
+            }
+        }
+
+        throw new \Exception(
+            sprintf(
+                'Could not download app %s',
+                $appId
+            )
+        );
+    }
+
+    /**
+     * Check if an update for the app is available
+     *
+     * @param string $appId
+     * @param bool $allowUnstable
+     * @return string|false false or the version number of the update
+     */
+    public function isUpdateAvailable($appId, $allowUnstable = false) {
+        if ($this->isInstanceReadyForUpdates === null) {
+            $installPath = OC_App::getInstallPath();
+            if ($installPath === false || $installPath === null) {
+                $this->isInstanceReadyForUpdates = false;
+            } else {
+                $this->isInstanceReadyForUpdates = true;
+            }
+        }
+
+        if ($this->isInstanceReadyForUpdates === false) {
+            return false;
+        }
+
+        if ($this->isInstalledFromGit($appId) === true) {
+            return false;
+        }
+
+        if ($this->apps === null) {
+            $this->apps = $this->appFetcher->get($allowUnstable);
+        }
+
+        foreach ($this->apps as $app) {
+            if ($app['id'] === $appId) {
+                $currentVersion = OC_App::getAppVersion($appId);
+
+                if (!isset($app['releases'][0]['version'])) {
+                    return false;
+                }
+                $newestVersion = $app['releases'][0]['version'];
+                if ($currentVersion !== '0' && version_compare($newestVersion, $currentVersion, '>')) {
+                    return $newestVersion;
+                } else {
+                    return false;
+                }
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Check if app has been installed from git
+     * @param string $name name of the application to remove
+     * @return boolean
+     *
+     * The function will check if the path contains a .git folder
+     */
+    private function isInstalledFromGit($appId) {
+        $app = \OC_App::findAppInDirectories($appId);
+        if ($app === false) {
+            return false;
+        }
+        $basedir = $app['path'].'/'.$appId;
+        return file_exists($basedir.'/.git/');
+    }
+
+    /**
+     * Check if app is already downloaded
+     * @param string $name name of the application to remove
+     * @return boolean
+     *
+     * The function will check if the app is already downloaded in the apps repository
+     */
+    public function isDownloaded($name) {
+        foreach (\OC::$APPSROOTS as $dir) {
+            $dirToTest = $dir['path'];
+            $dirToTest .= '/';
+            $dirToTest .= $name;
+            $dirToTest .= '/';
+
+            if (is_dir($dirToTest)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Removes an app
+     * @param string $appId ID of the application to remove
+     * @return boolean
+     *
+     *
+     * This function works as follows
+     *   -# call uninstall repair steps
+     *   -# removing the files
+     *
+     * The function will not delete preferences, tables and the configuration,
+     * this has to be done by the function oc_app_uninstall().
+     */
+    public function removeApp($appId) {
+        if ($this->isDownloaded($appId)) {
+            if (\OC::$server->getAppManager()->isShipped($appId)) {
+                return false;
+            }
+            $appDir = OC_App::getInstallPath() . '/' . $appId;
+            OC_Helper::rmdirr($appDir);
+            return true;
+        } else {
+            \OCP\Util::writeLog('core', 'can\'t remove app '.$appId.'. It is not installed.', ILogger::ERROR);
+
+            return false;
+        }
+    }
+
+    /**
+     * Installs the app within the bundle and marks the bundle as installed
+     *
+     * @param Bundle $bundle
+     * @throws \Exception If app could not get installed
+     */
+    public function installAppBundle(Bundle $bundle) {
+        $appIds = $bundle->getAppIdentifiers();
+        foreach ($appIds as $appId) {
+            if (!$this->isDownloaded($appId)) {
+                $this->downloadApp($appId);
+            }
+            $this->installApp($appId);
+            $app = new OC_App();
+            $app->enable($appId);
+        }
+        $bundles = json_decode($this->config->getAppValue('core', 'installed.bundles', json_encode([])), true);
+        $bundles[] = $bundle->getIdentifier();
+        $this->config->setAppValue('core', 'installed.bundles', json_encode($bundles));
+    }
+
+    /**
+     * Installs shipped apps
+     *
+     * This function installs all apps found in the 'apps' directory that should be enabled by default;
+     * @param bool $softErrors When updating we ignore errors and simply log them, better to have a
+     *                         working ownCloud at the end instead of an aborted update.
+     * @return array Array of error messages (appid => Exception)
+     */
+    public static function installShippedApps($softErrors = false) {
+        $appManager = \OC::$server->getAppManager();
+        $config = \OC::$server->getConfig();
+        $errors = [];
+        foreach (\OC::$APPSROOTS as $app_dir) {
+            if ($dir = opendir($app_dir['path'])) {
+                while (false !== ($filename = readdir($dir))) {
+                    if ($filename[0] !== '.' and is_dir($app_dir['path']."/$filename")) {
+                        if (file_exists($app_dir['path']."/$filename/appinfo/info.xml")) {
+                            if ($config->getAppValue($filename, "installed_version", null) === null) {
+                                $info = OC_App::getAppInfo($filename);
+                                $enabled = isset($info['default_enable']);
+                                if (($enabled || in_array($filename, $appManager->getAlwaysEnabledApps()))
+                                      && $config->getAppValue($filename, 'enabled') !== 'no') {
+                                    if ($softErrors) {
+                                        try {
+                                            Installer::installShippedApp($filename);
+                                        } catch (HintException $e) {
+                                            if ($e->getPrevious() instanceof TableExistsException) {
+                                                $errors[$filename] = $e;
+                                                continue;
+                                            }
+                                            throw $e;
+                                        }
+                                    } else {
+                                        Installer::installShippedApp($filename);
+                                    }
+                                    $config->setAppValue($filename, 'enabled', 'yes');
+                                }
+                            }
+                        }
+                    }
+                }
+                closedir($dir);
+            }
+        }
+
+        return $errors;
+    }
+
+    /**
+     * install an app already placed in the app folder
+     * @param string $app id of the app to install
+     * @return integer
+     */
+    public static function installShippedApp($app) {
+        //install the database
+        $appPath = OC_App::getAppPath($app);
+        \OC_App::registerAutoloading($app, $appPath);
+
+        if (is_file("$appPath/appinfo/database.xml")) {
+            try {
+                OC_DB::createDbFromStructure("$appPath/appinfo/database.xml");
+            } catch (TableExistsException $e) {
+                throw new HintException(
+                    'Failed to enable app ' . $app,
+                    'Please ask for help via one of our <a href="https://nextcloud.com/support/" target="_blank" rel="noreferrer noopener">support channels</a>.',
+                    0, $e
+                );
+            }
+        } else {
+            $ms = new \OC\DB\MigrationService($app, \OC::$server->getDatabaseConnection());
+            $ms->migrate('latest', true);
+        }
+
+        //run appinfo/install.php
+        self::includeAppScript("$appPath/appinfo/install.php");
+
+        $info = OC_App::getAppInfo($app);
+        if (is_null($info)) {
+            return false;
+        }
+        \OC_App::setupBackgroundJobs($info['background-jobs']);
+
+        OC_App::executeRepairSteps($app, $info['repair-steps']['install']);
+
+        $config = \OC::$server->getConfig();
+
+        $config->setAppValue($app, 'installed_version', OC_App::getAppVersion($app));
+        if (array_key_exists('ocsid', $info)) {
+            $config->setAppValue($app, 'ocsid', $info['ocsid']);
+        }
+
+        //set remote/public handlers
+        foreach ($info['remote'] as $name => $path) {
+            $config->setAppValue('core', 'remote_'.$name, $app.'/'.$path);
+        }
+        foreach ($info['public'] as $name => $path) {
+            $config->setAppValue('core', 'public_'.$name, $app.'/'.$path);
+        }
+
+        OC_App::setAppTypes($info['id']);
+
+        return $info['id'];
+    }
+
+    /**
+     * @param string $script
+     */
+    private static function includeAppScript($script) {
+        if (file_exists($script)) {
+            include $script;
+        }
+    }
 }

lib/private/DB/SchemaWrapper.php

Indentation +104 added lines, -104 removed lines

@@ -30,108 +30,108 @@
 
 class SchemaWrapper implements ISchemaWrapper {
 
-	/** @var IDBConnection|Connection */
-	protected $connection;
-
-	/** @var Schema */
-	protected $schema;
-
-	/** @var array */
-	protected $tablesToDelete = [];
-
-	/**
-	 * @param IDBConnection $connection
-	 */
-	public function __construct(IDBConnection $connection) {
-		$this->connection = $connection;
-		$this->schema = $this->connection->createSchema();
-	}
-
-	public function getWrappedSchema() {
-		return $this->schema;
-	}
-
-	public function performDropTableCalls() {
-		foreach ($this->tablesToDelete as $tableName => $true) {
-			$this->connection->dropTable($tableName);
-			unset($this->tablesToDelete[$tableName]);
-		}
-	}
-
-	/**
-	 * Gets all table names
-	 *
-	 * @return array
-	 */
-	public function getTableNamesWithoutPrefix() {
-		$tableNames = $this->schema->getTableNames();
-		return array_map(function ($tableName) {
-			if (strpos($tableName, $this->connection->getPrefix()) === 0) {
-				return substr($tableName, strlen($this->connection->getPrefix()));
-			}
-
-			return $tableName;
-		}, $tableNames);
-	}
-
-	// Overwritten methods
-
-	/**
-	 * @return array
-	 */
-	public function getTableNames() {
-		return $this->schema->getTableNames();
-	}
-
-	/**
-	 * @param string $tableName
-	 *
-	 * @return \Doctrine\DBAL\Schema\Table
-	 * @throws \Doctrine\DBAL\Schema\SchemaException
-	 */
-	public function getTable($tableName) {
-		return $this->schema->getTable($this->connection->getPrefix() . $tableName);
-	}
-
-	/**
-	 * Does this schema have a table with the given name?
-	 *
-	 * @param string $tableName
-	 *
-	 * @return boolean
-	 */
-	public function hasTable($tableName) {
-		return $this->schema->hasTable($this->connection->getPrefix() . $tableName);
-	}
-
-	/**
-	 * Creates a new table.
-	 *
-	 * @param string $tableName
-	 * @return \Doctrine\DBAL\Schema\Table
-	 */
-	public function createTable($tableName) {
-		unset($this->tablesToDelete[$tableName]);
-		return $this->schema->createTable($this->connection->getPrefix() . $tableName);
-	}
-
-	/**
-	 * Drops a table from the schema.
-	 *
-	 * @param string $tableName
-	 * @return \Doctrine\DBAL\Schema\Schema
-	 */
-	public function dropTable($tableName) {
-		$this->tablesToDelete[$tableName] = true;
-		return $this->schema->dropTable($this->connection->getPrefix() . $tableName);
-	}
-
-	/**
-	 * Gets all tables of this schema.
-	 *
-	 * @return \Doctrine\DBAL\Schema\Table[]
-	 */
-	public function getTables() {
-		return $this->schema->getTables();
-	}
+    /** @var IDBConnection|Connection */
+    protected $connection;
+
+    /** @var Schema */
+    protected $schema;
+
+    /** @var array */
+    protected $tablesToDelete = [];
+
+    /**
+     * @param IDBConnection $connection
+     */
+    public function __construct(IDBConnection $connection) {
+        $this->connection = $connection;
+        $this->schema = $this->connection->createSchema();
+    }
+
+    public function getWrappedSchema() {
+        return $this->schema;
+    }
+
+    public function performDropTableCalls() {
+        foreach ($this->tablesToDelete as $tableName => $true) {
+            $this->connection->dropTable($tableName);
+            unset($this->tablesToDelete[$tableName]);
+        }
+    }
+
+    /**
+     * Gets all table names
+     *
+     * @return array
+     */
+    public function getTableNamesWithoutPrefix() {
+        $tableNames = $this->schema->getTableNames();
+        return array_map(function ($tableName) {
+            if (strpos($tableName, $this->connection->getPrefix()) === 0) {
+                return substr($tableName, strlen($this->connection->getPrefix()));
+            }
+
+            return $tableName;
+        }, $tableNames);
+    }
+
+    // Overwritten methods
+
+    /**
+     * @return array
+     */
+    public function getTableNames() {
+        return $this->schema->getTableNames();
+    }
+
+    /**
+     * @param string $tableName
+     *
+     * @return \Doctrine\DBAL\Schema\Table
+     * @throws \Doctrine\DBAL\Schema\SchemaException
+     */
+    public function getTable($tableName) {
+        return $this->schema->getTable($this->connection->getPrefix() . $tableName);
+    }
+
+    /**
+     * Does this schema have a table with the given name?
+     *
+     * @param string $tableName
+     *
+     * @return boolean
+     */
+    public function hasTable($tableName) {
+        return $this->schema->hasTable($this->connection->getPrefix() . $tableName);
+    }
+
+    /**
+     * Creates a new table.
+     *
+     * @param string $tableName
+     * @return \Doctrine\DBAL\Schema\Table
+     */
+    public function createTable($tableName) {
+        unset($this->tablesToDelete[$tableName]);
+        return $this->schema->createTable($this->connection->getPrefix() . $tableName);
+    }
+
+    /**
+     * Drops a table from the schema.
+     *
+     * @param string $tableName
+     * @return \Doctrine\DBAL\Schema\Schema
+     */
+    public function dropTable($tableName) {
+        $this->tablesToDelete[$tableName] = true;
+        return $this->schema->dropTable($this->connection->getPrefix() . $tableName);
+    }
+
+    /**
+     * Gets all tables of this schema.
+     *
+     * @return \Doctrine\DBAL\Schema\Table[]
+     */
+    public function getTables() {
+        return $this->schema->getTables();
+    }
 }

Spacing +5 added lines, -5 removed lines

@@ -65,7 +65,7 @@ 
 	 */
 	public function getTableNamesWithoutPrefix() {
 		$tableNames = $this->schema->getTableNames();
-		return array_map(function ($tableName) {
+		return array_map(function($tableName) {
 			if (strpos($tableName, $this->connection->getPrefix()) === 0) {
 				return substr($tableName, strlen($this->connection->getPrefix()));
 			}
@@ -90,7 +90,7 @@ 
 	 * @throws \Doctrine\DBAL\Schema\SchemaException
 	 */
 	public function getTable($tableName) {
-		return $this->schema->getTable($this->connection->getPrefix() . $tableName);
+		return $this->schema->getTable($this->connection->getPrefix().$tableName);
 	}
 
 	/**
@@ -101,7 +101,7 @@ 
 	 * @return boolean
 	 */
 	public function hasTable($tableName) {
-		return $this->schema->hasTable($this->connection->getPrefix() . $tableName);
+		return $this->schema->hasTable($this->connection->getPrefix().$tableName);
 	}
 
 	/**
@@ -112,7 +112,7 @@ 
 	 */
 	public function createTable($tableName) {
 		unset($this->tablesToDelete[$tableName]);
-		return $this->schema->createTable($this->connection->getPrefix() . $tableName);
+		return $this->schema->createTable($this->connection->getPrefix().$tableName);
 	}
 
 	/**
@@ -123,7 +123,7 @@ 
 	 */
 	public function dropTable($tableName) {
 		$this->tablesToDelete[$tableName] = true;
-		return $this->schema->dropTable($this->connection->getPrefix() . $tableName);
+		return $this->schema->dropTable($this->connection->getPrefix().$tableName);
 	}
 
 	/**