sascha
/
nextcloud-server
mirror of https://github.com/nextcloud/server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #48137 from nextcloud/enh/add-rich-object-formatter 

feat: Add OCP interface to format richtext into string
pull/48184/head
Côme Chilliet 2024-09-18 18:59:56 +07:00 committed by GitHub
parent 33928fc671 b926df4730
commit 989d708bd8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
13 changed files with 129 additions and 125 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
core/Command/SetupChecks.php
Unescape Escape View File

@ -9,6 +9,7 @@ declare(strict_types=1);
namespace OC\Core\Command;
use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\SetupCheck\ISetupCheckManager;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
@ -16,6 +17,7 @@ use Symfony\Component\Console\Output\OutputInterface;
class SetupChecks extends Base {
public function __construct(
private ISetupCheckManager $setupCheckManager,
private IRichTextFormatter $richTextFormatter,
) {
parent::__construct();
}
@ -29,29 +31,6 @@ class SetupChecks extends Base {
;
}
/**
* @TODO move this method to a common service used by notifications, activity and this command
* @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");
}
}
$replacements[] = match($parameter['type']) {
'user' => '@' . $parameter['name'],
'file' => $parameter['path'] ?? $parameter['name'],
default => $parameter['name'],
};
}
return str_replace($placeholders, $replacements, $message);
}
protected function execute(InputInterface $input, OutputInterface $output): int {
$results = $this->setupCheckManager->runAll();
switch ($input->getOption('output')) {
@ -79,7 +58,7 @@ class SetupChecks extends Base {
$description = $check->getDescription();
$descriptionParameters = $check->getDescriptionParameters();
if ($description !== null && $descriptionParameters !== null) {
$description = $this->richToParsed($description, $descriptionParameters);
$description = $this->richTextFormatter->richToParsed($description, $descriptionParameters);
}
$output->writeln(
"\t\t".

2
lib/composer/composer/autoload_classmap.php
Unescape Escape View File

@ -646,6 +646,7 @@ return array(
'OCP\\Remote\\IInstanceFactory' => $baseDir . '/lib/public/Remote/IInstanceFactory.php',
'OCP\\Remote\\IUser' => $baseDir . '/lib/public/Remote/IUser.php',
'OCP\\RichObjectStrings\\Definitions' => $baseDir . '/lib/public/RichObjectStrings/Definitions.php',
'OCP\\RichObjectStrings\\IRichTextFormatter' => $baseDir . '/lib/public/RichObjectStrings/IRichTextFormatter.php',
'OCP\\RichObjectStrings\\IValidator' => $baseDir . '/lib/public/RichObjectStrings/IValidator.php',
'OCP\\RichObjectStrings\\InvalidObjectExeption' => $baseDir . '/lib/public/RichObjectStrings/InvalidObjectExeption.php',
'OCP\\Route\\IRoute' => $baseDir . '/lib/public/Route/IRoute.php',
@ -1839,6 +1840,7 @@ return array(
'OC\\Repair\\RepairInvalidShares' => $baseDir . '/lib/private/Repair/RepairInvalidShares.php',
'OC\\Repair\\RepairLogoDimension' => $baseDir . '/lib/private/Repair/RepairLogoDimension.php',
'OC\\Repair\\RepairMimeTypes' => $baseDir . '/lib/private/Repair/RepairMimeTypes.php',
'OC\\RichObjectStrings\\RichTextFormatter' => $baseDir . '/lib/private/RichObjectStrings/RichTextFormatter.php',
'OC\\RichObjectStrings\\Validator' => $baseDir . '/lib/private/RichObjectStrings/Validator.php',
'OC\\Route\\CachingRouter' => $baseDir . '/lib/private/Route/CachingRouter.php',
'OC\\Route\\Route' => $baseDir . '/lib/private/Route/Route.php',

2
lib/composer/composer/autoload_static.php
Unescape Escape View File

@ -679,6 +679,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OCP\\Remote\\IInstanceFactory' => __DIR__ . '/../../..' . '/lib/public/Remote/IInstanceFactory.php',
'OCP\\Remote\\IUser' => __DIR__ . '/../../..' . '/lib/public/Remote/IUser.php',
'OCP\\RichObjectStrings\\Definitions' => __DIR__ . '/../../..' . '/lib/public/RichObjectStrings/Definitions.php',
'OCP\\RichObjectStrings\\IRichTextFormatter' => __DIR__ . '/../../..' . '/lib/public/RichObjectStrings/IRichTextFormatter.php',
'OCP\\RichObjectStrings\\IValidator' => __DIR__ . '/../../..' . '/lib/public/RichObjectStrings/IValidator.php',
'OCP\\RichObjectStrings\\InvalidObjectExeption' => __DIR__ . '/../../..' . '/lib/public/RichObjectStrings/InvalidObjectExeption.php',
'OCP\\Route\\IRoute' => __DIR__ . '/../../..' . '/lib/public/Route/IRoute.php',
@ -1872,6 +1873,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
'OC\\Repair\\RepairInvalidShares' => __DIR__ . '/../../..' . '/lib/private/Repair/RepairInvalidShares.php',
'OC\\Repair\\RepairLogoDimension' => __DIR__ . '/../../..' . '/lib/private/Repair/RepairLogoDimension.php',
'OC\\Repair\\RepairMimeTypes' => __DIR__ . '/../../..' . '/lib/private/Repair/RepairMimeTypes.php',
'OC\\RichObjectStrings\\RichTextFormatter' => __DIR__ . '/../../..' . '/lib/private/RichObjectStrings/RichTextFormatter.php',
'OC\\RichObjectStrings\\Validator' => __DIR__ . '/../../..' . '/lib/private/RichObjectStrings/Validator.php',
'OC\\Route\\CachingRouter' => __DIR__ . '/../../..' . '/lib/private/Route/CachingRouter.php',
'OC\\Route\\Route' => __DIR__ . '/../../..' . '/lib/private/Route/Route.php',

40
lib/private/Activity/Event.php
Unescape Escape View File

@ -12,6 +12,7 @@ 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 {
@ -60,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,
) {
}
/**
@ -217,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);
}
@ -226,30 +224,6 @@ class Event implements IEvent {
return $this;
}
/**
* @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
@ -317,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);
}

32
lib/private/Activity/Manager.php
Unescape Escape View File

@ -21,20 +21,10 @@ 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;
@ -48,20 +38,14 @@ 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,
) {
$this->request = $request;
$this->session = $session;
$this->config = $config;
$this->validator = $validator;
$this->l10n = $l10n;
}
/** @var \Closure[] */
@ -104,7 +88,7 @@ class Manager implements IManager {
* @return IEvent
*/
public function generateEvent(): IEvent {
return new Event($this->validator);
return new Event($this->validator, $this->richTextFormatter);
}
/**

4
lib/private/Notification/Manager.php
Unescape Escape View File

@ -22,6 +22,7 @@ use OCP\Notification\IncompleteParsedNotificationException;
use OCP\Notification\INotification;
use OCP\Notification\INotifier;
use OCP\Notification\UnknownNotificationException;
use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\RichObjectStrings\IValidator;
use OCP\Support\Subscription\IRegistry;
use Psr\Container\ContainerExceptionInterface;
@ -55,6 +56,7 @@ class Manager implements IManager {
protected IRegistry $subscription,
protected LoggerInterface $logger,
private Coordinator $coordinator,
private IRichTextFormatter $richTextFormatter,
) {
$this->cache = $cacheFactory->createDistributed('notifications');
@ -199,7 +201,7 @@ class Manager implements IManager {
* @since 8.2.0
*/
public function createNotification(): INotification {
return new Notification($this->validator);
return new Notification($this->validator, $this->richTextFormatter);
}
/**

30
lib/private/Notification/Notification.php
Unescape Escape View File

@ -12,6 +12,7 @@ use OCP\Notification\IAction;
use OCP\Notification\INotification;
use OCP\Notification\InvalidValueException;
use OCP\RichObjectStrings\InvalidObjectExeption;
use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\RichObjectStrings\IValidator;
class Notification implements INotification {
@ -39,6 +40,7 @@ class Notification implements INotification {
public function __construct(
protected IValidator $richValidator,
protected IRichTextFormatter $richTextFormatter,
) {
$this->dateTime = new \DateTime();
$this->dateTime->setTimestamp(0);
@ -187,7 +189,7 @@ class Notification implements INotification {
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);
}
@ -196,30 +198,6 @@ class Notification implements INotification {
return $this;
}
/**
* @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);
}
/**
* {@inheritDoc}
*/
@ -293,7 +271,7 @@ class Notification implements INotification {
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);
}

36
lib/private/RichObjectStrings/RichTextFormatter.php
Unescape Escape View File

@ -0,0 +1,36 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\RichObjectStrings;
use OCP\RichObjectStrings\IRichTextFormatter;
class RichTextFormatter implements IRichTextFormatter {
/**
* @throws \InvalidArgumentException if a parameter has no name or no type
*/
public 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");
}
}
$replacements[] = match($parameter['type']) {
'user' => '@' . $parameter['name'],
'file' => $parameter['path'] ?? $parameter['name'],
default => $parameter['name'],
};
}
return str_replace($placeholders, $replacements, $message);
}
}

