Skip to content

Add dedicated API for apps' bootstrapping process #20865

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChristophWurst merged 6 commits into from
Jun 17, 2020
Merged

Add dedicated API for apps' bootstrapping process #20865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
69571fb
Add dedicated API for apps' bootstrapping process
ChristophWurst May 7, 2020
0a24d1f
Migrate Comments to the new bootstrap mechanism
ChristophWurst Jun 5, 2020
0587010
Migrate Accessibility app to new bootstrap mechanism
ChristophWurst Jun 8, 2020
16ab798
Migrate Admin Audit app to new bootstrap mechanism
ChristophWurst Jun 8, 2020
c5d2958
Migrate Settings to new bootstrap mechanism
ChristophWurst Jun 8, 2020
a2c8bfa
Migrate Two-Factor Backup Codes to new bootstrap mechanism
ChristophWurst Jun 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 44 additions & 17 deletions apps/accessibility/lib/AppInfo/Application.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
<?php

declare(strict_types=1);

/**
* @copyright Copyright (c) 2018 John Molakvoæ <[email protected]>
*
Expand Down Expand Up @@ -27,14 +30,21 @@
namespace OCA\Accessibility\AppInfo;

use OCP\AppFramework\App;
use OCP\AppFramework\Bootstrap\IBootContext;
use OCP\AppFramework\Bootstrap\IBootstrap;
use OCP\AppFramework\Bootstrap\IRegistrationContext;
use OCP\IConfig;
use OCP\IServerContainer;
use OCP\IURLGenerator;
use OCP\IUserSession;
use function count;
use function implode;
use function md5;

class Application extends App {
class Application extends App implements IBootstrap {

/** @var string */
public const APP_NAME = 'accessibility';
public const APP_ID = 'accessibility';

