aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Comments/Comment.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Comments/Comment.php')
-rw-r--r--lib/private/Comments/Comment.php82
1 files changed, 35 insertions, 47 deletions
diff --git a/lib/private/Comments/Comment.php b/lib/private/Comments/Comment.php
index b1261a72520..7190f252c82 100644
--- a/lib/private/Comments/Comment.php
+++ b/lib/private/Comments/Comment.php
@@ -1,27 +1,9 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Joas Schilling <coding@schilljs.com>
- * @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-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OC\Comments;
@@ -34,7 +16,7 @@ class Comment implements IComment {
'id' => '',
'parentId' => '0',
'topmostParentId' => '0',
- 'childrenCount' => '0',
+ 'childrenCount' => 0,
'message' => '',
'verb' => '',
'actorType' => '',
@@ -52,8 +34,8 @@ class Comment implements IComment {
/**
* Comment constructor.
*
- * @param array $data optional, array with keys according to column names from
- * the comments database scheme
+ * @param array $data optional, array with keys according to column names from
+ * the comments database scheme
*/
public function __construct(?array $data = null) {
if (is_array($data)) {
@@ -193,7 +175,7 @@ class Comment implements IComment {
}
$message = trim($message);
if ($maxLength && mb_strlen($message, 'UTF-8') > $maxLength) {
- throw new MessageTooLongException('Comment message must not exceed ' . $maxLength. ' characters');
+ throw new MessageTooLongException('Comment message must not exceed ' . $maxLength . ' characters');
}
$this->data['message'] = $message;
return $this;
@@ -203,24 +185,15 @@ class Comment implements IComment {
* returns an array containing mentions that are included in the comment
*
* @return array each mention provides a 'type' and an 'id', see example below
+ * @psalm-return list<array{type: 'guest'|'email'|'federated_group'|'group'|'federated_team'|'team'|'federated_user'|'user', id: non-empty-lowercase-string}>
+ * @since 30.0.2 Type 'email' is supported
+ * @since 29.0.0 Types 'federated_group', 'federated_team', 'team' and 'federated_user' are supported
+ * @since 23.0.0 Type 'group' is supported
+ * @since 17.0.0 Type 'guest' is supported
* @since 11.0.0
- *
- * The return array looks like:
- * [
- * [
- * 'type' => 'user',
- * 'id' => 'citizen4'
- * ],
- * [
- * 'type' => 'group',
- * 'id' => 'media'
- * ],
- * …
- * ]
- *
*/
public function getMentions(): array {
- $ok = preg_match_all("/\B(?<![^a-z0-9_\-@\.\'\s])@(\"guest\/[a-f0-9]+\"|\"(?:federated_)?(?:group|team|user){1}\/[a-z0-9_\-@\.\' \/:]+\"|\"[a-z0-9_\-@\.\' ]+\"|[a-z0-9_\-@\.\']+)/i", $this->getMessage(), $mentions);
+ $ok = preg_match_all("/\B(?<![^a-z0-9_\-@\.\'\s])@(\"(guest|email)\/[a-f0-9]+\"|\"(?:federated_)?(?:group|team|user){1}\/[a-z0-9_\-@\.\' \/:]+\"|\"[a-z0-9_\-@\.\' ]+\"|[a-z0-9_\-@\.\']+)/i", $this->getMessage(), $mentions);
if (!$ok || !isset($mentions[0])) {
return [];
}
@@ -231,20 +204,35 @@ class Comment implements IComment {
$result = [];
foreach ($mentionIds as $mentionId) {
// Cut-off the @ and remove wrapping double-quotes
+ /** @var non-empty-lowercase-string $cleanId */
$cleanId = trim(substr($mentionId, 1), '"');
if (str_starts_with($cleanId, 'guest/')) {
$result[] = ['type' => 'guest', 'id' => $cleanId];
+ } elseif (str_starts_with($cleanId, 'email/')) {
+ /** @var non-empty-lowercase-string $cleanId */
+ $cleanId = substr($cleanId, 6);
+ $result[] = ['type' => 'email', 'id' => $cleanId];
} elseif (str_starts_with($cleanId, 'federated_group/')) {
- $result[] = ['type' => 'federated_group', 'id' => substr($cleanId, 16)];
+ /** @var non-empty-lowercase-string $cleanId */
+ $cleanId = substr($cleanId, 16);
+ $result[] = ['type' => 'federated_group', 'id' => $cleanId];
} elseif (str_starts_with($cleanId, 'group/')) {
- $result[] = ['type' => 'group', 'id' => substr($cleanId, 6)];
+ /** @var non-empty-lowercase-string $cleanId */
+ $cleanId = substr($cleanId, 6);
+ $result[] = ['type' => 'group', 'id' => $cleanId];
} elseif (str_starts_with($cleanId, 'federated_team/')) {
- $result[] = ['type' => 'federated_team', 'id' => substr($cleanId, 15)];
+ /** @var non-empty-lowercase-string $cleanId */
+ $cleanId = substr($cleanId, 15);
+ $result[] = ['type' => 'federated_team', 'id' => $cleanId];
} elseif (str_starts_with($cleanId, 'team/')) {
- $result[] = ['type' => 'team', 'id' => substr($cleanId, 5)];
+ /** @var non-empty-lowercase-string $cleanId */
+ $cleanId = substr($cleanId, 5);
+ $result[] = ['type' => 'team', 'id' => $cleanId];
} elseif (str_starts_with($cleanId, 'federated_user/')) {
- $result[] = ['type' => 'federated_user', 'id' => substr($cleanId, 15)];
+ /** @var non-empty-lowercase-string $cleanId */
+ $cleanId = substr($cleanId, 15);
+ $result[] = ['type' => 'federated_user', 'id' => $cleanId];
} else {
$result[] = ['type' => 'user', 'id' => $cleanId];
}
@@ -315,7 +303,7 @@ class Comment implements IComment {
*
* If not explicitly set, it shall default to the time of initialization.
* @since 9.0.0
- * @throw \LogicException if creation date time is not set yet
+ * @throws \LogicException if creation date time is not set yet
*/
public function getCreationDateTime(): \DateTime {
if (!isset($this->data['creationDT'])) {
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 14:43:20 +0000