123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878 |
- <?php
- namespace OC\App;
- use InvalidArgumentException;
- use OC\AppConfig;
- use OC\AppFramework\Bootstrap\Coordinator;
- use OC\ServerNotAvailableException;
- use OCP\Activity\IManager as IActivityManager;
- use OCP\App\AppPathNotFoundException;
- use OCP\App\Events\AppDisableEvent;
- use OCP\App\Events\AppEnableEvent;
- use OCP\App\IAppManager;
- use OCP\App\ManagerEvent;
- use OCP\EventDispatcher\IEventDispatcher;
- use OCP\Collaboration\AutoComplete\IManager as IAutoCompleteManager;
- use OCP\Collaboration\Collaborators\ISearch as ICollaboratorSearch;
- use OCP\Diagnostics\IEventLogger;
- use OCP\ICacheFactory;
- use OCP\IConfig;
- use OCP\IGroup;
- use OCP\IGroupManager;
- use OCP\IUser;
- use OCP\IUserSession;
- use OCP\Settings\IManager as ISettingsManager;
- use Psr\Log\LoggerInterface;
- class AppManager implements IAppManager {
-
- protected $protectedAppTypes = [
- 'filesystem',
- 'prelogin',
- 'authentication',
- 'logging',
- 'prevent_group_restriction',
- ];
- private IUserSession $userSession;
- private IConfig $config;
- private AppConfig $appConfig;
- private IGroupManager $groupManager;
- private ICacheFactory $memCacheFactory;
- private IEventDispatcher $dispatcher;
- private LoggerInterface $logger;
-
- private array $installedAppsCache = [];
-
- private ?array $shippedApps = null;
- private array $alwaysEnabled = [];
- private array $defaultEnabled = [];
-
- private array $appInfos = [];
-
- private array $appVersions = [];
-
- private array $autoDisabledApps = [];
- private array $appTypes = [];
-
- private array $loadedApps = [];
- public function __construct(IUserSession $userSession,
- IConfig $config,
- AppConfig $appConfig,
- IGroupManager $groupManager,
- ICacheFactory $memCacheFactory,
- IEventDispatcher $dispatcher,
- LoggerInterface $logger) {
- $this->userSession = $userSession;
- $this->config = $config;
- $this->appConfig = $appConfig;
- $this->groupManager = $groupManager;
- $this->memCacheFactory = $memCacheFactory;
- $this->dispatcher = $dispatcher;
- $this->logger = $logger;
- }
-
- private function getInstalledAppsValues(): array {
- if (!$this->installedAppsCache) {
- $values = $this->appConfig->getValues(false, 'enabled');
- $alwaysEnabledApps = $this->getAlwaysEnabledApps();
- foreach ($alwaysEnabledApps as $appId) {
- $values[$appId] = 'yes';
- }
- $this->installedAppsCache = array_filter($values, function ($value) {
- return $value !== 'no';
- });
- ksort($this->installedAppsCache);
- }
- return $this->installedAppsCache;
- }
-
- public function getInstalledApps() {
- return array_keys($this->getInstalledAppsValues());
- }
-
- public function getEnabledAppsForUser(IUser $user) {
- $apps = $this->getInstalledAppsValues();
- $appsForUser = array_filter($apps, function ($enabled) use ($user) {
- return $this->checkAppForUser($enabled, $user);
- });
- return array_keys($appsForUser);
- }
-
- public function getEnabledAppsForGroup(IGroup $group): array {
- $apps = $this->getInstalledAppsValues();
- $appsForGroups = array_filter($apps, function ($enabled) use ($group) {
- return $this->checkAppForGroups($enabled, $group);
- });
- return array_keys($appsForGroups);
- }
-
- public function loadApps(array $types = []): bool {
- if ($this->config->getSystemValueBool('maintenance', false)) {
- return false;
- }
-
- $apps = \OC_App::getEnabledApps();
-
- foreach ($apps as $app) {
-
- if (!$this->isAppLoaded($app)) {
- $path = \OC_App::getAppPath($app);
- if ($path !== false) {
- \OC_App::registerAutoloading($app, $path);
- }
- }
- }
-
- ob_start();
- foreach ($apps as $app) {
- if (!$this->isAppLoaded($app) && ($types === [] || $this->isType($app, $types))) {
- try {
- $this->loadApp($app);
- } catch (\Throwable $e) {
- $this->logger->emergency('Error during app loading: ' . $e->getMessage(), [
- 'exception' => $e,
- 'app' => $app,
- ]);
- }
- }
- }
- ob_end_clean();
- return true;
- }
-
- public function isType(string $app, array $types): bool {
- $appTypes = $this->getAppTypes($app);
- foreach ($types as $type) {
- if (in_array($type, $appTypes, true)) {
- return true;
- }
- }
- return false;
- }
-
- private function getAppTypes(string $app): array {
-
- if (count($this->appTypes) === 0) {
- $this->appTypes = $this->appConfig->getValues(false, 'types') ?: [];
- }
- if (isset($this->appTypes[$app])) {
- return explode(',', $this->appTypes[$app]);
- }
- return [];
- }
-
- public function getAutoDisabledApps(): array {
- return $this->autoDisabledApps;
- }
-
- public function getAppRestriction(string $appId): array {
- $values = $this->getInstalledAppsValues();
- if (!isset($values[$appId])) {
- return [];
- }
- if ($values[$appId] === 'yes' || $values[$appId] === 'no') {
- return [];
- }
- return json_decode($values[$appId], true);
- }
-
- public function isEnabledForUser($appId, $user = null) {
- if ($this->isAlwaysEnabled($appId)) {
- return true;
- }
- if ($user === null) {
- $user = $this->userSession->getUser();
- }
- $installedApps = $this->getInstalledAppsValues();
- if (isset($installedApps[$appId])) {
- return $this->checkAppForUser($installedApps[$appId], $user);
- } else {
- return false;
- }
- }
- private function checkAppForUser(string $enabled, ?IUser $user): bool {
- if ($enabled === 'yes') {
- return true;
- } elseif ($user === null) {
- return false;
- } else {
- if (empty($enabled)) {
- return false;
- }
- $groupIds = json_decode($enabled);
- if (!is_array($groupIds)) {
- $jsonError = json_last_error();
- $this->logger->warning('AppManger::checkAppForUser - can\'t decode group IDs: ' . print_r($enabled, true) . ' - json error code: ' . $jsonError);
- return false;
- }
- $userGroups = $this->groupManager->getUserGroupIds($user);
- foreach ($userGroups as $groupId) {
- if (in_array($groupId, $groupIds, true)) {
- return true;
- }
- }
- return false;
- }
- }
- private function checkAppForGroups(string $enabled, IGroup $group): bool {
- if ($enabled === 'yes') {
- return true;
- } else {
- if (empty($enabled)) {
- return false;
- }
- $groupIds = json_decode($enabled);
- if (!is_array($groupIds)) {
- $jsonError = json_last_error();
- $this->logger->warning('AppManger::checkAppForUser - can\'t decode group IDs: ' . print_r($enabled, true) . ' - json error code: ' . $jsonError);
- return false;
- }
- return in_array($group->getGID(), $groupIds);
- }
- }
-
- public function isInstalled($appId) {
- $installedApps = $this->getInstalledAppsValues();
- return isset($installedApps[$appId]);
- }
- public function ignoreNextcloudRequirementForApp(string $appId): void {
- $ignoreMaxApps = $this->config->getSystemValue('app_install_overwrite', []);
- if (!in_array($appId, $ignoreMaxApps, true)) {
- $ignoreMaxApps[] = $appId;
- $this->config->setSystemValue('app_install_overwrite', $ignoreMaxApps);
- }
- }
- public function loadApp(string $app): void {
- if (isset($this->loadedApps[$app])) {
- return;
- }
- $this->loadedApps[$app] = true;
- $appPath = \OC_App::getAppPath($app);
- if ($appPath === false) {
- return;
- }
- $eventLogger = \OC::$server->get(\OCP\Diagnostics\IEventLogger::class);
- $eventLogger->start("bootstrap:load_app:$app", "Load $app");
-
- \OC_App::registerAutoloading($app, $appPath);
-
- $coordinator = \OC::$server->get(Coordinator::class);
- $isBootable = $coordinator->isBootable($app);
- $hasAppPhpFile = is_file($appPath . '/appinfo/app.php');
- $eventLogger = \OC::$server->get(IEventLogger::class);
- $eventLogger->start('bootstrap:load_app_' . $app, 'Load app: ' . $app);
- if ($isBootable && $hasAppPhpFile) {
- $this->logger->error('/appinfo/app.php is not loaded when \OCP\AppFramework\Bootstrap\IBootstrap on the application class is used. Migrate everything from app.php to the Application class.', [
- 'app' => $app,
- ]);
- } elseif ($hasAppPhpFile) {
- $eventLogger->start("bootstrap:load_app:$app:app.php", "Load legacy app.php app $app");
- $this->logger->debug('/appinfo/app.php is deprecated, use \OCP\AppFramework\Bootstrap\IBootstrap on the application class instead.', [
- 'app' => $app,
- ]);
- try {
- self::requireAppFile($appPath);
- } catch (\Throwable $ex) {
- if ($ex instanceof ServerNotAvailableException) {
- throw $ex;
- }
- if (!$this->isShipped($app) && !$this->isType($app, ['authentication'])) {
- $this->logger->error("App $app threw an error during app.php load and will be disabled: " . $ex->getMessage(), [
- 'exception' => $ex,
- ]);
-
- $this->disableApp($app, true);
- } else {
- $this->logger->error("App $app threw an error during app.php load: " . $ex->getMessage(), [
- 'exception' => $ex,
- ]);
- }
- }
- $eventLogger->end("bootstrap:load_app:$app:app.php");
- }
- $coordinator->bootApp($app);
- $eventLogger->start("bootstrap:load_app:$app:info", "Load info.xml for $app and register any services defined in it");
- $info = $this->getAppInfo($app);
- if (!empty($info['activity'])) {
- $activityManager = \OC::$server->get(IActivityManager::class);
- if (!empty($info['activity']['filters'])) {
- foreach ($info['activity']['filters'] as $filter) {
- $activityManager->registerFilter($filter);
- }
- }
- if (!empty($info['activity']['settings'])) {
- foreach ($info['activity']['settings'] as $setting) {
- $activityManager->registerSetting($setting);
- }
- }
- if (!empty($info['activity']['providers'])) {
- foreach ($info['activity']['providers'] as $provider) {
- $activityManager->registerProvider($provider);
- }
- }
- }
- if (!empty($info['settings'])) {
- $settingsManager = \OC::$server->get(ISettingsManager::class);
- if (!empty($info['settings']['admin'])) {
- foreach ($info['settings']['admin'] as $setting) {
- $settingsManager->registerSetting('admin', $setting);
- }
- }
- if (!empty($info['settings']['admin-section'])) {
- foreach ($info['settings']['admin-section'] as $section) {
- $settingsManager->registerSection('admin', $section);
- }
- }
- if (!empty($info['settings']['personal'])) {
- foreach ($info['settings']['personal'] as $setting) {
- $settingsManager->registerSetting('personal', $setting);
- }
- }
- if (!empty($info['settings']['personal-section'])) {
- foreach ($info['settings']['personal-section'] as $section) {
- $settingsManager->registerSection('personal', $section);
- }
- }
- }
- if (!empty($info['collaboration']['plugins'])) {
-
- $plugins = isset($info['collaboration']['plugins']['plugin']['@value']) ?
- [$info['collaboration']['plugins']['plugin']] : $info['collaboration']['plugins']['plugin'];
- $collaboratorSearch = null;
- $autoCompleteManager = null;
- foreach ($plugins as $plugin) {
- if ($plugin['@attributes']['type'] === 'collaborator-search') {
- $pluginInfo = [
- 'shareType' => $plugin['@attributes']['share-type'],
- 'class' => $plugin['@value'],
- ];
- $collaboratorSearch ??= \OC::$server->get(ICollaboratorSearch::class);
- $collaboratorSearch->registerPlugin($pluginInfo);
- } elseif ($plugin['@attributes']['type'] === 'autocomplete-sort') {
- $autoCompleteManager ??= \OC::$server->get(IAutoCompleteManager::class);
- $autoCompleteManager->registerSorter($plugin['@value']);
- }
- }
- }
- $eventLogger->end("bootstrap:load_app:$app:info");
- $eventLogger->end("bootstrap:load_app:$app");
- }
-
- public function isAppLoaded(string $app): bool {
- return isset($this->loadedApps[$app]);
- }
-
- private static function requireAppFile(string $app): void {
-
- require_once $app . '/appinfo/app.php';
- }
-
- public function enableApp(string $appId, bool $forceEnable = false): void {
-
- $this->getAppPath($appId);
- if ($forceEnable) {
- $this->ignoreNextcloudRequirementForApp($appId);
- }
- $this->installedAppsCache[$appId] = 'yes';
- $this->appConfig->setValue($appId, 'enabled', 'yes');
- $this->dispatcher->dispatchTyped(new AppEnableEvent($appId));
- $this->dispatcher->dispatch(ManagerEvent::EVENT_APP_ENABLE, new ManagerEvent(
- ManagerEvent::EVENT_APP_ENABLE, $appId
- ));
- $this->clearAppsCache();
- }
-
- public function hasProtectedAppType($types) {
- if (empty($types)) {
- return false;
- }
- $protectedTypes = array_intersect($this->protectedAppTypes, $types);
- return !empty($protectedTypes);
- }
-
- public function enableAppForGroups(string $appId, array $groups, bool $forceEnable = false): void {
-
- $this->getAppPath($appId);
- $info = $this->getAppInfo($appId);
- if (!empty($info['types']) && $this->hasProtectedAppType($info['types'])) {
- throw new \InvalidArgumentException("$appId can't be enabled for groups.");
- }
- if ($forceEnable) {
- $this->ignoreNextcloudRequirementForApp($appId);
- }
-
- $groupIds = array_map(function ($group) {
-
- return ($group instanceof IGroup)
- ? $group->getGID()
- : $group;
- }, $groups);
- $this->installedAppsCache[$appId] = json_encode($groupIds);
- $this->appConfig->setValue($appId, 'enabled', json_encode($groupIds));
- $this->dispatcher->dispatchTyped(new AppEnableEvent($appId, $groupIds));
- $this->dispatcher->dispatch(ManagerEvent::EVENT_APP_ENABLE_FOR_GROUPS, new ManagerEvent(
- ManagerEvent::EVENT_APP_ENABLE_FOR_GROUPS, $appId, $groups
- ));
- $this->clearAppsCache();
- }
-
- public function disableApp($appId, $automaticDisabled = false) {
- if ($this->isAlwaysEnabled($appId)) {
- throw new \Exception("$appId can't be disabled.");
- }
- if ($automaticDisabled) {
- $previousSetting = $this->appConfig->getValue($appId, 'enabled', 'yes');
- if ($previousSetting !== 'yes' && $previousSetting !== 'no') {
- $previousSetting = json_decode($previousSetting, true);
- }
- $this->autoDisabledApps[$appId] = $previousSetting;
- }
- unset($this->installedAppsCache[$appId]);
- $this->appConfig->setValue($appId, 'enabled', 'no');
-
- $appData = $this->getAppInfo($appId);
- if (!is_null($appData)) {
- \OC_App::executeRepairSteps($appId, $appData['repair-steps']['uninstall']);
- }
- $this->dispatcher->dispatchTyped(new AppDisableEvent($appId));
- $this->dispatcher->dispatch(ManagerEvent::EVENT_APP_DISABLE, new ManagerEvent(
- ManagerEvent::EVENT_APP_DISABLE, $appId
- ));
- $this->clearAppsCache();
- }
-
- public function getAppPath($appId) {
- $appPath = \OC_App::getAppPath($appId);
- if ($appPath === false) {
- throw new AppPathNotFoundException('Could not find path for ' . $appId);
- }
- return $appPath;
- }
-
- public function getAppWebPath(string $appId): string {
- $appWebPath = \OC_App::getAppWebPath($appId);
- if ($appWebPath === false) {
- throw new AppPathNotFoundException('Could not find web path for ' . $appId);
- }
- return $appWebPath;
- }
-
- public function clearAppsCache() {
- $this->appInfos = [];
- }
-
- public function getAppsNeedingUpgrade($version) {
- $appsToUpgrade = [];
- $apps = $this->getInstalledApps();
- foreach ($apps as $appId) {
- $appInfo = $this->getAppInfo($appId);
- $appDbVersion = $this->appConfig->getValue($appId, 'installed_version');
- if ($appDbVersion
- && isset($appInfo['version'])
- && version_compare($appInfo['version'], $appDbVersion, '>')
- && \OC_App::isAppCompatible($version, $appInfo)
- ) {
- $appsToUpgrade[] = $appInfo;
- }
- }
- return $appsToUpgrade;
- }
-
- public function getAppInfo(string $appId, bool $path = false, $lang = null) {
- if ($path) {
- $file = $appId;
- } else {
- if ($lang === null && isset($this->appInfos[$appId])) {
- return $this->appInfos[$appId];
- }
- try {
- $appPath = $this->getAppPath($appId);
- } catch (AppPathNotFoundException $e) {
- return null;
- }
- $file = $appPath . '/appinfo/info.xml';
- }
- $parser = new InfoParser($this->memCacheFactory->createLocal('core.appinfo'));
- $data = $parser->parse($file);
- if (is_array($data)) {
- $data = \OC_App::parseAppInfo($data, $lang);
- }
- if ($lang === null) {
- $this->appInfos[$appId] = $data;
- }
- return $data;
- }
- public function getAppVersion(string $appId, bool $useCache = true): string {
- if (!$useCache || !isset($this->appVersions[$appId])) {
- $appInfo = $this->getAppInfo($appId);
- $this->appVersions[$appId] = ($appInfo !== null && isset($appInfo['version'])) ? $appInfo['version'] : '0';
- }
- return $this->appVersions[$appId];
- }
-
- public function getIncompatibleApps(string $version): array {
- $apps = $this->getInstalledApps();
- $incompatibleApps = [];
- foreach ($apps as $appId) {
- $info = $this->getAppInfo($appId);
- if ($info === null) {
- $incompatibleApps[] = ['id' => $appId, 'name' => $appId];
- } elseif (!\OC_App::isAppCompatible($version, $info)) {
- $incompatibleApps[] = $info;
- }
- }
- return $incompatibleApps;
- }
-
- public function isShipped($appId) {
- $this->loadShippedJson();
- return in_array($appId, $this->shippedApps, true);
- }
- private function isAlwaysEnabled(string $appId): bool {
- $alwaysEnabled = $this->getAlwaysEnabledApps();
- return in_array($appId, $alwaysEnabled, true);
- }
-
- private function loadShippedJson(): void {
- if ($this->shippedApps === null) {
- $shippedJson = \OC::$SERVERROOT . '/core/shipped.json';
- if (!file_exists($shippedJson)) {
- throw new \Exception("File not found: $shippedJson");
- }
- $content = json_decode(file_get_contents($shippedJson), true);
- $this->shippedApps = $content['shippedApps'];
- $this->alwaysEnabled = $content['alwaysEnabled'];
- $this->defaultEnabled = $content['defaultEnabled'];
- }
- }
-
- public function getAlwaysEnabledApps() {
- $this->loadShippedJson();
- return $this->alwaysEnabled;
- }
-
- public function isDefaultEnabled(string $appId): bool {
- return (in_array($appId, $this->getDefaultEnabledApps()));
- }
-
- public function getDefaultEnabledApps():array {
- $this->loadShippedJson();
- return $this->defaultEnabled;
- }
- public function getDefaultAppForUser(?IUser $user = null, bool $withFallbacks = true): string {
-
- $appId = $withFallbacks ? 'files' : '';
- $defaultApps = explode(',', $this->config->getSystemValueString('defaultapp', ''));
- $defaultApps = array_filter($defaultApps);
- $user ??= $this->userSession->getUser();
- if ($user !== null) {
- $userDefaultApps = explode(',', $this->config->getUserValue($user->getUID(), 'core', 'defaultapp'));
- $defaultApps = array_filter(array_merge($userDefaultApps, $defaultApps));
- if (empty($defaultApps) && $withFallbacks) {
-
- $customOrders = json_decode($this->config->getUserValue($user->getUID(), 'core', 'apporder', '[]'), true, flags:JSON_THROW_ON_ERROR);
- if (!empty($customOrders)) {
- $customOrders = array_map('min', $customOrders);
- asort($customOrders);
- $defaultApps = array_keys($customOrders);
- }
- }
- }
- if (empty($defaultApps) && $withFallbacks) {
- $defaultApps = ['dashboard','files'];
- }
-
- foreach ($defaultApps as $defaultApp) {
- $defaultApp = \OC_App::cleanAppId(strip_tags($defaultApp));
- if ($this->isEnabledForUser($defaultApp, $user)) {
- $appId = $defaultApp;
- break;
- }
- }
- return $appId;
- }
- public function getDefaultApps(): array {
- return explode(',', $this->config->getSystemValueString('defaultapp', 'dashboard,files'));
- }
- public function setDefaultApps(array $defaultApps): void {
- foreach ($defaultApps as $app) {
- if (!$this->isInstalled($app)) {
- $this->logger->debug('Can not set not installed app as default app', ['missing_app' => $app]);
- throw new InvalidArgumentException('App is not installed');
- }
- }
- $this->config->setSystemValue('defaultapp', join(',', $defaultApps));
- }
- }
|