nextcloud / server

lib/private/Notification/Manager.php

Indentation +381 added lines, -381 removed lines

@@ -43,385 +43,385 @@
 use Psr\Log\LoggerInterface;
 
 class Manager implements IManager {
-	/** @var IValidator */
-	protected $validator;
-	/** @var IUserManager */
-	private $userManager;
-	/** @var ICache */
-	protected $cache;
-	/** @var IRegistry */
-	protected $subscription;
-	/** @var LoggerInterface */
-	protected $logger;
-	/** @var Coordinator */
-	private $coordinator;
-
-	/** @var IApp[] */
-	protected $apps;
-	/** @var string[] */
-	protected $appClasses;
-
-	/** @var INotifier[] */
-	protected $notifiers;
-	/** @var string[] */
-	protected $notifierClasses;
-
-	/** @var bool */
-	protected $preparingPushNotification;
-	/** @var bool */
-	protected $deferPushing;
-	/** @var bool */
-	private $parsedRegistrationContext;
-
-	public function __construct(IValidator $validator,
-								IUserManager $userManager,
-								ICacheFactory $cacheFactory,
-								IRegistry $subscription,
-								LoggerInterface $logger,
-								Coordinator $coordinator) {
-		$this->validator = $validator;
-		$this->userManager = $userManager;
-		$this->cache = $cacheFactory->createDistributed('notifications');
-		$this->subscription = $subscription;
-		$this->logger = $logger;
-		$this->coordinator = $coordinator;
-
-		$this->apps = [];
-		$this->notifiers = [];
-		$this->appClasses = [];
-		$this->notifierClasses = [];
-		$this->preparingPushNotification = false;
-		$this->deferPushing = false;
-		$this->parsedRegistrationContext = false;
-	}
-	/**
-	 * @param string $appClass The service must implement IApp, otherwise a
-	 *                          \InvalidArgumentException is thrown later
-	 * @since 17.0.0
-	 */
-	public function registerApp(string $appClass): void {
-		$this->appClasses[] = $appClass;
-	}
-
-	/**
-	 * @param \Closure $service The service must implement INotifier, otherwise a
-	 *                          \InvalidArgumentException is thrown later
-	 * @param \Closure $info    An array with the keys 'id' and 'name' containing
-	 *                          the app id and the app name
-	 * @deprecated 17.0.0 use registerNotifierService instead.
-	 * @since 8.2.0 - Parameter $info was added in 9.0.0
-	 */
-	public function registerNotifier(\Closure $service, \Closure $info) {
-		$infoData = $info();
-		$exception = new \InvalidArgumentException(
-			'Notifier ' . $infoData['name'] . ' (id: ' . $infoData['id'] . ') is not considered because it is using the old way to register.'
-		);
-		$this->logger->error($exception->getMessage(), ['exception' => $exception]);
-	}
-
-	/**
-	 * @param string $notifierService The service must implement INotifier, otherwise a
-	 *                          \InvalidArgumentException is thrown later
-	 * @since 17.0.0
-	 */
-	public function registerNotifierService(string $notifierService): void {
-		$this->notifierClasses[] = $notifierService;
-	}
-
-	/**
-	 * @return IApp[]
-	 */
-	protected function getApps(): array {
-		if (empty($this->appClasses)) {
-			return $this->apps;
-		}
-
-		foreach ($this->appClasses as $appClass) {
-			try {
-				$app = \OC::$server->get($appClass);
-			} catch (ContainerExceptionInterface $e) {
-				$this->logger->error('Failed to load notification app class: ' . $appClass, [
-					'exception' => $e,
-					'app' => 'notifications',
-				]);
-				continue;
-			}
-
-			if (!($app instanceof IApp)) {
-				$this->logger->error('Notification app class ' . $appClass . ' is not implementing ' . IApp::class, [
-					'app' => 'notifications',
-				]);
-				continue;
-			}
-
-			$this->apps[] = $app;
-		}
-
-		$this->appClasses = [];
-
-		return $this->apps;
-	}
-
-	/**
-	 * @return INotifier[]
-	 */
-	public function getNotifiers(): array {
-		if (!$this->parsedRegistrationContext) {
-			$notifierServices = $this->coordinator->getRegistrationContext()->getNotifierServices();
-			foreach ($notifierServices as $notifierService) {
-				try {
-					$notifier = \OC::$server->get($notifierService->getService());
-				} catch (ContainerExceptionInterface $e) {
-					$this->logger->error('Failed to load notification notifier class: ' . $notifierService->getService(), [
-						'exception' => $e,
-						'app' => 'notifications',
-					]);
-					continue;
-				}
-
-				if (!($notifier instanceof INotifier)) {
-					$this->logger->error('Notification notifier class ' . $notifierService->getService() . ' is not implementing ' . INotifier::class, [
-						'app' => 'notifications',
-					]);
-					continue;
-				}
-
-				$this->notifiers[] = $notifier;
-			}
-
-			$this->parsedRegistrationContext = true;
-		}
-
-		if (empty($this->notifierClasses)) {
-			return $this->notifiers;
-		}
-
-		foreach ($this->notifierClasses as $notifierClass) {
-			try {
-				$notifier = \OC::$server->get($notifierClass);
-			} catch (ContainerExceptionInterface $e) {
-				$this->logger->error('Failed to load notification notifier class: ' . $notifierClass, [
-					'exception' => $e,
-					'app' => 'notifications',
-				]);
-				continue;
-			}
-
-			if (!($notifier instanceof INotifier)) {
-				$this->logger->error('Notification notifier class ' . $notifierClass . ' is not implementing ' . INotifier::class, [
-					'app' => 'notifications',
-				]);
-				continue;
-			}
-
-			$this->notifiers[] = $notifier;
-		}
-
-		$this->notifierClasses = [];
-
-		return $this->notifiers;
-	}
-
-	/**
-	 * @return INotification
-	 * @since 8.2.0
-	 */
-	public function createNotification(): INotification {
-		return new Notification($this->validator);
-	}
-
-	/**
-	 * @return bool
-	 * @since 8.2.0
-	 */
-	public function hasNotifiers(): bool {
-		return !empty($this->notifiers) || !empty($this->notifierClasses);
-	}
-
-	/**
-	 * @param bool $preparingPushNotification
-	 * @since 14.0.0
-	 */
-	public function setPreparingPushNotification(bool $preparingPushNotification): void {
-		$this->preparingPushNotification = $preparingPushNotification;
-	}
-
-	/**
-	 * @return bool
-	 * @since 14.0.0
-	 */
-	public function isPreparingPushNotification(): bool {
-		return $this->preparingPushNotification;
-	}
-
-	/**
-	 * The calling app should only "flush" when it got returned true on the defer call
-	 * @return bool
-	 * @since 20.0.0
-	 */
-	public function defer(): bool {
-		$alreadyDeferring = $this->deferPushing;
-		$this->deferPushing = true;
-
-		$apps = $this->getApps();
-
-		foreach ($apps as $app) {
-			if ($app instanceof IDeferrableApp) {
-				$app->defer();
-			}
-		}
-
-		return !$alreadyDeferring;
-	}
-
-	/**
-	 * @since 20.0.0
-	 */
-	public function flush(): void {
-		$apps = $this->getApps();
-
-		foreach ($apps as $app) {
-			if (!$app instanceof IDeferrableApp) {
-				continue;
-			}
-
-			try {
-				$app->flush();
-			} catch (\InvalidArgumentException $e) {
-			}
-		}
-
-		$this->deferPushing = false;
-	}
-
-	/**
-	 * {@inheritDoc}
-	 */
-	public function isFairUseOfFreePushService(): bool {
-		$pushAllowed = $this->cache->get('push_fair_use');
-		if ($pushAllowed === null) {
-			/**
-			 * We want to keep offering our push notification service for free, but large
-			 * users overload our infrastructure. For this reason we have to rate-limit the
-			 * use of push notifications. If you need this feature, consider using Nextcloud Enterprise.
-			 */
-			$isFairUse = $this->subscription->delegateHasValidSubscription() || $this->userManager->countSeenUsers() < 1000;
-			$pushAllowed = $isFairUse ? 'yes' : 'no';
-			$this->cache->set('push_fair_use', $pushAllowed, 3600);
-		}
-		return $pushAllowed === 'yes';
-	}
-
-	/**
-	 * @param INotification $notification
-	 * @throws \InvalidArgumentException When the notification is not valid
-	 * @since 8.2.0
-	 */
-	public function notify(INotification $notification): void {
-		if (!$notification->isValid()) {
-			throw new \InvalidArgumentException('The given notification is invalid');
-		}
-
-		$apps = $this->getApps();
-
-		foreach ($apps as $app) {
-			try {
-				$app->notify($notification);
-			} catch (\InvalidArgumentException $e) {
-			}
-		}
-	}
-
-	/**
-	 * Identifier of the notifier, only use [a-z0-9_]
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getID(): string {
-		return 'core';
-	}
-
-	/**
-	 * Human readable name describing the notifier
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getName(): string {
-		return 'core';
-	}
-
-	/**
-	 * @param INotification $notification
-	 * @param string $languageCode The code of the language that should be used to prepare the notification
-	 * @return INotification
-	 * @throws \InvalidArgumentException When the notification was not prepared by a notifier
-	 * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
-	 * @since 8.2.0
-	 */
-	public function prepare(INotification $notification, string $languageCode): INotification {
-		$notifiers = $this->getNotifiers();
-
-		foreach ($notifiers as $notifier) {
-			try {
-				$notification = $notifier->prepare($notification, $languageCode);
-			} catch (\InvalidArgumentException $e) {
-				continue;
-			} catch (AlreadyProcessedException $e) {
-				$this->markProcessed($notification);
-				throw new \InvalidArgumentException('The given notification has been processed');
-			}
-
-			if (!$notification->isValidParsed()) {
-				throw new \InvalidArgumentException('The given notification has not been handled');
-			}
-		}
-
-		if (!$notification->isValidParsed()) {
-			throw new \InvalidArgumentException('The given notification has not been handled');
-		}
-
-		return $notification;
-	}
-
-	/**
-	 * @param INotification $notification
-	 */
-	public function markProcessed(INotification $notification): void {
-		$apps = $this->getApps();
-
-		foreach ($apps as $app) {
-			$app->markProcessed($notification);
-		}
-	}
-
-	/**
-	 * @param INotification $notification
-	 * @return int
-	 */
-	public function getCount(INotification $notification): int {
-		$apps = $this->getApps();
-
-		$count = 0;
-		foreach ($apps as $app) {
-			$count += $app->getCount($notification);
-		}
-
-		return $count;
-	}
-
-	public function dismissNotification(INotification $notification): void {
-		$notifiers = $this->getNotifiers();
-
-		foreach ($notifiers as $notifier) {
-			if ($notifier instanceof IDismissableNotifier) {
-				try {
-					$notifier->dismissNotification($notification);
-				} catch (\InvalidArgumentException $e) {
-					continue;
-				}
-			}
-		}
-	}
+    /** @var IValidator */
+    protected $validator;
+    /** @var IUserManager */
+    private $userManager;
+    /** @var ICache */
+    protected $cache;
+    /** @var IRegistry */
+    protected $subscription;
+    /** @var LoggerInterface */
+    protected $logger;
+    /** @var Coordinator */
+    private $coordinator;
+
+    /** @var IApp[] */
+    protected $apps;
+    /** @var string[] */
+    protected $appClasses;
+
+    /** @var INotifier[] */
+    protected $notifiers;
+    /** @var string[] */
+    protected $notifierClasses;
+
+    /** @var bool */
+    protected $preparingPushNotification;
+    /** @var bool */
+    protected $deferPushing;
+    /** @var bool */
+    private $parsedRegistrationContext;
+
+    public function __construct(IValidator $validator,
+                                IUserManager $userManager,
+                                ICacheFactory $cacheFactory,
+                                IRegistry $subscription,
+                                LoggerInterface $logger,
+                                Coordinator $coordinator) {
+        $this->validator = $validator;
+        $this->userManager = $userManager;
+        $this->cache = $cacheFactory->createDistributed('notifications');
+        $this->subscription = $subscription;
+        $this->logger = $logger;
+        $this->coordinator = $coordinator;
+
+        $this->apps = [];
+        $this->notifiers = [];
+        $this->appClasses = [];
+        $this->notifierClasses = [];
+        $this->preparingPushNotification = false;
+        $this->deferPushing = false;
+        $this->parsedRegistrationContext = false;
+    }
+    /**
+     * @param string $appClass The service must implement IApp, otherwise a
+     *                          \InvalidArgumentException is thrown later
+     * @since 17.0.0
+     */
+    public function registerApp(string $appClass): void {
+        $this->appClasses[] = $appClass;
+    }
+
+    /**
+     * @param \Closure $service The service must implement INotifier, otherwise a
+     *                          \InvalidArgumentException is thrown later
+     * @param \Closure $info    An array with the keys 'id' and 'name' containing
+     *                          the app id and the app name
+     * @deprecated 17.0.0 use registerNotifierService instead.
+     * @since 8.2.0 - Parameter $info was added in 9.0.0
+     */
+    public function registerNotifier(\Closure $service, \Closure $info) {
+        $infoData = $info();
+        $exception = new \InvalidArgumentException(
+            'Notifier ' . $infoData['name'] . ' (id: ' . $infoData['id'] . ') is not considered because it is using the old way to register.'
+        );
+        $this->logger->error($exception->getMessage(), ['exception' => $exception]);
+    }
+
+    /**
+     * @param string $notifierService The service must implement INotifier, otherwise a
+     *                          \InvalidArgumentException is thrown later
+     * @since 17.0.0
+     */
+    public function registerNotifierService(string $notifierService): void {
+        $this->notifierClasses[] = $notifierService;
+    }
+
+    /**
+     * @return IApp[]
+     */
+    protected function getApps(): array {
+        if (empty($this->appClasses)) {
+            return $this->apps;
+        }
+
+        foreach ($this->appClasses as $appClass) {
+            try {
+                $app = \OC::$server->get($appClass);
+            } catch (ContainerExceptionInterface $e) {
+                $this->logger->error('Failed to load notification app class: ' . $appClass, [
+                    'exception' => $e,
+                    'app' => 'notifications',
+                ]);
+                continue;
+            }
+
+            if (!($app instanceof IApp)) {
+                $this->logger->error('Notification app class ' . $appClass . ' is not implementing ' . IApp::class, [
+                    'app' => 'notifications',
+                ]);
+                continue;
+            }
+
+            $this->apps[] = $app;
+        }
+
+        $this->appClasses = [];
+
+        return $this->apps;
+    }
+
+    /**
+     * @return INotifier[]
+     */
+    public function getNotifiers(): array {
+        if (!$this->parsedRegistrationContext) {
+            $notifierServices = $this->coordinator->getRegistrationContext()->getNotifierServices();
+            foreach ($notifierServices as $notifierService) {
+                try {
+                    $notifier = \OC::$server->get($notifierService->getService());
+                } catch (ContainerExceptionInterface $e) {
+                    $this->logger->error('Failed to load notification notifier class: ' . $notifierService->getService(), [
+                        'exception' => $e,
+                        'app' => 'notifications',
+                    ]);
+                    continue;
+                }
+
+                if (!($notifier instanceof INotifier)) {
+                    $this->logger->error('Notification notifier class ' . $notifierService->getService() . ' is not implementing ' . INotifier::class, [
+                        'app' => 'notifications',
+                    ]);
+                    continue;
+                }
+
+                $this->notifiers[] = $notifier;
+            }
+
+            $this->parsedRegistrationContext = true;
+        }
+
+        if (empty($this->notifierClasses)) {
+            return $this->notifiers;
+        }
+
+        foreach ($this->notifierClasses as $notifierClass) {
+            try {
+                $notifier = \OC::$server->get($notifierClass);
+            } catch (ContainerExceptionInterface $e) {
+                $this->logger->error('Failed to load notification notifier class: ' . $notifierClass, [
+                    'exception' => $e,
+                    'app' => 'notifications',
+                ]);
+                continue;
+            }
+
+            if (!($notifier instanceof INotifier)) {
+                $this->logger->error('Notification notifier class ' . $notifierClass . ' is not implementing ' . INotifier::class, [
+                    'app' => 'notifications',
+                ]);
+                continue;
+            }
+
+            $this->notifiers[] = $notifier;
+        }
+
+        $this->notifierClasses = [];
+
+        return $this->notifiers;
+    }
+
+    /**
+     * @return INotification
+     * @since 8.2.0
+     */
+    public function createNotification(): INotification {
+        return new Notification($this->validator);
+    }
+
+    /**
+     * @return bool
+     * @since 8.2.0
+     */
+    public function hasNotifiers(): bool {
+        return !empty($this->notifiers) || !empty($this->notifierClasses);
+    }
+
+    /**
+     * @param bool $preparingPushNotification
+     * @since 14.0.0
+     */
+    public function setPreparingPushNotification(bool $preparingPushNotification): void {
+        $this->preparingPushNotification = $preparingPushNotification;
+    }
+
+    /**
+     * @return bool
+     * @since 14.0.0
+     */
+    public function isPreparingPushNotification(): bool {
+        return $this->preparingPushNotification;
+    }
+
+    /**
+     * The calling app should only "flush" when it got returned true on the defer call
+     * @return bool
+     * @since 20.0.0
+     */
+    public function defer(): bool {
+        $alreadyDeferring = $this->deferPushing;
+        $this->deferPushing = true;
+
+        $apps = $this->getApps();
+
+        foreach ($apps as $app) {
+            if ($app instanceof IDeferrableApp) {
+                $app->defer();
+            }
+        }
+
+        return !$alreadyDeferring;
+    }
+
+    /**
+     * @since 20.0.0
+     */
+    public function flush(): void {
+        $apps = $this->getApps();
+
+        foreach ($apps as $app) {
+            if (!$app instanceof IDeferrableApp) {
+                continue;
+            }
+
+            try {
+                $app->flush();
+            } catch (\InvalidArgumentException $e) {
+            }
+        }
+
+        $this->deferPushing = false;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function isFairUseOfFreePushService(): bool {
+        $pushAllowed = $this->cache->get('push_fair_use');
+        if ($pushAllowed === null) {
+            /**
+             * We want to keep offering our push notification service for free, but large
+             * users overload our infrastructure. For this reason we have to rate-limit the
+             * use of push notifications. If you need this feature, consider using Nextcloud Enterprise.
+             */
+            $isFairUse = $this->subscription->delegateHasValidSubscription() || $this->userManager->countSeenUsers() < 1000;
+            $pushAllowed = $isFairUse ? 'yes' : 'no';
+            $this->cache->set('push_fair_use', $pushAllowed, 3600);
+        }
+        return $pushAllowed === 'yes';
+    }
+
+    /**
+     * @param INotification $notification
+     * @throws \InvalidArgumentException When the notification is not valid
+     * @since 8.2.0
+     */
+    public function notify(INotification $notification): void {
+        if (!$notification->isValid()) {
+            throw new \InvalidArgumentException('The given notification is invalid');
+        }
+
+        $apps = $this->getApps();
+
+        foreach ($apps as $app) {
+            try {
+                $app->notify($notification);
+            } catch (\InvalidArgumentException $e) {
+            }
+        }
+    }
+
+    /**
+     * Identifier of the notifier, only use [a-z0-9_]
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getID(): string {
+        return 'core';
+    }
+
+    /**
+     * Human readable name describing the notifier
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getName(): string {
+        return 'core';
+    }
+
+    /**
+     * @param INotification $notification
+     * @param string $languageCode The code of the language that should be used to prepare the notification
+     * @return INotification
+     * @throws \InvalidArgumentException When the notification was not prepared by a notifier
+     * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
+     * @since 8.2.0
+     */
+    public function prepare(INotification $notification, string $languageCode): INotification {
+        $notifiers = $this->getNotifiers();
+
+        foreach ($notifiers as $notifier) {
+            try {
+                $notification = $notifier->prepare($notification, $languageCode);
+            } catch (\InvalidArgumentException $e) {
+                continue;
+            } catch (AlreadyProcessedException $e) {
+                $this->markProcessed($notification);
+                throw new \InvalidArgumentException('The given notification has been processed');
+            }
+
+            if (!$notification->isValidParsed()) {
+                throw new \InvalidArgumentException('The given notification has not been handled');
+            }
+        }
+
+        if (!$notification->isValidParsed()) {
+            throw new \InvalidArgumentException('The given notification has not been handled');
+        }
+
+        return $notification;
+    }
+
+    /**
+     * @param INotification $notification
+     */
+    public function markProcessed(INotification $notification): void {
+        $apps = $this->getApps();
+
+        foreach ($apps as $app) {
+            $app->markProcessed($notification);
+        }
+    }
+
+    /**
+     * @param INotification $notification
+     * @return int
+     */
+    public function getCount(INotification $notification): int {
+        $apps = $this->getApps();
+
+        $count = 0;
+        foreach ($apps as $app) {
+            $count += $app->getCount($notification);
+        }
+
+        return $count;
+    }
+
+    public function dismissNotification(INotification $notification): void {
+        $notifiers = $this->getNotifiers();
+
+        foreach ($notifiers as $notifier) {
+            if ($notifier instanceof IDismissableNotifier) {
+                try {
+                    $notifier->dismissNotification($notification);
+                } catch (\InvalidArgumentException $e) {
+                    continue;
+                }
+            }
+        }
+    }
 }