aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/App/InfoParser.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/App/InfoParser.php')
-rw-r--r--lib/private/App/InfoParser.php188
1 files changed, 127 insertions, 61 deletions
diff --git a/lib/private/App/InfoParser.php b/lib/private/App/InfoParser.php
index 9d57ef95688..634dc1fbdd5 100644
--- a/lib/private/App/InfoParser.php
+++ b/lib/private/App/InfoParser.php
@@ -1,54 +1,29 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- * @copyright Copyright (c) 2016, Lukas Reschke <lukas@statuscode.ch>
- *
- * @author Andreas Fischer <bantu@owncloud.com>
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Daniel Kesselberg <mail@danielkesselberg.de>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @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\App;
use OCP\ICache;
-use function libxml_disable_entity_loader;
-use function simplexml_load_file;
+use function simplexml_load_string;
class InfoParser {
- /** @var \OCP\ICache|null */
- private $cache;
-
/**
* @param ICache|null $cache
*/
- public function __construct(ICache $cache = null) {
- $this->cache = $cache;
+ public function __construct(
+ private ?ICache $cache = null,
+ ) {
}
/**
* @param string $file the xml file to be loaded
* @return null|array where null is an indicator for an error
*/
- public function parse($file) {
+ public function parse(string $file): ?array {
if (!file_exists($file)) {
return null;
}
@@ -61,13 +36,7 @@ class InfoParser {
}
libxml_use_internal_errors(true);
- if ((PHP_VERSION_ID < 80000)) {
- $loadEntities = libxml_disable_entity_loader(false);
- $xml = simplexml_load_file($file);
- libxml_disable_entity_loader($loadEntities);
- } else {
- $xml = simplexml_load_file($file);
- }
+ $xml = simplexml_load_string(file_get_contents($file));
if ($xml === false) {
libxml_clear_errors();
@@ -75,7 +44,7 @@ class InfoParser {
}
$array = $this->xmlToArray($xml);
- if (is_null($array)) {
+ if (is_string($array)) {
return null;
}
@@ -145,6 +114,12 @@ class InfoParser {
if (!array_key_exists('personal-section', $array['settings'])) {
$array['settings']['personal-section'] = [];
}
+ if (!array_key_exists('dependencies', $array)) {
+ $array['dependencies'] = [];
+ }
+ if (!array_key_exists('backend', $array['dependencies'])) {
+ $array['dependencies']['backend'] = [];
+ }
if (array_key_exists('types', $array)) {
if (is_array($array['types'])) {
@@ -209,10 +184,23 @@ class InfoParser {
if (isset($array['settings']['personal-section']) && !is_array($array['settings']['personal-section'])) {
$array['settings']['personal-section'] = [$array['settings']['personal-section']];
}
-
if (isset($array['navigations']['navigation']) && $this->isNavigationItem($array['navigations']['navigation'])) {
$array['navigations']['navigation'] = [$array['navigations']['navigation']];
}
+ if (isset($array['dependencies']['backend']) && !is_array($array['dependencies']['backend'])) {
+ $array['dependencies']['backend'] = [$array['dependencies']['backend']];
+ }
+
+ // Ensure some fields are always arrays
+ if (isset($array['screenshot']) && !is_array($array['screenshot'])) {
+ $array['screenshot'] = [$array['screenshot']];
+ }
+ if (isset($array['author']) && !is_array($array['author'])) {
+ $array['author'] = [$array['author']];
+ }
+ if (isset($array['category']) && !is_array($array['category'])) {
+ $array['category'] = [$array['category']];
+ }
if ($this->cache !== null) {
$this->cache->set($fileCacheKey, json_encode($array));
@@ -220,29 +208,30 @@ class InfoParser {
return $array;
}
- /**
- * @param $data
- * @return bool
- */
- private function isNavigationItem($data): bool {
+ private function isNavigationItem(array $data): bool {
+ // Allow settings navigation items with no route entry
+ $type = $data['type'] ?? 'link';
+ if ($type === 'settings') {
+ return isset($data['name']);
+ }
return isset($data['name'], $data['route']);
}
- /**
- * @param \SimpleXMLElement $xml
- * @return array
- */
- public function xmlToArray($xml) {
- if (!$xml->children()) {
+ public function xmlToArray(\SimpleXMLElement $xml): array|string {
+ $children = $xml->children();
+ if ($children === null || count($children) === 0) {
return (string)$xml;
}
$array = [];
- foreach ($xml->children() as $element => $node) {
+ foreach ($children as $element => $node) {
+ if ($element === null) {
+ throw new \InvalidArgumentException('xml contains a null element');
+ }
$totalElement = count($xml->{$element});
if (!isset($array[$element])) {
- $array[$element] = $totalElement > 1 ? [] : "";
+ $array[$element] = $totalElement > 1 ? [] : '';
}
/** @var \SimpleXMLElement $node */
// Has attributes
@@ -250,15 +239,18 @@ class InfoParser {
$data = [
'@attributes' => [],
];
- if (!count($node->children())) {
- $value = (string)$node;
- if (!empty($value)) {
- $data['@value'] = $value;
+ $converted = $this->xmlToArray($node);
+ if (is_string($converted)) {
+ if (!empty($converted)) {
+ $data['@value'] = $converted;
}
} else {
- $data = array_merge($data, $this->xmlToArray($node));
+ $data = array_merge($data, $converted);
}
foreach ($attributes as $attr => $value) {
+ if ($attr === null) {
+ throw new \InvalidArgumentException('xml contains a null element');
+ }
$data['@attributes'][$attr] = (string)$value;
}
@@ -279,4 +271,78 @@ class InfoParser {
return $array;
}
+
+ /**
+ * Select the appropriate l10n version for fields name, summary and description
+ */
+ public function applyL10N(array $data, ?string $lang = null): array {
+ if ($lang !== '' && $lang !== null) {
+ if (isset($data['name']) && is_array($data['name'])) {
+ $data['name'] = $this->findBestL10NOption($data['name'], $lang);
+ }
+ if (isset($data['summary']) && is_array($data['summary'])) {
+ $data['summary'] = $this->findBestL10NOption($data['summary'], $lang);
+ }
+ if (isset($data['description']) && is_array($data['description'])) {
+ $data['description'] = trim($this->findBestL10NOption($data['description'], $lang));
+ }
+ } elseif (isset($data['description']) && is_string($data['description'])) {
+ $data['description'] = trim($data['description']);
+ } else {
+ $data['description'] = '';
+ }
+
+ return $data;
+ }
+
+ protected function findBestL10NOption(array $options, string $lang): string {
+ // only a single option
+ if (isset($options['@value'])) {
+ return $options['@value'];
+ }
+
+ $fallback = $similarLangFallback = $englishFallback = false;
+
+ $lang = strtolower($lang);
+ $similarLang = $lang;
+ $pos = strpos($similarLang, '_');
+ if ($pos !== false && $pos > 0) {
+ // For "de_DE" we want to find "de" and the other way around
+ $similarLang = substr($lang, 0, $pos);
+ }
+
+ foreach ($options as $option) {
+ if (is_array($option)) {
+ if ($fallback === false) {
+ $fallback = $option['@value'];
+ }
+
+ if (!isset($option['@attributes']['lang'])) {
+ continue;
+ }
+
+ $attributeLang = strtolower($option['@attributes']['lang']);
+ if ($attributeLang === $lang) {
+ return $option['@value'];
+ }
+
+ if ($attributeLang === $similarLang) {
+ $similarLangFallback = $option['@value'];
+ } elseif (str_starts_with($attributeLang, $similarLang . '_')) {
+ if ($similarLangFallback === false) {
+ $similarLangFallback = $option['@value'];
+ }
+ }
+ } else {
+ $englishFallback = $option;
+ }
+ }
+
+ if ($similarLangFallback !== false) {
+ return $similarLangFallback;
+ } elseif ($englishFallback !== false) {
+ return $englishFallback;
+ }
+ return (string)$fallback;
+ }
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-14 21:02:38 +0000