aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Activity
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Activity')
-rw-r--r--lib/private/Activity/ActivitySettingsAdapter.php31
-rw-r--r--lib/private/Activity/Event.php87
-rw-r--r--lib/private/Activity/EventMerger.php24
-rw-r--r--lib/private/Activity/Manager.php104
4 files changed, 78 insertions, 168 deletions
diff --git a/lib/private/Activity/ActivitySettingsAdapter.php b/lib/private/Activity/ActivitySettingsAdapter.php
index eba13ad0350..27c85ee5554 100644
--- a/lib/private/Activity/ActivitySettingsAdapter.php
+++ b/lib/private/Activity/ActivitySettingsAdapter.php
@@ -3,25 +3,8 @@
declare(strict_types=1);
/**
- * @copyright Copyright (c) 2020 Robin Appelman <robin@icewind.nl>
- *
- * @author Robin Appelman <robin@icewind.nl>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Activity;
@@ -34,12 +17,10 @@ use OCP\IL10N;
* class based one
*/
class ActivitySettingsAdapter extends ActivitySettings {
- private $oldSettings;
- private $l10n;
-
- public function __construct(ISetting $oldSettings, IL10N $l10n) {
- $this->oldSettings = $oldSettings;
- $this->l10n = $l10n;
+ public function __construct(
+ private ISetting $oldSettings,
+ private IL10N $l10n,
+ ) {
}
public function getIdentifier() {
diff --git a/lib/private/Activity/Event.php b/lib/private/Activity/Event.php
index cfcfc26945e..0ccad1d0a4e 100644
--- a/lib/private/Activity/Event.php
+++ b/lib/private/Activity/Event.php
@@ -3,34 +3,16 @@
declare(strict_types=1);
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Phil Davis <phil.davis@inf.org>
- * @author Robin Appelman <robin@icewind.nl>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC\Activity;
use OCP\Activity\Exceptions\InvalidValueException;
use OCP\Activity\IEvent;
use OCP\RichObjectStrings\InvalidObjectExeption;
+use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\RichObjectStrings\IValidator;
class Event implements IEvent {
@@ -52,7 +34,7 @@ class Event implements IEvent {
protected $subjectParsed = '';
/** @var string */
protected $subjectRich = '';
- /** @var array */
+ /** @var array<string, array<string, string>> */
protected $subjectRichParameters = [];
/** @var string */
protected $message = '';
@@ -62,7 +44,7 @@ class Event implements IEvent {
protected $messageParsed = '';
/** @var string */
protected $messageRich = '';
- /** @var array */
+ /** @var array<string, array<string, string>> */
protected $messageRichParameters = [];
/** @var string */
protected $objectType = '';
@@ -79,14 +61,11 @@ class Event implements IEvent {
/** @var IEvent|null */
protected $child;
- /** @var IValidator */
- protected $richValidator;
- /**
- * @param IValidator $richValidator
- */
- public function __construct(IValidator $richValidator) {
- $this->richValidator = $richValidator;
+ public function __construct(
+ protected IValidator $richValidator,
+ protected IRichTextFormatter $richTextFormatter,
+ ) {
}
/**
@@ -236,7 +215,7 @@ class Event implements IEvent {
if ($this->subjectParsed === '') {
try {
- $this->subjectParsed = $this->richToParsed($subject, $parameters);
+ $this->subjectParsed = $this->richTextFormatter->richToParsed($subject, $parameters);
} catch (\InvalidArgumentException $e) {
throw new InvalidValueException('richSubjectParameters', $e);
}
@@ -246,30 +225,6 @@ class Event implements IEvent {
}
/**
- * @throws \InvalidArgumentException if a parameter has no name or no type
- */
- private function richToParsed(string $message, array $parameters): string {
- $placeholders = [];
- $replacements = [];
- foreach ($parameters as $placeholder => $parameter) {
- $placeholders[] = '{' . $placeholder . '}';
- foreach (['name','type'] as $requiredField) {
- if (!isset($parameter[$requiredField]) || !is_string($parameter[$requiredField])) {
- throw new \InvalidArgumentException("Invalid rich object, {$requiredField} field is missing");
- }
- }
- if ($parameter['type'] === 'user') {
- $replacements[] = '@' . $parameter['name'];
- } elseif ($parameter['type'] === 'file') {
- $replacements[] = $parameter['path'] ?? $parameter['name'];
- } else {
- $replacements[] = $parameter['name'];
- }
- }
- return str_replace($placeholders, $replacements, $message);
- }
-
- /**
* @return string
* @since 11.0.0
*/
@@ -278,7 +233,7 @@ class Event implements IEvent {
}
/**
- * @return array[]
+ * @return array<string, array<string, string>>
* @since 11.0.0
*/
public function getRichSubjectParameters(): array {
@@ -336,7 +291,7 @@ class Event implements IEvent {
if ($this->messageParsed === '') {
try {
- $this->messageParsed = $this->richToParsed($message, $parameters);
+ $this->messageParsed = $this->richTextFormatter->richToParsed($message, $parameters);
} catch (\InvalidArgumentException $e) {
throw new InvalidValueException('richMessageParameters', $e);
}
@@ -354,7 +309,7 @@ class Event implements IEvent {
}
/**
- * @return array[]
+ * @return array<string, array<string, string>>
* @since 11.0.0
*/
public function getRichMessageParameters(): array {
@@ -460,8 +415,7 @@ class Event implements IEvent {
public function isValid(): bool {
return
$this->isValidCommon()
- &&
- $this->getSubject() !== ''
+ && $this->getSubject() !== ''
;
}
@@ -488,20 +442,15 @@ class Event implements IEvent {
return
$this->isValidCommon()
- &&
- $this->getParsedSubject() !== ''
+ && $this->getParsedSubject() !== ''
;
}
protected function isValidCommon(): bool {
return
$this->getApp() !== ''
- &&
- $this->getType() !== ''
- &&
- $this->getAffectedUser() !== ''
- &&
- $this->getTimestamp() !== 0
+ && $this->getType() !== ''
+ && $this->getTimestamp() !== 0
/**
* Disabled for BC with old activities
* &&
diff --git a/lib/private/Activity/EventMerger.php b/lib/private/Activity/EventMerger.php
index 5775e23a503..0e7d318103a 100644
--- a/lib/private/Activity/EventMerger.php
+++ b/lib/private/Activity/EventMerger.php
@@ -1,26 +1,8 @@
<?php
+
/**
- * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Julius Härtl <jus@bitgrid.net>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
+ * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Activity;
diff --git a/lib/private/Activity/Manager.php b/lib/private/Activity/Manager.php
index 6bf042efe1a..7471b7d708a 100644
--- a/lib/private/Activity/Manager.php
+++ b/lib/private/Activity/Manager.php
@@ -1,30 +1,9 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com>
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Daniel Kesselberg <mail@danielkesselberg.de>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC\Activity;
@@ -32,31 +11,23 @@ use OCP\Activity\ActivitySettings;
use OCP\Activity\Exceptions\FilterNotFoundException;
use OCP\Activity\Exceptions\IncompleteActivityException;
use OCP\Activity\Exceptions\SettingNotFoundException;
+use OCP\Activity\IBulkConsumer;
use OCP\Activity\IConsumer;
use OCP\Activity\IEvent;
use OCP\Activity\IFilter;
use OCP\Activity\IManager;
use OCP\Activity\IProvider;
use OCP\Activity\ISetting;
+use OCP\AppFramework\Utility\ITimeFactory;
use OCP\IConfig;
use OCP\IL10N;
use OCP\IRequest;
use OCP\IUser;
use OCP\IUserSession;
+use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\RichObjectStrings\IValidator;
class Manager implements IManager {
- /** @var IRequest */
- protected $request;
-
- /** @var IUserSession */
- protected $session;
-
- /** @var IConfig */
- protected $config;
-
- /** @var IValidator */
- protected $validator;
/** @var string */
protected $formattingObjectType;
@@ -70,20 +41,15 @@ class Manager implements IManager {
/** @var string */
protected $currentUserId;
- protected $l10n;
-
public function __construct(
- IRequest $request,
- IUserSession $session,
- IConfig $config,
- IValidator $validator,
- IL10N $l10n
+ protected IRequest $request,
+ protected IUserSession $session,
+ protected IConfig $config,
+ protected IValidator $validator,
+ protected IRichTextFormatter $richTextFormatter,
+ protected IL10N $l10n,
+ protected ITimeFactory $timeFactory,
) {
- $this->request = $request;
- $this->session = $session;
- $this->config = $config;
- $this->validator = $validator;
- $this->l10n = $l10n;
}
/** @var \Closure[] */
@@ -126,13 +92,38 @@ class Manager implements IManager {
* @return IEvent
*/
public function generateEvent(): IEvent {
- return new Event($this->validator);
+ return new Event($this->validator, $this->richTextFormatter);
}
/**
* {@inheritDoc}
*/
public function publish(IEvent $event): void {
+ if ($event->getAuthor() === '' && $this->session->getUser() instanceof IUser) {
+ $event->setAuthor($this->session->getUser()->getUID());
+ }
+
+ if (!$event->getTimestamp()) {
+ $event->setTimestamp($this->timeFactory->getTime());
+ }
+
+ if ($event->getAffectedUser() === '' || !$event->isValid()) {
+ throw new IncompleteActivityException('The given event is invalid');
+ }
+
+ foreach ($this->getConsumers() as $c) {
+ $c->receive($event);
+ }
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ public function bulkPublish(IEvent $event, array $affectedUserIds, ISetting $setting): void {
+ if (empty($affectedUserIds)) {
+ throw new IncompleteActivityException('The given event is invalid');
+ }
+
if ($event->getAuthor() === '') {
if ($this->session->getUser() instanceof IUser) {
$event->setAuthor($this->session->getUser()->getUID());
@@ -140,7 +131,7 @@ class Manager implements IManager {
}
if (!$event->getTimestamp()) {
- $event->setTimestamp(time());
+ $event->setTimestamp($this->timeFactory->getTime());
}
if (!$event->isValid()) {
@@ -148,10 +139,17 @@ class Manager implements IManager {
}
foreach ($this->getConsumers() as $c) {
- $c->receive($event);
+ if ($c instanceof IBulkConsumer) {
+ $c->bulkReceive($event, $affectedUserIds, $setting);
+ }
+ foreach ($affectedUserIds as $affectedUserId) {
+ $event->setAffectedUser($affectedUserId);
+ $c->receive($event);
+ }
}
}
+
/**
* In order to improve lazy loading a closure can be registered which will be called in case
* activity consumers are actually requested
@@ -313,7 +311,7 @@ class Manager implements IManager {
public function isFormattingFilteredObject(): bool {
return $this->formattingObjectType !== null && $this->formattingObjectId !== null
&& $this->formattingObjectType === $this->request->getParam('object_type')
- && $this->formattingObjectId === (int) $this->request->getParam('object_id');
+ && $this->formattingObjectId === (int)$this->request->getParam('object_id');
}
/**
@@ -366,7 +364,7 @@ class Manager implements IManager {
* @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
*/
protected function getUserFromToken(): string {
- $token = (string) $this->request->getParam('token', '');
+ $token = (string)$this->request->getParam('token', '');
if (strlen($token) !== 30) {
throw new \UnexpectedValueException('The token is invalid');
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 12:59:46 +0000