Skip to content

Commit

Permalink
chore: Cleanup Installer class as well
Browse files Browse the repository at this point in the history 
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
  • Loading branch information
@come-nc
come-nc committed Jan 29, 2024
1 parent ccc66e9 commit 67e3ece
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 72 deletions.
5 changes: 2 additions & 3 deletions core/Command/Maintenance/Install.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ protected function configure(): void {

protected function execute(InputInterface $input, OutputInterface $output): int {
// validate the environment
$server = \OC::$server;
$setupHelper = \OCP\Server::get(\OC\Setup::class);

Check warning on line 78 in core/Command/Maintenance/Install.php

View check run for this annotation

Codecov / codecov/patch

core/Command/Maintenance/Install.php#L78 

Added line #L78 was not covered by tests
$sysInfo = $setupHelper->getSystemInfo(true);
$errors = $sysInfo['errors'];
Expand Down Expand Up @@ -198,9 +197,9 @@ protected function validateInput(InputInterface $input, OutputInterface $output,

/**
* @param OutputInterface $output
* @param $errors
* @param array<string|array> $errors
*/
protected function printErrors(OutputInterface $output, $errors) {
protected function printErrors(OutputInterface $output, array $errors): void {

Check warning on line 202 in core/Command/Maintenance/Install.php

View check run for this annotation

Codecov / codecov/patch

core/Command/Maintenance/Install.php#L202 

Added line #L202 was not covered by tests
foreach ($errors as $error) {
if (is_array($error)) {
$output->writeln('<error>' . $error['error'] . '</error>');
Expand Down
98 changes: 32 additions & 66 deletions lib/private/Installer.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,37 +64,17 @@
* 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 LoggerInterface */
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;
private ?bool $isInstanceReadyForUpdates = null;
private ?array $apps = null;

public function __construct(
AppFetcher $appFetcher,
IClientService $clientService,
ITempManager $tempManager,
LoggerInterface $logger,
IConfig $config,
bool $isCLI
private AppFetcher $appFetcher,
private IClientService $clientService,
private ITempManager $tempManager,
private LoggerInterface $logger,
private IConfig $config,
private bool $isCLI,
) {
$this->appFetcher = $appFetcher;
$this->clientService = $clientService;
$this->tempManager = $tempManager;
$this->logger = $logger;
$this->config = $config;
$this->isCLI = $isCLI;
}

/**
Expand All @@ -117,7 +97,7 @@ public function installApp(string $appId, bool $forceEnable = false): string {
throw new \Exception('The appinfo/database.xml file is not longer supported. Used in ' . $appId);
}

$l = \OC::$server->getL10N('core');
$l = \OCP\Util::getL10N('core');
$info = \OCP\Server::get(IAppManager::class)->getAppInfo($basedir . '/appinfo/info.xml', true, $l->getLanguageCode());

if (!is_array($info)) {
Expand Down Expand Up @@ -154,7 +134,7 @@ public function installApp(string $appId, bool $forceEnable = false): string {
}

//install the database
$ms = new MigrationService($info['id'], \OC::$server->get(Connection::class));
$ms = new MigrationService($info['id'], \OCP\Server::get(Connection::class));
$ms->migrate('latest', !$previousVersion);

if ($previousVersion) {
Expand All @@ -168,16 +148,17 @@ public function installApp(string $appId, bool $forceEnable = false): string {

OC_App::executeRepairSteps($appId, $info['repair-steps']['install']);

$config = \OCP\Server::get(IConfig::class);
//set the installed version
\OC::$server->getConfig()->setAppValue($info['id'], 'installed_version', \OCP\Server::get(IAppManager::class)->getAppVersion($info['id'], false));
\OC::$server->getConfig()->setAppValue($info['id'], 'enabled', 'no');
$config->setAppValue($info['id'], 'installed_version', \OCP\Server::get(IAppManager::class)->getAppVersion($info['id'], false));
$config->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);
$config->setAppValue('core', 'remote_'.$name, $info['id'].'/'.$path);

Check warning on line 158 in lib/private/Installer.php

View check run for this annotation

Codecov / codecov/patch

lib/private/Installer.php#L158 

Added line #L158 was not covered by tests
}
foreach ($info['public'] as $name => $path) {
\OC::$server->getConfig()->setAppValue('core', 'public_'.$name, $info['id'].'/'.$path);
$config->setAppValue('core', 'public_'.$name, $info['id'].'/'.$path);

Check warning on line 161 in lib/private/Installer.php

View check run for this annotation

Codecov / codecov/patch

lib/private/Installer.php#L161 

Added line #L161 was not covered by tests
}

OC_App::setAppTypes($info['id']);
Expand All @@ -188,11 +169,9 @@ public function installApp(string $appId, bool $forceEnable = false): string {
/**
* Updates the specified app from the appstore
*
* @param string $appId
* @param bool [$allowUnstable] Allow unstable releases
* @return bool
* @param bool $allowUnstable Allow unstable releases
*/
public function updateAppstoreApp($appId, $allowUnstable = false) {
public function updateAppstoreApp(string $appId, bool $allowUnstable = false): bool {

Check warning on line 174 in lib/private/Installer.php

View check run for this annotation

Codecov / codecov/patch

lib/private/Installer.php#L174 

Added line #L174 was not covered by tests
if ($this->isUpdateAvailable($appId, $allowUnstable)) {
try {
$this->downloadApp($appId, $allowUnstable);
Expand Down Expand Up @@ -228,7 +207,7 @@ private function splitCerts(string $cert): array {
*
* @throws \Exception If the installation was not successful
*/
public function downloadApp($appId, $allowUnstable = false) {
public function downloadApp(string $appId, bool $allowUnstable = false): void {
$appId = strtolower($appId);

$apps = $this->appFetcher->get($allowUnstable);
Expand Down Expand Up @@ -404,10 +383,10 @@ public function downloadApp($appId, $allowUnstable = false) {
* @param bool $allowUnstable
* @return string|false false or the version number of the update
*/
public function isUpdateAvailable($appId, $allowUnstable = false) {
public function isUpdateAvailable($appId, $allowUnstable = false): string|false {
if ($this->isInstanceReadyForUpdates === null) {
$installPath = OC_App::getInstallPath();
if ($installPath === false || $installPath === null) {
if ($installPath === null) {
$this->isInstanceReadyForUpdates = false;
} else {
$this->isInstanceReadyForUpdates = true;
Expand Down Expand Up @@ -447,12 +426,10 @@ public function isUpdateAvailable($appId, $allowUnstable = 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) {
private function isInstalledFromGit(string $appId): bool {
$app = \OC_App::findAppInDirectories($appId);
if ($app === false) {
return false;
Expand All @@ -463,12 +440,10 @@ private function isInstalledFromGit($appId) {

/**
* 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) {
public function isDownloaded(string $name): bool {
foreach (\OC::$APPSROOTS as $dir) {
$dirToTest = $dir['path'];
$dirToTest .= '/';
Expand All @@ -485,9 +460,6 @@ public function isDownloaded($name) {

/**
* Removes an app
* @param string $appId ID of the application to remove
* @return boolean
*
*
* This function works as follows
* -# call uninstall repair steps
Expand All @@ -496,9 +468,9 @@ public function isDownloaded($name) {
* 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) {
public function removeApp(string $appId): bool {
if ($this->isDownloaded($appId)) {
if (\OC::$server->getAppManager()->isShipped($appId)) {
if (\OCP\Server::get(IAppManager::class)->isShipped($appId)) {
return false;
}
$appDir = OC_App::getInstallPath() . '/' . $appId;
Expand All @@ -514,10 +486,9 @@ public function removeApp($appId) {
/**
* 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) {
public function installAppBundle(Bundle $bundle): void {

Check warning on line 491 in lib/private/Installer.php

View check run for this annotation

Codecov / codecov/patch

lib/private/Installer.php#L491 

Added line #L491 was not covered by tests
$appIds = $bundle->getAppIdentifiers();
foreach ($appIds as $appId) {
if (!$this->isDownloaded($appId)) {
Expand All @@ -540,12 +511,12 @@ public function installAppBundle(Bundle $bundle) {
* working ownCloud at the end instead of an aborted update.
* @return array Array of error messages (appid => Exception)
*/
public static function installShippedApps($softErrors = false, ?IOutput $output = null) {
public static function installShippedApps(bool $softErrors = false, ?IOutput $output = null): array {

Check warning on line 514 in lib/private/Installer.php

View check run for this annotation

Codecov / codecov/patch

lib/private/Installer.php#L514 

Added line #L514 was not covered by tests
if ($output instanceof IOutput) {
$output->debug('Installing shipped apps');
}
$appManager = \OC::$server->getAppManager();
$config = \OC::$server->getConfig();
$appManager = \OCP\Server::get(IAppManager::class);
$config = \OCP\Server::get(IConfig::class);

Check warning on line 519 in lib/private/Installer.php

View check run for this annotation

Codecov / codecov/patch

lib/private/Installer.php#L518-L519 

Added lines #L518 - L519 were not covered by tests
$errors = [];
foreach (\OC::$APPSROOTS as $app_dir) {
if ($dir = opendir($app_dir['path'])) {
Expand Down Expand Up @@ -584,20 +555,18 @@ public static function installShippedApps($softErrors = false, ?IOutput $output

/**
* install an app already placed in the app folder
* @param string $app id of the app to install
* @return string
*/
public static function installShippedApp($app, ?IOutput $output = null) {
public static function installShippedApp(string $app, ?IOutput $output = null): string|false {

Check warning on line 559 in lib/private/Installer.php

View check run for this annotation

Codecov / codecov/patch

lib/private/Installer.php#L559 

Added line #L559 was not covered by tests
if ($output instanceof IOutput) {
$output->debug('Installing ' . $app);
}
//install the database
$appPath = OC_App::getAppPath($app);
\OC_App::registerAutoloading($app, $appPath);

$config = \OC::$server->getConfig();
$config = \OCP\Server::get(IConfig::class);

Check warning on line 567 in lib/private/Installer.php

View check run for this annotation

Codecov / codecov/patch

lib/private/Installer.php#L567 

Added line #L567 was not covered by tests

$ms = new MigrationService($app, \OC::$server->get(Connection::class));
$ms = new MigrationService($app, \OCP\Server::get(Connection::class));

Check warning on line 569 in lib/private/Installer.php

View check run for this annotation

Codecov / codecov/patch

lib/private/Installer.php#L569 

Added line #L569 was not covered by tests
if ($output instanceof IOutput) {
$ms->setOutput($output);
}
Expand Down Expand Up @@ -636,10 +605,7 @@ public static function installShippedApp($app, ?IOutput $output = null) {
return $info['id'];
}

/**
* @param string $script
*/
private static function includeAppScript($script) {
private static function includeAppScript(string $script): void {
if (file_exists($script)) {
include $script;
}
Expand Down
4 changes: 1 addition & 3 deletions lib/private/legacy/OC_App.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -282,10 +282,8 @@ public function enable(string $appId,

/**
* Get the path where to install apps
*
* @return string|false
*/
public static function getInstallPath() {
public static function getInstallPath(): string|null {
foreach (OC::$APPSROOTS as $dir) {
if (isset($dir['writable']) && $dir['writable'] === true) {
return $dir['path'];
Expand Down

0 comments on commit 67e3ece

Please sign in to comment.