/** @var IConfig */
private $config;
Expand All @@ -46,39 +56,56 @@ class Application extends App {
private $urlGenerator;

public function __construct() {
parent::__construct(self::APP_NAME);
$this->config = \OC::$server->getConfig();
$this->userSession = \OC::$server->getUserSession();
$this->urlGenerator = \OC::$server->getURLGenerator();
parent::__construct(self::APP_ID);
}

public function register(IRegistrationContext $context): void {
}

public function boot(IBootContext $context): void {
$this->injectCss(
$context->getAppContainer()->query(IUserSession::class),
$context->getAppContainer()->query(IConfig::class),
$context->getAppContainer()->query(IURLGenerator::class)
);
$this->injectJavascript(
$context->getAppContainer()->query(IURLGenerator::class),
$context->getAppContainer()->query(IConfig::class),
$context->getServerContainer()
);
}

public function injectCss() {
private function injectCss(IUserSession $userSession,
IConfig $config,
IURLGenerator $urlGenerator) {
// Inject the fake css on all pages if enabled and user is logged
$loggedUser = $this->userSession->getUser();
if (!is_null($loggedUser)) {
$userValues = $this->config->getUserKeys($loggedUser->getUID(), self::APP_NAME);
$loggedUser = $userSession->getUser();
if ($loggedUser !== null) {
$userValues = $config->getUserKeys($loggedUser->getUID(), self::APP_ID);
// we want to check if any theme or font is enabled.
if (count($userValues) > 0) {
$hash = $this->config->getUserValue($loggedUser->getUID(), self::APP_NAME, 'icons-css', md5(implode('-', $userValues)));
$linkToCSS = $this->urlGenerator->linkToRoute(self::APP_NAME . '.accessibility.getCss', ['md5' => $hash]);
$hash = $config->getUserValue($loggedUser->getUID(), self::APP_ID, 'icons-css', md5(implode('-', $userValues)));
$linkToCSS = $urlGenerator->linkToRoute(self::APP_ID . '.accessibility.getCss', ['md5' => $hash]);
\OCP\Util::addHeader('link', ['rel' => 'stylesheet', 'href' => $linkToCSS]);
}
}
}

public function injectJavascript() {
$linkToJs = $this->urlGenerator->linkToRoute(
self::APP_NAME . '.accessibility.getJavascript',
private function injectJavascript(IURLGenerator $urlGenerator,
IConfig $config,
IServerContainer $serverContainer) {
$linkToJs = $urlGenerator->linkToRoute(
self::APP_ID . '.accessibility.getJavascript',
[
'v' => \OC::$server->getConfig()->getAppValue('accessibility', 'cachebuster', '0'),
'v' => $config->getAppValue(self::APP_ID, 'cachebuster', '0'),
]
);

\OCP\Util::addHeader(
'script',
[
'src' => $linkToJs,
'nonce' => \OC::$server->getContentSecurityPolicyNonceManager()->getNonce()
'nonce' => $serverContainer->getContentSecurityPolicyNonceManager()->getNonce()
],
''
);
Expand Down
8 changes: 4 additions & 4 deletions apps/accessibility/lib/Migration/RepairUserConfig.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,13 @@ public function getName() {
public function run(IOutput $output) {
$output->startProgress();
$this->userManager->callForSeenUsers(function (IUser $user) use ($output) {
$theme = $this->config->getUserValue($user->getUID(), Application::APP_NAME, 'theme', false);
$theme = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'theme', false);
if ($theme === 'themedark') {
$this->config->setUserValue($user->getUID(), Application::APP_NAME, 'theme', 'dark');
$this->config->setUserValue($user->getUID(), Application::APP_ID, 'theme', 'dark');
}
if ($theme === 'themehighcontrast') {
$this->config->setUserValue($user->getUID(), Application::APP_NAME, 'highcontrast', 'highcontrast');
$this->config->deleteUserValue($user->getUID(), Application::APP_NAME, 'theme');
$this->config->setUserValue($user->getUID(), Application::APP_ID, 'highcontrast', 'highcontrast');
$this->config->deleteUserValue($user->getUID(), Application::APP_ID, 'theme');
}
$output->advance();
});
Expand Down
158 changes: 91 additions & 67 deletions apps/admin_audit/lib/AppInfo/Application.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,90 +49,110 @@
use OCA\AdminAudit\Actions\Versions;
use OCP\App\ManagerEvent;
use OCP\AppFramework\App;
use OCP\AppFramework\Bootstrap\IBootContext;
use OCP\AppFramework\Bootstrap\IBootstrap;
use OCP\AppFramework\Bootstrap\IRegistrationContext;
use OCP\Authentication\TwoFactorAuth\IProvider;
use OCP\Console\ConsoleEvent;
use OCP\IConfig;
use OCP\IGroupManager;
use OCP\ILogger;
use OCP\IPreview;
use OCP\IServerContainer;
use OCP\IUserSession;
use OCP\Log\ILogFactory;
use OCP\Share;
use OCP\Util;
use Symfony\Component\EventDispatcher\GenericEvent;

class Application extends App {
class Application extends App implements IBootstrap {

/** @var ILogger */
protected $logger;

public function __construct() {
parent::__construct('admin_audit');
$this->initLogger();
}

public function initLogger() {
$c = $this->getContainer()->getServer();
$config = $c->getConfig();
public function register(IRegistrationContext $context): void {
}

public function boot(IBootContext $context): void {
$logger = $this->getLogger(
$context->getAppContainer()->query(IConfig::class),
$context->getAppContainer()->query(ILogger::class),
$context->getAppContainer()->query(ILogFactory::class)
);

/*
* TODO: once the hooks are migrated to lazy events, this should be done
* in \OCA\AdminAudit\AppInfo\Application::register
*/
$this->registerHooks($logger, $context->getServerContainer());
}

private function getLogger(IConfig $config,
ILogger $logger,
ILogFactory $logFactory): ILogger {
$default = $config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/audit.log';
$logFile = $config->getAppValue('admin_audit', 'logfile', $default);

if ($logFile === null) {
$this->logger = $c->getLogger();
return;
return $logger;
}
$this->logger = $c->getLogFactory()->getCustomLogger($logFile);
}

public function register() {
$this->registerHooks();
return $logFactory->getCustomLogger($logFile);
}

/**
* Register hooks in order to log them
*/
protected function registerHooks() {
$this->userManagementHooks();
$this->groupHooks();
$this->authHooks();
private function registerHooks(ILogger $logger,
IServerContainer $serverContainer) {
$this->userManagementHooks($logger, $serverContainer);
$this->groupHooks($logger, $serverContainer);
$this->authHooks($logger);

$this->consoleHooks();
$this->appHooks();
$this->consoleHooks($logger, $serverContainer);
$this->appHooks($logger, $serverContainer);

$this->sharingHooks();
$this->sharingHooks($logger);

$this->fileHooks();
$this->trashbinHooks();
$this->versionsHooks();
$this->fileHooks($logger, $serverContainer);
$this->trashbinHooks($logger);
$this->versionsHooks($logger);

$this->securityHooks();
$this->securityHooks($logger, $serverContainer);
}

protected function userManagementHooks() {
$userActions = new UserManagement($this->logger);
private function userManagementHooks(ILogger $logger,
IServerContainer $serverContainer) {
$userActions = new UserManagement($logger);

Util::connectHook('OC_User', 'post_createUser', $userActions, 'create');
Util::connectHook('OC_User', 'post_deleteUser', $userActions, 'delete');
Util::connectHook('OC_User', 'changeUser', $userActions, 'change');
Util::connectHook('OC_User', 'post_createUser', $userActions, 'create');
Util::connectHook('OC_User', 'post_deleteUser', $userActions, 'delete');
Util::connectHook('OC_User', 'changeUser', $userActions, 'change');

/** @var IUserSession|Session $userSession */
$userSession = $this->getContainer()->getServer()->getUserSession();
$userSession = $serverContainer->getUserSession();
$userSession->listen('\OC\User', 'postSetPassword', [$userActions, 'setPassword']);
$userSession->listen('\OC\User', 'assignedUserId', [$userActions, 'assign']);
$userSession->listen('\OC\User', 'postUnassignedUserId', [$userActions, 'unassign']);
}

protected function groupHooks() {
$groupActions = new GroupManagement($this->logger);
private function groupHooks(ILogger $logger,
IServerContainer $serverContainer) {
$groupActions = new GroupManagement($logger);

/** @var IGroupManager|Manager $groupManager */
$groupManager = $this->getContainer()->getServer()->getGroupManager();
$groupManager->listen('\OC\Group', 'postRemoveUser', [$groupActions, 'removeUser']);
$groupManager->listen('\OC\Group', 'postAddUser', [$groupActions, 'addUser']);
$groupManager->listen('\OC\Group', 'postDelete', [$groupActions, 'deleteGroup']);
$groupManager->listen('\OC\Group', 'postCreate', [$groupActions, 'createGroup']);
$groupManager = $serverContainer->getGroupManager();
$groupManager->listen('\OC\Group', 'postRemoveUser', [$groupActions, 'removeUser']);
$groupManager->listen('\OC\Group', 'postAddUser', [$groupActions, 'addUser']);
$groupManager->listen('\OC\Group', 'postDelete', [$groupActions, 'deleteGroup']);
$groupManager->listen('\OC\Group', 'postCreate', [$groupActions, 'createGroup']);
}

protected function sharingHooks() {
$shareActions = new Sharing($this->logger);
private function sharingHooks(ILogger $logger) {
$shareActions = new Sharing($logger);

Util::connectHook(Share::class, 'post_shared', $shareActions, 'shared');
Util::connectHook(Share::class, 'post_unshare', $shareActions, 'unshare');
Expand All @@ -143,41 +163,44 @@ protected function sharingHooks() {
Util::connectHook(Share::class, 'share_link_access', $shareActions, 'shareAccessed');
}

protected function authHooks() {
$authActions = new Auth($this->logger);
private function authHooks(ILogger $logger) {
$authActions = new Auth($logger);

Util::connectHook('OC_User', 'pre_login', $authActions, 'loginAttempt');
Util::connectHook('OC_User', 'post_login', $authActions, 'loginSuccessful');
Util::connectHook('OC_User', 'logout', $authActions, 'logout');
}

protected function appHooks() {
$eventDispatcher = $this->getContainer()->getServer()->getEventDispatcher();
$eventDispatcher->addListener(ManagerEvent::EVENT_APP_ENABLE, function (ManagerEvent $event) {
$appActions = new AppManagement($this->logger);
private function appHooks(ILogger $logger,
IServerContainer $serverContainer) {
$eventDispatcher = $serverContainer->getEventDispatcher();
$eventDispatcher->addListener(ManagerEvent::EVENT_APP_ENABLE, function (ManagerEvent $event) use ($logger) {
$appActions = new AppManagement($logger);
$appActions->enableApp($event->getAppID());
});
$eventDispatcher->addListener(ManagerEvent::EVENT_APP_ENABLE_FOR_GROUPS, function (ManagerEvent $event) {
$appActions = new AppManagement($this->logger);
$eventDispatcher->addListener(ManagerEvent::EVENT_APP_ENABLE_FOR_GROUPS, function (ManagerEvent $event) use ($logger) {
$appActions = new AppManagement($logger);
$appActions->enableAppForGroups($event->getAppID(), $event->getGroups());
});
$eventDispatcher->addListener(ManagerEvent::EVENT_APP_DISABLE, function (ManagerEvent $event) {
$appActions = new AppManagement($this->logger);
$eventDispatcher->addListener(ManagerEvent::EVENT_APP_DISABLE, function (ManagerEvent $event) use ($logger) {
$appActions = new AppManagement($logger);
$appActions->disableApp($event->getAppID());
});
}

protected function consoleHooks() {
$eventDispatcher = $this->getContainer()->getServer()->getEventDispatcher();
$eventDispatcher->addListener(ConsoleEvent::EVENT_RUN, function (ConsoleEvent $event) {
$appActions = new Console($this->logger);
private function consoleHooks(ILogger $logger,
IServerContainer $serverContainer) {
$eventDispatcher = $serverContainer->getEventDispatcher();
$eventDispatcher->addListener(ConsoleEvent::EVENT_RUN, function (ConsoleEvent $event) use ($logger) {
$appActions = new Console($logger);
$appActions->runCommand($event->getArguments());
});
}

protected function fileHooks() {
$fileActions = new Files($this->logger);
$eventDispatcher = $this->getContainer()->getServer()->getEventDispatcher();
private function fileHooks(ILogger $logger,
IServerContainer $serverContainer) {
$fileActions = new Files($logger);
$eventDispatcher = $serverContainer->getEventDispatcher();
$eventDispatcher->addListener(
IPreview::EVENT,
function (GenericEvent $event) use ($fileActions) {
Expand All @@ -188,7 +211,7 @@ function (GenericEvent $event) use ($fileActions) {
'width' => $event->getArguments()['width'],
'height' => $event->getArguments()['height'],
'crop' => $event->getArguments()['crop'],
'mode' => $event->getArguments()['mode']
'mode' => $event->getArguments()['mode']
]);
}
);
Expand Down Expand Up @@ -237,26 +260,27 @@ function (GenericEvent $event) use ($fileActions) {
);
}

protected function versionsHooks() {
$versionsActions = new Versions($this->logger);
private function versionsHooks(ILogger $logger) {
$versionsActions = new Versions($logger);
Util::connectHook('\OCP\Versions', 'rollback', $versionsActions, 'rollback');
Util::connectHook('\OCP\Versions', 'delete',$versionsActions, 'delete');
Util::connectHook('\OCP\Versions', 'delete', $versionsActions, 'delete');
}

protected function trashbinHooks() {
$trashActions = new Trashbin($this->logger);
private function trashbinHooks(ILogger $logger) {
$trashActions = new Trashbin($logger);
Util::connectHook('\OCP\Trashbin', 'preDelete', $trashActions, 'delete');
Util::connectHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', $trashActions, 'restore');
}

protected function securityHooks() {
$eventDispatcher = $this->getContainer()->getServer()->getEventDispatcher();
$eventDispatcher->addListener(IProvider::EVENT_SUCCESS, function (GenericEvent $event) {
$security = new Security($this->logger);
private function securityHooks(ILogger $logger,
IServerContainer $serverContainer) {
$eventDispatcher = $serverContainer->getEventDispatcher();
$eventDispatcher->addListener(IProvider::EVENT_SUCCESS, function (GenericEvent $event) use ($logger) {
$security = new Security($logger);
$security->twofactorSuccess($event->getSubject(), $event->getArguments());
});
$eventDispatcher->addListener(IProvider::EVENT_FAILED, function (GenericEvent $event) {
$security = new Security($this->logger);
$eventDispatcher->addListener(IProvider::EVENT_FAILED, function (GenericEvent $event) use ($logger) {
$security = new Security($logger);
$security->twofactorFailed($event->getSubject(), $event->getArguments());
});
}
Expand Down
1 change: 1 addition & 0 deletions apps/comments/composer/composer/autoload_classmap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
'OCA\\Comments\\Controller\\Notifications' => $baseDir . '/../lib/Controller/Notifications.php',
'OCA\\Comments\\EventHandler' => $baseDir . '/../lib/EventHandler.php',
'OCA\\Comments\\JSSettingsHelper' => $baseDir . '/../lib/JSSettingsHelper.php',
'OCA\\Comments\\Listener\\CommentsEntityEventListener' => $baseDir . '/../lib/Listener/CommentsEntityEventListener.php',
'OCA\\Comments\\Listener\\LoadAdditionalScripts' => $baseDir . '/../lib/Listener/LoadAdditionalScripts.php',
'OCA\\Comments\\Listener\\LoadSidebarScripts' => $baseDir . '/../lib/Listener/LoadSidebarScripts.php',
'OCA\\Comments\\Notification\\Listener' => $baseDir . '/../lib/Notification/Listener.php',
Expand Down
1 change: 1 addition & 0 deletions apps/comments/composer/composer/autoload_static.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ class ComposerStaticInitComments
'OCA\\Comments\\Controller\\Notifications' => __DIR__ . '/..' . '/../lib/Controller/Notifications.php',
'OCA\\Comments\\EventHandler' => __DIR__ . '/..' . '/../lib/EventHandler.php',
'OCA\\Comments\\JSSettingsHelper' => __DIR__ . '/..' . '/../lib/JSSettingsHelper.php',
'OCA\\Comments\\Listener\\CommentsEntityEventListener' => __DIR__ . '/..' . '/../lib/Listener/CommentsEntityEventListener.php',
'OCA\\Comments\\Listener\\LoadAdditionalScripts' => __DIR__ . '/..' . '/../lib/Listener/LoadAdditionalScripts.php',
'OCA\\Comments\\Listener\\LoadSidebarScripts' => __DIR__ . '/..' . '/../lib/Listener/LoadSidebarScripts.php',
'OCA\\Comments\\Notification\\Listener' => __DIR__ . '/..' . '/../lib/Notification/Listener.php',
Expand Down
Loading