4
lib/private/Server.php
Unescape Escape View File

@ -204,6 +204,7 @@ use OCP\Profile\IProfileManager;
use OCP\Profiler\IProfiler;
use OCP\Remote\Api\IApiFactory;
use OCP\Remote\IInstanceFactory;
use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\RichObjectStrings\IValidator;
use OCP\Route\IRouter;
use OCP\Security\Bruteforce\IThrottler;
@ -648,6 +649,7 @@ class Server extends ServerContainer implements IServerContainer {
$c->get(IUserSession::class),
$c->get(\OCP\IConfig::class),
$c->get(IValidator::class),
$c->get(IRichTextFormatter::class),
$l10n
);
});
@ -1285,6 +1287,8 @@ class Server extends ServerContainer implements IServerContainer {
$this->registerAlias(\OCP\Security\Ip\IFactory::class, \OC\Security\Ip\Factory::class);
$this->registerAlias(IRichTextFormatter::class, \OC\RichObjectStrings\RichTextFormatter::class);
$this->connectDispatcher();
}

25
lib/public/RichObjectStrings/IRichTextFormatter.php
Unescape Escape View File

@ -0,0 +1,25 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\RichObjectStrings;
/**
* Parse rich text and format it with the richobjects
*
* @since 31.0.0
*/
interface IRichTextFormatter {
/**
* @since 31.0.0
* @param string $message
* @param array<string,array<string,string>> $parameters
* @throws \InvalidArgumentException if a parameter has no name or no type
*/
public function richToParsed(string $message, array $parameters): string;
}

