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

feat: Add OCP interface to format richtext into string

Browse Source 
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
pull/48137/head
Côme Chilliet 2 years ago
parent f8dde2d254
commit 70a886ce83
No known key found for this signature in database
GPG Key ID: A3E2F658B28C760A
7 changed files with 79 additions and 83 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 27
      core/Command/SetupChecks.php
  2. 2
      lib/composer/composer/autoload_classmap.php
  3. 2
      lib/composer/composer/autoload_static.php
  4. 40
      lib/private/Activity/Event.php
  5. 30
      lib/private/Notification/Notification.php
  6. 36
      lib/private/RichObjectStrings/RichTextFormatter.php
  7. 25
      lib/public/RichObjectStrings/IRichTextFormatter.php

27
core/Command/SetupChecks.php
Unescape 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 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 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 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);
}

30
lib/private/Notification/Notification.php
Unescape 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 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);
}
}

25
lib/public/RichObjectStrings/IRichTextFormatter.php
Unescape 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;
}
Write Preview
Loading…
Cancel
Save