upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-04-21 14:23:17 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 15

Merge pull request #42585 from nextcloud/enh/add-rich-object-support-to-setupchecks

Browse source 
Add RichObject support for SetupCheck descriptions
This commit is contained in:
Côme Chilliet 2024-01-11 17:15:14 +01:00 committed by GitHub
commit d8e625f208
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 84 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
core/Command/SetupChecks.php
View file

@ -45,6 +45,29 @@ 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')) {
@ -70,6 +93,10 @@ class SetupChecks extends Base {
};
$verbosity = ($check->getSeverity() === 'error' ? OutputInterface::VERBOSITY_QUIET : OutputInterface::VERBOSITY_NORMAL);
$description = $check->getDescription();
$descriptionParameters = $check->getDescriptionParameters();
if ($description !== null && $descriptionParameters !== null) {
$description = $this->richToParsed($description, $descriptionParameters);
}
$output->writeln(
"\t\t".
($styleTag !== null ? "<{$styleTag}>" : '').

25
core/js/setupchecks.js
View file

@ -317,6 +317,28 @@
return deferred.promise();
},
/**
* @param message The message string containing placeholders.
* @param parameters An object with keys as placeholders and values as their replacements.
*
* @return The message with placeholders replaced by values.
*/
richToParsed: function (message, parameters) {
for (var [placeholder, parameter] of Object.entries(parameters)) {
var replacement;
if (parameter.type === 'user') {
replacement = '@' + parameter.name;
} else if (parameter.type === 'file') {
replacement = parameter.path || parameter.name;
} else {
replacement = parameter.name;
}
message = message.replace('{' + placeholder + '}', replacement);
}
return message;
},
addGenericSetupCheck: function(data, check, messages) {
var setupCheck = data[check] || { pass: true, description: '', severity: 'info', linkToDoc: null}
@ -328,6 +350,9 @@
}
var message = setupCheck.description;
if (setupCheck.descriptionParameters) {
message = this.richToParsed(message, setupCheck.descriptionParameters);
}
if (setupCheck.linkToDoc) {
message += ' ' + t('core', 'For more details see the {linkstart}documentation ↗{linkend}.')
.replace('{linkstart}', '<a target="_blank" rel="noreferrer noopener" class="external" href="' + setupCheck.linkToDoc + '">')

40
lib/public/SetupCheck/SetupResult.php
View file

@ -26,6 +26,8 @@ declare(strict_types=1);
namespace OCP\SetupCheck;
use OCP\RichObjectStrings\IValidator;
/**
* @brief This class is used for storing the result of a setup check
*
@ -46,12 +48,18 @@ class SetupResult implements \JsonSerializable {
* @brief Private constructor, use success()/info()/warning()/error() instead
* @param self::SUCCESS|self::INFO|self::WARNING|self::ERROR $severity
* @since 28.0.0
* @since 28.0.2 Optional parameter ?array $descriptionParameters
* @since 28.0.2 throws \OCP\RichObjectStrings\InvalidObjectExeption
*/
private function __construct(
private string $severity,
private ?string $description = null,
private ?array $descriptionParameters = null,
private ?string $linkToDoc = null,
) {
if ($description !== null && $descriptionParameters !== null) {
\OCP\Server::get(IValidator::class)->validate($description, $descriptionParameters);
}
}
/**
@ -59,9 +67,10 @@ class SetupResult implements \JsonSerializable {
* @param ?string $description Translated detailed description to display to the user
* @param ?string $linkToDoc URI of related relevent documentation, be it from Nextcloud or another project
* @since 28.0.0
* @since 28.0.2 Optional parameter ?array $descriptionParameters
*/
public static function success(?string $description = null, ?string $linkToDoc = null): self {
return new self(self::SUCCESS, $description, $linkToDoc);
public static function success(?string $description = null, ?string $linkToDoc = null, ?array $descriptionParameters = null): self {
return new self(self::SUCCESS, $description, $descriptionParameters, $linkToDoc);
}
/**
@ -69,9 +78,10 @@ class SetupResult implements \JsonSerializable {
* @param ?string $description Translated detailed description to display to the user
* @param ?string $linkToDoc URI of related relevent documentation, be it from Nextcloud or another project
* @since 28.0.0
* @since 28.0.2 Optional parameter ?array $descriptionParameters
*/
public static function info(?string $description = null, ?string $linkToDoc = null): self {
return new self(self::INFO, $description, $linkToDoc);
public static function info(?string $description = null, ?string $linkToDoc = null, ?array $descriptionParameters = null): self {
return new self(self::INFO, $description, $descriptionParameters, $linkToDoc);
}
/**
@ -79,9 +89,10 @@ class SetupResult implements \JsonSerializable {
* @param ?string $description Translated detailed description to display to the user
* @param ?string $linkToDoc URI of related relevent documentation, be it from Nextcloud or another project
* @since 28.0.0
* @since 28.0.2 Optional parameter ?array $descriptionParameters
*/
public static function warning(?string $description = null, ?string $linkToDoc = null): self {
return new self(self::WARNING, $description, $linkToDoc);
public static function warning(?string $description = null, ?string $linkToDoc = null, ?array $descriptionParameters = null): self {
return new self(self::WARNING, $description, $descriptionParameters, $linkToDoc);
}
/**
@ -89,9 +100,10 @@ class SetupResult implements \JsonSerializable {
* @param ?string $description Translated detailed description to display to the user
* @param ?string $linkToDoc URI of related relevent documentation, be it from Nextcloud or another project
* @since 28.0.0
* @since 28.0.2 Optional parameter ?array $descriptionParameters
*/
public static function error(?string $description = null, ?string $linkToDoc = null): self {
return new self(self::ERROR, $description, $linkToDoc);
public static function error(?string $description = null, ?string $linkToDoc = null, ?array $descriptionParameters = null): self {
return new self(self::ERROR, $description, $descriptionParameters, $linkToDoc);
}
/**
@ -113,6 +125,17 @@ class SetupResult implements \JsonSerializable {
return $this->description;
}
/**
* @brief Get the description parameters for the setup check result
*
* If this returns null, description must not be treated as rich text
*
* @since 28.0.2
*/
public function getDescriptionParameters(): ?array {
return $this->descriptionParameters;
}
/**
* @brief Get the name for the setup check
*
@ -150,6 +173,7 @@ class SetupResult implements \JsonSerializable {
'name' => $this->name,
'severity' => $this->severity,
'description' => $this->description,
'descriptionParameters' => $this->descriptionParameters,
'linkToDoc' => $this->linkToDoc,
];
}