17
tests/lib/Activity/ManagerTest.php
Unescape Escape View File

@ -14,21 +14,20 @@ use OCP\IL10N;
use OCP\IRequest;
use OCP\IUser;
use OCP\IUserSession;
use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\RichObjectStrings\IValidator;
use PHPUnit\Framework\MockObject\MockObject;
use Test\TestCase;
class ManagerTest extends TestCase {
/** @var \OC\Activity\Manager */
private $activityManager;
/** @var IRequest|\PHPUnit\Framework\MockObject\MockObject */
protected $request;
/** @var IUserSession|\PHPUnit\Framework\MockObject\MockObject */
protected $session;
/** @var IConfig|\PHPUnit\Framework\MockObject\MockObject */
protected $config;
/** @var IValidator|\PHPUnit\Framework\MockObject\MockObject */
protected $validator;
protected IRequest&MockObject $request;
protected IUserSession&MockObject $session;
protected IConfig&MockObject $config;
protected IValidator&MockObject $validator;
protected IRichTextFormatter&MockObject $richTextFormatter;
protected function setUp(): void {
parent::setUp();
@ -37,12 +36,14 @@ class ManagerTest extends TestCase {
$this->session = $this->createMock(IUserSession::class);
$this->config = $this->createMock(IConfig::class);
$this->validator = $this->createMock(IValidator::class);
$this->richTextFormatter = $this->createMock(IRichTextFormatter::class);
$this->activityManager = new \OC\Activity\Manager(
$this->request,
$this->session,
$this->config,
$this->validator,
$this->richTextFormatter,
$this->createMock(IL10N::class)
);

20
tests/lib/Notification/ManagerTest.php
Unescape Escape View File

@ -18,6 +18,7 @@ use OCP\ICacheFactory;
use OCP\IUserManager;
use OCP\Notification\IManager;
use OCP\Notification\INotification;
use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\RichObjectStrings\IValidator;
use OCP\Support\Subscription\IRegistry;
use PHPUnit\Framework\MockObject\MockObject;
@ -28,8 +29,8 @@ class ManagerTest extends TestCase {
/** @var IManager */
protected $manager;
/** @var IValidator|MockObject */
protected $validator;
protected IValidator&MockObject $validator;
protected IRichTextFormatter&MockObject $richTextFormatter;
/** @var IUserManager|MockObject */
protected $userManager;
/** @var ICacheFactory|MockObject */
@ -49,6 +50,7 @@ class ManagerTest extends TestCase {
parent::setUp();
$this->validator = $this->createMock(IValidator::class);
$this->richTextFormatter = $this->createMock(IRichTextFormatter::class);
$this->userManager = $this->createMock(IUserManager::class);
$this->cache = $this->createMock(ICache::class);
$this->subscriptionRegistry = $this->createMock(IRegistry::class);
@ -64,7 +66,15 @@ class ManagerTest extends TestCase {
$this->coordinator->method('getRegistrationContext')
->willReturn($this->registrationContext);
$this->manager = new Manager($this->validator, $this->userManager, $this->cacheFactory, $this->subscriptionRegistry, $this->logger, $this->coordinator);
$this->manager = new Manager(
$this->validator,
$this->userManager,
$this->cacheFactory,
$this->subscriptionRegistry,
$this->logger,
$this->coordinator,
$this->richTextFormatter,
);
}
public function testRegisterApp(): void {
@ -141,6 +151,7 @@ class ManagerTest extends TestCase {
$this->subscriptionRegistry,
$this->logger,
$this->coordinator,
$this->richTextFormatter,
])
->setMethods(['getApps'])
->getMock();
@ -172,6 +183,7 @@ class ManagerTest extends TestCase {
$this->subscriptionRegistry,
$this->logger,
$this->coordinator,
$this->richTextFormatter,
])
->setMethods(['getApps'])
->getMock();
@ -196,6 +208,7 @@ class ManagerTest extends TestCase {
$this->subscriptionRegistry,
$this->logger,
$this->coordinator,
$this->richTextFormatter,
])
->setMethods(['getApps'])
->getMock();
@ -221,6 +234,7 @@ class ManagerTest extends TestCase {
$this->subscriptionRegistry,
$this->logger,
$this->coordinator,
$this->richTextFormatter,
])
->setMethods(['getApps'])
->getMock();

15
tests/lib/Notification/NotificationTest.php
Unescape Escape View File

@ -12,19 +12,22 @@ namespace Test\Notification;
use OC\Notification\Notification;
use OCP\Notification\IAction;
use OCP\Notification\INotification;
use OCP\RichObjectStrings\IRichTextFormatter;
use OCP\RichObjectStrings\IValidator;
use PHPUnit\Framework\MockObject\MockObject;
use Test\TestCase;
class NotificationTest extends TestCase {
/** @var INotification */
protected $notification;
/** @var IValidator|\PHPUnit\Framework\MockObject\MockObject */
protected $validator;
protected IValidator&MockObject $validator;
protected IRichTextFormatter&MockObject $richTextFormatter;
protected function setUp(): void {
parent::setUp();
$this->validator = $this->createMock(IValidator::class);
$this->notification = new Notification($this->validator);
$this->richTextFormatter = $this->createMock(IRichTextFormatter::class);
$this->notification = new Notification($this->validator, $this->richTextFormatter);
}
protected function dataValidString($maxLength) {
@ -529,7 +532,7 @@ class NotificationTest extends TestCase {
'getSubject',
'getParsedSubject',
])
->setConstructorArgs([$this->validator])
->setConstructorArgs([$this->validator, $this->richTextFormatter])
->getMock();
$notification->expects($this->once())
@ -562,7 +565,7 @@ class NotificationTest extends TestCase {
'getParsedSubject',
'getSubject',
])
->setConstructorArgs([$this->validator])
->setConstructorArgs([$this->validator, $this->richTextFormatter])
->getMock();
$notification->expects($this->once())
@ -611,7 +614,7 @@ class NotificationTest extends TestCase {
'getObjectType',
'getObjectId',
])
->setConstructorArgs([$this->validator])
->setConstructorArgs([$this->validator, $this->richTextFormatter])
->getMock();
$notification->expects($this->any())