Skip to content

Commit 2198c72

Browse files
mahiariranimahiarirani
authored
feat(app): abstract application (#142)
- add: base app class - add: trait for dependency and telemetry - fix: install dependecny app with better management - refactor: clean app class - add: exception for installation issues
1 parent 0a8554b commit 2198c72

File tree

5 files changed

+196
-112
lines changed

5 files changed

+196
-112
lines changed

‎lib/AppInfo/Application.php‎

Lines changed: 7 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -25,49 +25,29 @@
2525

2626
use OC\Security\CSP\ContentSecurityPolicy;
2727
use OCA\Files\Event\LoadAdditionalScriptsEvent;
28-
use OCA\Files_External_Ethswarm\Exception\BaseException;
2928
use OCA\Files_External_Ethswarm\Utils\Env;
30-
use OCP\App\AppPathNotFoundException;
31-
use OCP\App\IAppManager;
32-
use OCP\AppFramework\App;
3329
use OCP\AppFramework\Bootstrap\IBootContext;
34-
use OCP\AppFramework\Bootstrap\IBootstrap;
3530
use OCP\AppFramework\Bootstrap\IRegistrationContext;
3631
use OCP\EventDispatcher\IEventDispatcher;
3732
use OCP\Exceptions\AppConfigException;
38-
use OCP\IConfig;
39-
use OCP\IURLGenerator;
4033
use OCP\Security\CSP\AddContentSecurityPolicyEvent;
4134
use OCP\Util;
42-
use Psr\Container\ContainerInterface;
43-
use Psr\Log\LoggerInterface;
44-
use Sentry;
4535

46-
class Application extends App implements IBootstrap {
36+
class Application extends BaseApp {
4737
public const NAME = 'files_external_ethswarm';
4838
public const API_URL = 'app.hejbit.com';
49-
public const TELEMETRY_URL = 'https://[email protected]/2';
50-
public const TELEMETRY_MINIMUM_SUPPORTED_NEXTCLOUD_VERSION = '30.0.0';
51-
public ContainerInterface $container;
52-
53-
private readonly IEventDispatcher $dispatcher;
54-
private LoggerInterface $logger;
55-
private IConfig $config;
5639

5740
/**
5841
* @throws AppConfigException
5942
*/
6043
public function __construct() {
6144
parent::__construct(Application::NAME);
62-
$this->logger = $this->getContainer()->get(LoggerInterface::class);
63-
$this->config = $this->getContainer()->get(IConfig::class);
64-
$this->dispatcher = $this->getContainer()->getServer()->get(IEventDispatcher::class);
65-
66-
$this->enableFilesExternalApp();
6745
}
6846

6947
public function boot(IBootContext $context): void {
70-
new ExternalStorage($this->getContainer(), $context);
48+
$this->installApp('files_external', 'external_mounts');
49+
50+
new ExternalStorage($this->container, $context);
7151

7252
$this->loadAssets($context);
7353
$this->configureTelemetry();
@@ -76,7 +56,9 @@ public function boot(IBootContext $context): void {
7656
public function register(IRegistrationContext $context): void {
7757
$this->loadTelemetry();
7858

79-
$this->dispatcher->addListener(
59+
/** @var IEventDispatcher $dispatcher */
60+
$dispatcher = $this->container->get(IEventDispatcher::class);
61+
$dispatcher->addListener(
8062
AddContentSecurityPolicyEvent::class,
8163
function (AddContentSecurityPolicyEvent $event): void {
8264
$policy = new ContentSecurityPolicy();
@@ -89,36 +71,6 @@ function (AddContentSecurityPolicyEvent $event): void {
8971
);
9072
}
9173

92-
/**
93-
* @throws AppConfigException
94-
*/
95-
private function enableFilesExternalApp(): void {
96-
/** @var IAppManager $appManager */
97-
$appManager = $this->getContainer()->get(IAppManager::class);
98-
if (!$appManager->isInstalled('files_external')) {
99-
try {
100-
$this->logger->info('External Storage Support app is not enabled, enabling it now');
101-
$appManager->enableApp('files_external');
102-
if ($appManager->isInstalled('files_external')) {
103-
$this->logger->info('External Storage support enabled');
104-
105-
return;
106-
}
107-
$this->logger->warning('Try enabling it now by force');
108-
$appManager->enableApp('files_external', true);
109-
if ($appManager->isInstalled('files_external')) {
110-
$this->logger->info('External Storage support enabled');
111-
112-
return;
113-
}
114-
$this->logger->error('Failed to enable External Storage Support app');
115-
} catch (AppPathNotFoundException $e) {
116-
}
117-
118-
throw new AppConfigException('External Storage Support app is required be installed and enabled. Please enable it to use this app.');
119-
}
120-
}
121-
12274
private function loadAssets($context): void {
12375
Util::addStyle(Application::NAME, 'app');
12476
Util::addScript(Application::NAME, 'nextcloud-swarm-plugin-settings');
@@ -130,61 +82,4 @@ private function loadAssets($context): void {
13082
Util::addInitScript(Application::NAME, 'nextcloud-swarm-plugin-app');
13183
});
13284
}
133-
134-
private function loadTelemetry(): void {
135-
// Register autoloader of sentry
136-
$autoloadPath = __DIR__.'/../../vendor-bin/sentry/vendor/autoload.php';
137-
if (!file_exists($autoloadPath)) {
138-
throw new BaseException('Vendor autoload.php not found at: '.$autoloadPath);
139-
}
140-
141-
require_once $autoloadPath;
142-
}
143-
144-
private function configureTelemetry(): void {
145-
// Initialize Sentry if telemetry is enabled and the nextcloud version is supported
146-
$environment = Env::get('ENV') ?? 'production';
147-
148-
// Get telemetry enabled status and current nextcloud version
149-
$currentNextcloudVersion = $this->config->getSystemValue('version');
150-
$isSupported = version_compare($currentNextcloudVersion, Application::TELEMETRY_MINIMUM_SUPPORTED_NEXTCLOUD_VERSION, '>=');
151-
152-
// if telemetry is not set, set it to true
153-
// but if it is set to false, don't override it
154-
if ('' === $this->config->getSystemValue('telemetry.enabled') && $isSupported) {
155-
$this->config->setSystemValue('telemetry.enabled', false);
156-
$this->logger->info('Telemetry option has not been set, setting it to true');
157-
}
158-
159-
if ($this->config->getSystemValue('telemetry.enabled') && $isSupported) {
160-
/** @var IAppManager $appManager */
161-
$appManager = $this->getContainer()->get(IAppManager::class);
162-
$appInfo = $appManager->getAppInfo(self::NAME);
163-
$pluginVersion = $appInfo['version'] ?? 'unknown';
164-
165-
/** @var IURLGenerator $urlGenerator */
166-
$urlGenerator = $this->getContainer()->get(IURLGenerator::class);
167-
$instanceUrl = $urlGenerator->getAbsoluteURL('/');
168-
169-
Sentry\init([
170-
'dsn' => Application::TELEMETRY_URL,
171-
'traces_sample_rate' => 1.0,
172-
'environment' => $environment,
173-
'default_integrations' => false, // Disable default integrations to avoid sending unnecessary data
174-
'release' => $pluginVersion,
175-
'server_name' => $instanceUrl,
176-
]);
177-
178-
// Set nextcloud version as a Sentry tag
179-
Sentry\configureScope(function (Sentry\State\Scope $scope) use ($currentNextcloudVersion): void {
180-
$scope->setTag('nextcloud_version', $currentNextcloudVersion);
181-
});
182-
183-
$this->logger->info('Telemetry is enabled and the nextcloud version is supported');
184-
} elseif ($this->config->getSystemValue('telemetry.enabled') && !$isSupported) {
185-
$this->logger->info('Telemetry is enabled but the nextcloud version '.$currentNextcloudVersion.' is not supported');
186-
} elseif (false === $this->config->getSystemValue('telemetry.enabled')) {
187-
$this->logger->info('Telemetry is disabled');
188-
}
189-
}
19085
}

‎lib/AppInfo/BaseApp.php‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?php
2+
3+
namespace OCA\Files_External_Ethswarm\AppInfo;
4+
5+
use OCP\AppFramework\App;
6+
use OCP\AppFramework\Bootstrap\IBootstrap;
7+
use Psr\Container\ContainerInterface;
8+
use Psr\Log\LoggerInterface;
9+
10+
abstract class BaseApp extends App implements IBootstrap {
11+
use Dependency;
12+
use Telemetry;
13+
14+
public ContainerInterface $container;
15+
protected LoggerInterface $logger;
16+
17+
public function __construct() {
18+
parent::__construct(Application::NAME);
19+
$this->container = $this->getContainer();
20+
$this->logger = $this->container->get(LoggerInterface::class);
21+
}
22+
}

‎lib/AppInfo/Dependency.php‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<?php
2+
3+
namespace OCA\Files_External_Ethswarm\AppInfo;
4+
5+
use Exception;
6+
use OC\Installer;
7+
use OCA\Files_External_Ethswarm\Exception\AppDependencyException;
8+
use OCP\App\IAppManager;
9+
use OCP\IDBConnection;
10+
11+
trait Dependency {
12+
protected function installApp(string $app, ?string $table = null): void {
13+
/** @var IAppManager $appManager */
14+
$appManager = $this->container->get(IAppManager::class);
15+
16+
/** @var Installer $installer */
17+
$installer = $this->container->get(Installer::class);
18+
19+
if (!$appManager->isInstalled($app)) {
20+
$this->logger->info($app.' is not installed, installing it now');
21+
22+
try {
23+
// Installing
24+
if ($table) {
25+
if (!$this->checkTableExists($table)) {
26+
$installer->installApp($app);
27+
}
28+
if (!$this->checkTableExists($table)) {
29+
$this->logger->error($app.' table '.$table.' does not exist, '.$app.' installation failed');
30+
31+
throw new AppDependencyException();
32+
}
33+
} else {
34+
$installer->installApp($app);
35+
}
36+
37+
// Enabling
38+
if (!$appManager->isInstalled($app)) {
39+
$this->logger->info($app.' is not enabled, enabling it now');
40+
$appManager->enableApp($app);
41+
42+
if (!$appManager->isInstalled($app)) {
43+
$this->logger->warning('Try enabling '.$app.' forcefully');
44+
$appManager->enableApp($app, true);
45+
46+
if (!$appManager->isInstalled($app)) {
47+
$this->logger->error($app.' enabling failed');
48+
49+
throw new AppDependencyException();
50+
}
51+
}
52+
}
53+
54+
// Loading
55+
if (!$appManager->isAppLoaded($app)) {
56+
$this->logger->info($app.' is not loaded, loading it now');
57+
$appManager->loadApp($app);
58+
}
59+
if (!$appManager->isAppLoaded($app)) {
60+
$this->logger->error($app.' loading failed');
61+
62+
throw new AppDependencyException();
63+
}
64+
} catch (Exception $e) {
65+
$this->logger->error($e->getMessage());
66+
67+
throw new AppDependencyException($e->getMessage());
68+
}
69+
}
70+
}
71+
72+
private function checkTableExists(string $table): bool {
73+
/** @var IDBConnection $connection */
74+
$connection = $this->container->get(IDBConnection::class);
75+
76+
return $connection->tableExists($table);
77+
}
78+
}

‎lib/AppInfo/Telemetry.php‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<?php
2+
3+
namespace OCA\Files_External_Ethswarm\AppInfo;
4+
5+
use OCA\Files_External_Ethswarm\Exception\BaseException;
6+
use OCA\Files_External_Ethswarm\Utils\Env;
7+
use OCP\App\IAppManager;
8+
use OCP\IConfig;
9+
use OCP\IURLGenerator;
10+
use Sentry;
11+
use Sentry\State;
12+
13+
trait Telemetry {
14+
public const TELEMETRY_URL = 'https://[email protected]/2';
15+
public const TELEMETRY_MINIMUM_SUPPORTED_NEXTCLOUD_VERSION = '30.0.0';
16+
17+
protected function loadTelemetry(): void {
18+
// Register autoloader of sentry
19+
$autoloadPath = __DIR__.'/../../vendor-bin/sentry/vendor/autoload.php';
20+
if (!file_exists($autoloadPath)) {
21+
throw new BaseException('Vendor autoload.php not found at: '.$autoloadPath);
22+
}
23+
24+
require_once $autoloadPath;
25+
}
26+
27+
protected function configureTelemetry(): void {
28+
// Initialize Sentry if telemetry is enabled and the nextcloud version is supported
29+
$environment = Env::get('ENV') ?? 'production';
30+
31+
/** @var IConfig $config */
32+
$config = $this->container->get(IConfig::class);
33+
34+
// Get telemetry enabled status and current nextcloud version
35+
$currentNextcloudVersion = $config->getSystemValue('version');
36+
$isSupported = version_compare($currentNextcloudVersion, Application::TELEMETRY_MINIMUM_SUPPORTED_NEXTCLOUD_VERSION, '>=');
37+
38+
// if telemetry is not set, set it to true
39+
// but if it is set to false, don't override it
40+
if ('' === $config->getSystemValue('telemetry.enabled') && $isSupported) {
41+
$config->setSystemValue('telemetry.enabled', false);
42+
$this->logger->info('Telemetry option has not been set, setting it to true');
43+
}
44+
45+
if ($config->getSystemValue('telemetry.enabled') && $isSupported) {
46+
/** @var IAppManager $appManager */
47+
$appManager = $this->container->get(IAppManager::class);
48+
$appInfo = $appManager->getAppInfo(parent::NAME);
49+
$pluginVersion = $appInfo['version'] ?? 'unknown';
50+
51+
/** @var IURLGenerator $urlGenerator */
52+
$urlGenerator = $this->container->get(IURLGenerator::class);
53+
$instanceUrl = $urlGenerator->getAbsoluteURL('/');
54+
55+
Sentry\init([
56+
'dsn' => Application::TELEMETRY_URL,
57+
'traces_sample_rate' => 1.0,
58+
'environment' => $environment,
59+
'default_integrations' => false, // Disable default integrations to avoid sending unnecessary data
60+
'release' => $pluginVersion,
61+
'server_name' => $instanceUrl,
62+
]);
63+
64+
// Set nextcloud version as a Sentry tag
65+
Sentry\configureScope(function (State\Scope $scope) use ($currentNextcloudVersion): void {
66+
$scope->setTag('nextcloud_version', $currentNextcloudVersion);
67+
});
68+
69+
$this->logger->info('Telemetry is enabled and the nextcloud version is supported');
70+
} elseif ($config->getSystemValue('telemetry.enabled') && !$isSupported) {
71+
$this->logger->info('Telemetry is enabled but the nextcloud version '.$currentNextcloudVersion.' is not supported');
72+
} elseif (false === $config->getSystemValue('telemetry.enabled')) {
73+
$this->logger->info('Telemetry is disabled');
74+
}
75+
}
76+
}

‎lib/Exception/AppDependencyException.php‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?php
2+
3+
namespace OCA\Files_External_Ethswarm\Exception;
4+
5+
use Exception;
6+
7+
class AppDependencyException extends BaseException {
8+
public const MESSAGE = 'External Storage Support app is required be installed and enabled. Please enable it to use this app.';
9+
10+
public function __construct($message = self::MESSAGE, $code = 0, ?Exception $previous = null) {
11+
parent::__construct($message, $code, $previous);
12+
}
13+
}

0 commit comments

Comments
 (0)