nextcloud / server

apps/comments/lib/Notification/Notifier.php

Indentation +191 added lines, -191 removed lines

@@ -39,195 +39,195 @@
 
 class Notifier implements INotifier {
 
-	/** @var IFactory */
-	protected $l10nFactory;
-
-	/** @var IRootFolder  */
-	protected $rootFolder;
-
-	/** @var ICommentsManager  */
-	protected $commentsManager;
-
-	/** @var IURLGenerator */
-	protected $url;
-
-	/** @var IUserManager */
-	protected $userManager;
-
-	public function __construct(
-		IFactory $l10nFactory,
-		IRootFolder $rootFolder,
-		ICommentsManager $commentsManager,
-		IURLGenerator $url,
-		IUserManager $userManager
-	) {
-		$this->l10nFactory = $l10nFactory;
-		$this->rootFolder = $rootFolder;
-		$this->commentsManager = $commentsManager;
-		$this->url = $url;
-		$this->userManager = $userManager;
-	}
-
-	/**
-	 * Identifier of the notifier, only use [a-z0-9_]
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getID(): string {
-		return 'comments';
-	}
-
-	/**
-	 * Human readable name describing the notifier
-	 *
-	 * @return string
-	 * @since 17.0.0
-	 */
-	public function getName(): string {
-		return $this->l10nFactory->get('comments')->t('Comments');
-	}
-
-	/**
-	 * @param INotification $notification
-	 * @param string $languageCode The code of the language that should be used to prepare the notification
-	 * @return INotification
-	 * @throws \InvalidArgumentException When the notification was not prepared by a notifier
-	 * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
-	 * @since 9.0.0
-	 */
-	public function prepare(INotification $notification, string $languageCode): INotification {
-		if ($notification->getApp() !== 'comments') {
-			throw new \InvalidArgumentException();
-		}
-		try {
-			$comment = $this->commentsManager->get($notification->getObjectId());
-		} catch (NotFoundException $e) {
-			// needs to be converted to InvalidArgumentException, otherwise none Notifications will be shown at all
-			throw new \InvalidArgumentException('Comment not found', 0, $e);
-		}
-		$l = $this->l10nFactory->get('comments', $languageCode);
-		$displayName = $comment->getActorId();
-		$isDeletedActor = $comment->getActorType() === ICommentsManager::DELETED_USER;
-		if ($comment->getActorType() === 'users') {
-			$commenter = $this->userManager->get($comment->getActorId());
-			if ($commenter instanceof IUser) {
-				$displayName = $commenter->getDisplayName();
-			}
-		}
-
-		switch ($notification->getSubject()) {
-			case 'mention':
-				$parameters = $notification->getSubjectParameters();
-				if ($parameters[0] !== 'files') {
-					throw new \InvalidArgumentException('Unsupported comment object');
-				}
-				$userFolder = $this->rootFolder->getUserFolder($notification->getUser());
-				$nodes = $userFolder->getById((int)$parameters[1]);
-				if (empty($nodes)) {
-					throw new AlreadyProcessedException();
-				}
-				$node = $nodes[0];
-
-				$path = rtrim($node->getPath(), '/');
-				if (strpos($path, '/' . $notification->getUser() . '/files/') === 0) {
-					// Remove /user/files/...
-					$fullPath = $path;
-					list(,,, $path) = explode('/', $fullPath, 4);
-				}
-				$subjectParameters = [
-					'file' => [
-						'type' => 'file',
-						'id' => $comment->getObjectId(),
-						'name' => $node->getName(),
-						'path' => $path,
-						'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $comment->getObjectId()]),
-					],
-				];
-
-				if ($isDeletedActor) {
-					$subject = $l->t('You were mentioned on “{file}”, in a comment by a user that has since been deleted');
-				} else {
-					$subject = $l->t('{user} mentioned you in a comment on “{file}”');
-					$subjectParameters['user'] = [
-						'type' => 'user',
-						'id' => $comment->getActorId(),
-						'name' => $displayName,
-					];
-				}
-				list($message, $messageParameters) = $this->commentToRichMessage($comment);
-				$notification->setRichSubject($subject, $subjectParameters)
-					->setParsedSubject($this->richToParsed($subject, $subjectParameters))
-					->setRichMessage($message, $messageParameters)
-					->setParsedMessage($this->richToParsed($message, $messageParameters))
-					->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')))
-					->setLink($this->url->linkToRouteAbsolute(
-						'comments.Notifications.view',
-						['id' => $comment->getId()])
-					);
-
-				return $notification;
-				break;
-
-			default:
-				throw new \InvalidArgumentException('Invalid subject');
-		}
-	}
-
-	public function commentToRichMessage(IComment $comment): array {
-		$message = $comment->getMessage();
-		$messageParameters = [];
-		$mentionTypeCount = [];
-		$mentions = $comment->getMentions();
-		foreach ($mentions as $mention) {
-			if ($mention['type'] === 'user') {
-				$user = $this->userManager->get($mention['id']);
-				if (!$user instanceof IUser) {
-					continue;
-				}
-			}
-			if (!array_key_exists($mention['type'], $mentionTypeCount)) {
-				$mentionTypeCount[$mention['type']] = 0;
-			}
-			$mentionTypeCount[$mention['type']]++;
-			// To keep a limited character set in parameter IDs ([a-zA-Z0-9-])
-			// the mention parameter ID does not include the mention ID (which
-			// could contain characters like '@' for user IDs) but a one-based
-			// index of the mentions of that type.
-			$mentionParameterId = 'mention-' . $mention['type'] . $mentionTypeCount[$mention['type']];
-			$message = str_replace('@"' . $mention['id'] . '"', '{' . $mentionParameterId . '}', $message);
-			if (strpos($mention['id'], ' ') === false && strpos($mention['id'], 'guest/') !== 0) {
-				$message = str_replace('@' . $mention['id'], '{' . $mentionParameterId . '}', $message);
-			}
-
-			try {
-				$displayName = $this->commentsManager->resolveDisplayName($mention['type'], $mention['id']);
-			} catch (\OutOfBoundsException $e) {
-				// There is no registered display name resolver for the mention
-				// type, so the client decides what to display.
-				$displayName = '';
-			}
-			$messageParameters[$mentionParameterId] = [
-				'type' => $mention['type'],
-				'id' => $mention['id'],
-				'name' => $displayName
-			];
-		}
-		return [$message, $messageParameters];
-	}
-
-	public function richToParsed(string $message, array $parameters): string {
-		$placeholders = $replacements = [];
-		foreach ($parameters as $placeholder => $parameter) {
-			$placeholders[] = '{' . $placeholder . '}';
-			if ($parameter['type'] === 'user') {
-				$replacements[] = '@' . $parameter['name'];
-			} elseif ($parameter['type'] === 'file') {
-				$replacements[] = $parameter['path'];
-			} else {
-				$replacements[] = $parameter['name'];
-			}
-		}
-		return str_replace($placeholders, $replacements, $message);
-	}
+    /** @var IFactory */
+    protected $l10nFactory;
+
+    /** @var IRootFolder  */
+    protected $rootFolder;
+
+    /** @var ICommentsManager  */
+    protected $commentsManager;
+
+    /** @var IURLGenerator */
+    protected $url;
+
+    /** @var IUserManager */
+    protected $userManager;
+
+    public function __construct(
+        IFactory $l10nFactory,
+        IRootFolder $rootFolder,
+        ICommentsManager $commentsManager,
+        IURLGenerator $url,
+        IUserManager $userManager
+    ) {
+        $this->l10nFactory = $l10nFactory;
+        $this->rootFolder = $rootFolder;
+        $this->commentsManager = $commentsManager;
+        $this->url = $url;
+        $this->userManager = $userManager;
+    }
+
+    /**
+     * Identifier of the notifier, only use [a-z0-9_]
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getID(): string {
+        return 'comments';
+    }
+
+    /**
+     * Human readable name describing the notifier
+     *
+     * @return string
+     * @since 17.0.0
+     */
+    public function getName(): string {
+        return $this->l10nFactory->get('comments')->t('Comments');
+    }
+
+    /**
+     * @param INotification $notification
+     * @param string $languageCode The code of the language that should be used to prepare the notification
+     * @return INotification
+     * @throws \InvalidArgumentException When the notification was not prepared by a notifier
+     * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
+     * @since 9.0.0
+     */
+    public function prepare(INotification $notification, string $languageCode): INotification {
+        if ($notification->getApp() !== 'comments') {
+            throw new \InvalidArgumentException();
+        }
+        try {
+            $comment = $this->commentsManager->get($notification->getObjectId());
+        } catch (NotFoundException $e) {
+            // needs to be converted to InvalidArgumentException, otherwise none Notifications will be shown at all
+            throw new \InvalidArgumentException('Comment not found', 0, $e);
+        }
+        $l = $this->l10nFactory->get('comments', $languageCode);
+        $displayName = $comment->getActorId();
+        $isDeletedActor = $comment->getActorType() === ICommentsManager::DELETED_USER;
+        if ($comment->getActorType() === 'users') {
+            $commenter = $this->userManager->get($comment->getActorId());
+            if ($commenter instanceof IUser) {
+                $displayName = $commenter->getDisplayName();
+            }
+        }
+
+        switch ($notification->getSubject()) {
+            case 'mention':
+                $parameters = $notification->getSubjectParameters();
+                if ($parameters[0] !== 'files') {
+                    throw new \InvalidArgumentException('Unsupported comment object');
+                }
+                $userFolder = $this->rootFolder->getUserFolder($notification->getUser());
+                $nodes = $userFolder->getById((int)$parameters[1]);
+                if (empty($nodes)) {
+                    throw new AlreadyProcessedException();
+                }
+                $node = $nodes[0];
+
+                $path = rtrim($node->getPath(), '/');
+                if (strpos($path, '/' . $notification->getUser() . '/files/') === 0) {
+                    // Remove /user/files/...
+                    $fullPath = $path;
+                    list(,,, $path) = explode('/', $fullPath, 4);
+                }
+                $subjectParameters = [
+                    'file' => [
+                        'type' => 'file',
+                        'id' => $comment->getObjectId(),
+                        'name' => $node->getName(),
+                        'path' => $path,
+                        'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $comment->getObjectId()]),
+                    ],
+                ];
+
+                if ($isDeletedActor) {
+                    $subject = $l->t('You were mentioned on “{file}”, in a comment by a user that has since been deleted');
+                } else {
+                    $subject = $l->t('{user} mentioned you in a comment on “{file}”');
+                    $subjectParameters['user'] = [
+                        'type' => 'user',
+                        'id' => $comment->getActorId(),
+                        'name' => $displayName,
+                    ];
+                }
+                list($message, $messageParameters) = $this->commentToRichMessage($comment);
+                $notification->setRichSubject($subject, $subjectParameters)
+                    ->setParsedSubject($this->richToParsed($subject, $subjectParameters))
+                    ->setRichMessage($message, $messageParameters)
+                    ->setParsedMessage($this->richToParsed($message, $messageParameters))
+                    ->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')))
+                    ->setLink($this->url->linkToRouteAbsolute(
+                        'comments.Notifications.view',
+                        ['id' => $comment->getId()])
+                    );
+
+                return $notification;
+                break;
+
+            default:
+                throw new \InvalidArgumentException('Invalid subject');
+        }
+    }
+
+    public function commentToRichMessage(IComment $comment): array {
+        $message = $comment->getMessage();
+        $messageParameters = [];
+        $mentionTypeCount = [];
+        $mentions = $comment->getMentions();
+        foreach ($mentions as $mention) {
+            if ($mention['type'] === 'user') {
+                $user = $this->userManager->get($mention['id']);
+                if (!$user instanceof IUser) {
+                    continue;
+                }
+            }
+            if (!array_key_exists($mention['type'], $mentionTypeCount)) {
+                $mentionTypeCount[$mention['type']] = 0;
+            }
+            $mentionTypeCount[$mention['type']]++;
+            // To keep a limited character set in parameter IDs ([a-zA-Z0-9-])
+            // the mention parameter ID does not include the mention ID (which
+            // could contain characters like '@' for user IDs) but a one-based
+            // index of the mentions of that type.
+            $mentionParameterId = 'mention-' . $mention['type'] . $mentionTypeCount[$mention['type']];
+            $message = str_replace('@"' . $mention['id'] . '"', '{' . $mentionParameterId . '}', $message);
+            if (strpos($mention['id'], ' ') === false && strpos($mention['id'], 'guest/') !== 0) {
+                $message = str_replace('@' . $mention['id'], '{' . $mentionParameterId . '}', $message);
+            }
+
+            try {
+                $displayName = $this->commentsManager->resolveDisplayName($mention['type'], $mention['id']);
+            } catch (\OutOfBoundsException $e) {
+                // There is no registered display name resolver for the mention
+                // type, so the client decides what to display.
+                $displayName = '';
+            }
+            $messageParameters[$mentionParameterId] = [
+                'type' => $mention['type'],
+                'id' => $mention['id'],
+                'name' => $displayName
+            ];
+        }
+        return [$message, $messageParameters];
+    }
+
+    public function richToParsed(string $message, array $parameters): string {
+        $placeholders = $replacements = [];
+        foreach ($parameters as $placeholder => $parameter) {
+            $placeholders[] = '{' . $placeholder . '}';
+            if ($parameter['type'] === 'user') {
+                $replacements[] = '@' . $parameter['name'];
+            } elseif ($parameter['type'] === 'file') {
+                $replacements[] = $parameter['path'];
+            } else {
+                $replacements[] = $parameter['name'];
+            }
+        }
+        return str_replace($placeholders, $replacements, $message);
+    }
 }

Spacing +7 added lines, -7 removed lines

@@ -123,14 +123,14 @@ 
 					throw new \InvalidArgumentException('Unsupported comment object');
 				}
 				$userFolder = $this->rootFolder->getUserFolder($notification->getUser());
-				$nodes = $userFolder->getById((int)$parameters[1]);
+				$nodes = $userFolder->getById((int) $parameters[1]);
 				if (empty($nodes)) {
 					throw new AlreadyProcessedException();
 				}
 				$node = $nodes[0];
 
 				$path = rtrim($node->getPath(), '/');
-				if (strpos($path, '/' . $notification->getUser() . '/files/') === 0) {
+				if (strpos($path, '/'.$notification->getUser().'/files/') === 0) {
 					// Remove /user/files/...
 					$fullPath = $path;
 					list(,,, $path) = explode('/', $fullPath, 4);
@@ -194,10 +194,10 @@ 
 			// the mention parameter ID does not include the mention ID (which
 			// could contain characters like '@' for user IDs) but a one-based
 			// index of the mentions of that type.
-			$mentionParameterId = 'mention-' . $mention['type'] . $mentionTypeCount[$mention['type']];
-			$message = str_replace('@"' . $mention['id'] . '"', '{' . $mentionParameterId . '}', $message);
+			$mentionParameterId = 'mention-'.$mention['type'].$mentionTypeCount[$mention['type']];
+			$message = str_replace('@"'.$mention['id'].'"', '{'.$mentionParameterId.'}', $message);
 			if (strpos($mention['id'], ' ') === false && strpos($mention['id'], 'guest/') !== 0) {
-				$message = str_replace('@' . $mention['id'], '{' . $mentionParameterId . '}', $message);
+				$message = str_replace('@'.$mention['id'], '{'.$mentionParameterId.'}', $message);
 			}
 
 			try {
@@ -219,9 +219,9 @@ 
 	public function richToParsed(string $message, array $parameters): string {
 		$placeholders = $replacements = [];
 		foreach ($parameters as $placeholder => $parameter) {
-			$placeholders[] = '{' . $placeholder . '}';
+			$placeholders[] = '{'.$placeholder.'}';
 			if ($parameter['type'] === 'user') {
-				$replacements[] = '@' . $parameter['name'];
+				$replacements[] = '@'.$parameter['name'];
 			} elseif ($parameter['type'] === 'file') {
 				$replacements[] = $parameter['path'];
 			} else {

apps/comments/lib/Activity/Provider.php

Indentation +234 added lines, -234 removed lines

@@ -37,238 +37,238 @@
 
 class Provider implements IProvider {
 
-	/** @var IFactory */
-	protected $languageFactory;
-
-	/** @var IL10N */
-	protected $l;
-
-	/** @var IURLGenerator */
-	protected $url;
-
-	/** @var ICommentsManager */
-	protected $commentsManager;
-
-	/** @var IUserManager */
-	protected $userManager;
-
-	/** @var IManager */
-	protected $activityManager;
-
-	/** @var string[] */
-	protected $displayNames = [];
-
-	/**
-	 * @param IFactory $languageFactory
-	 * @param IURLGenerator $url
-	 * @param ICommentsManager $commentsManager
-	 * @param IUserManager $userManager
-	 * @param IManager $activityManager
-	 */
-	public function __construct(IFactory $languageFactory, IURLGenerator $url, ICommentsManager $commentsManager, IUserManager $userManager, IManager $activityManager) {
-		$this->languageFactory = $languageFactory;
-		$this->url = $url;
-		$this->commentsManager = $commentsManager;
-		$this->userManager = $userManager;
-		$this->activityManager = $activityManager;
-	}
-
-	/**
-	 * @param string $language
-	 * @param IEvent $event
-	 * @param IEvent|null $previousEvent
-	 * @return IEvent
-	 * @throws \InvalidArgumentException
-	 * @since 11.0.0
-	 */
-	public function parse($language, IEvent $event, IEvent $previousEvent = null) {
-		if ($event->getApp() !== 'comments') {
-			throw new \InvalidArgumentException();
-		}
-
-		$this->l = $this->languageFactory->get('comments', $language);
-
-		if ($event->getSubject() === 'add_comment_subject') {
-			$this->parseMessage($event);
-			if ($this->activityManager->getRequirePNG()) {
-				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.png')));
-			} else {
-				$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')));
-			}
-
-			if ($this->activityManager->isFormattingFilteredObject()) {
-				try {
-					return $this->parseShortVersion($event);
-				} catch (\InvalidArgumentException $e) {
-					// Ignore and simply use the long version...
-				}
-			}
-
-			return $this->parseLongVersion($event);
-		} else {
-			throw new \InvalidArgumentException();
-		}
-	}
-
-	/**
-	 * @param IEvent $event
-	 * @return IEvent
-	 * @throws \InvalidArgumentException
-	 */
-	protected function parseShortVersion(IEvent $event) {
-		$subjectParameters = $this->getSubjectParameters($event);
-
-		if ($event->getSubject() === 'add_comment_subject') {
-			if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
-				$event->setParsedSubject($this->l->t('You commented'))
-					->setRichSubject($this->l->t('You commented'), []);
-			} else {
-				$author = $this->generateUserParameter($subjectParameters['actor']);
-				$event->setParsedSubject($this->l->t('%1$s commented', [$author['name']]))
-					->setRichSubject($this->l->t('{author} commented'), [
-						'author' => $author,
-					]);
-			}
-		} else {
-			throw new \InvalidArgumentException();
-		}
-
-		return $event;
-	}
-
-	/**
-	 * @param IEvent $event
-	 * @return IEvent
-	 * @throws \InvalidArgumentException
-	 */
-	protected function parseLongVersion(IEvent $event) {
-		$subjectParameters = $this->getSubjectParameters($event);
-
-		if ($event->getSubject() === 'add_comment_subject') {
-			if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
-				$event->setParsedSubject($this->l->t('You commented on %1$s', [
-					$subjectParameters['filePath'],
-				]))
-					->setRichSubject($this->l->t('You commented on {file}'), [
-						'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
-					]);
-			} else {
-				$author = $this->generateUserParameter($subjectParameters['actor']);
-				$event->setParsedSubject($this->l->t('%1$s commented on %2$s', [
-					$author['name'],
-					$subjectParameters['filePath'],
-				]))
-					->setRichSubject($this->l->t('{author} commented on {file}'), [
-						'author' => $author,
-						'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
-					]);
-			}
-		} else {
-			throw new \InvalidArgumentException();
-		}
-
-		return $event;
-	}
-
-	protected function getSubjectParameters(IEvent $event) {
-		$subjectParameters = $event->getSubjectParameters();
-		if (isset($subjectParameters['fileId'])) {
-			return $subjectParameters;
-		}
-
-		// Fix subjects from 12.0.3 and older
-		//
-		// Do NOT Remove unless necessary
-		// Removing this will break parsing of activities that were created on
-		// Nextcloud 12, so we should keep this as long as it's acceptable.
-		// Otherwise if people upgrade over multiple releases in a short period,
-		// they will get the dead entries in their stream.
-		return [
-			'actor' => $subjectParameters[0],
-			'fileId' => $event->getObjectId(),
-			'filePath' => trim($subjectParameters[1], '/'),
-		];
-	}
-
-	/**
-	 * @param IEvent $event
-	 */
-	protected function parseMessage(IEvent $event) {
-		$messageParameters = $event->getMessageParameters();
-		if (empty($messageParameters)) {
-			// Email
-			return;
-		}
-
-		$commentId = isset($messageParameters['commentId']) ? $messageParameters['commentId'] : $messageParameters[0];
-
-		try {
-			$comment = $this->commentsManager->get((string) $commentId);
-			$message = $comment->getMessage();
-
-			$mentionCount = 1;
-			$mentions = [];
-			foreach ($comment->getMentions() as $mention) {
-				if ($mention['type'] !== 'user') {
-					continue;
-				}
-
-				$message = str_replace('@"' . $mention['id'] . '"', '{mention' . $mentionCount . '}', $message);
-				if (strpos($mention['id'], ' ') === false && strpos($mention['id'], 'guest/') !== 0) {
-					$message = str_replace('@' . $mention['id'], '{mention' . $mentionCount . '}', $message);
-				}
-
-				$mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']);
-				$mentionCount++;
-			}
-
-			$event->setParsedMessage($comment->getMessage())
-				->setRichMessage($message, $mentions);
-		} catch (NotFoundException $e) {
-		}
-	}
-
-	/**
-	 * @param int $id
-	 * @param string $path
-	 * @return array
-	 */
-	protected function generateFileParameter($id, $path) {
-		return [
-			'type' => 'file',
-			'id' => $id,
-			'name' => basename($path),
-			'path' => $path,
-			'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]),
-		];
-	}
-
-	/**
-	 * @param string $uid
-	 * @return array
-	 */
-	protected function generateUserParameter($uid) {
-		if (!isset($this->displayNames[$uid])) {
-			$this->displayNames[$uid] = $this->getDisplayName($uid);
-		}
-
-		return [
-			'type' => 'user',
-			'id' => $uid,
-			'name' => $this->displayNames[$uid],
-		];
-	}
-
-	/**
-	 * @param string $uid
-	 * @return string
-	 */
-	protected function getDisplayName($uid) {
-		$user = $this->userManager->get($uid);
-		if ($user instanceof IUser) {
-			return $user->getDisplayName();
-		} else {
-			return $uid;
-		}
-	}
+    /** @var IFactory */
+    protected $languageFactory;
+
+    /** @var IL10N */
+    protected $l;
+
+    /** @var IURLGenerator */
+    protected $url;
+
+    /** @var ICommentsManager */
+    protected $commentsManager;
+
+    /** @var IUserManager */
+    protected $userManager;
+
+    /** @var IManager */
+    protected $activityManager;
+
+    /** @var string[] */
+    protected $displayNames = [];
+
+    /**
+     * @param IFactory $languageFactory
+     * @param IURLGenerator $url
+     * @param ICommentsManager $commentsManager
+     * @param IUserManager $userManager
+     * @param IManager $activityManager
+     */
+    public function __construct(IFactory $languageFactory, IURLGenerator $url, ICommentsManager $commentsManager, IUserManager $userManager, IManager $activityManager) {
+        $this->languageFactory = $languageFactory;
+        $this->url = $url;
+        $this->commentsManager = $commentsManager;
+        $this->userManager = $userManager;
+        $this->activityManager = $activityManager;
+    }
+
+    /**
+     * @param string $language
+     * @param IEvent $event
+     * @param IEvent|null $previousEvent
+     * @return IEvent
+     * @throws \InvalidArgumentException
+     * @since 11.0.0
+     */
+    public function parse($language, IEvent $event, IEvent $previousEvent = null) {
+        if ($event->getApp() !== 'comments') {
+            throw new \InvalidArgumentException();
+        }
+
+        $this->l = $this->languageFactory->get('comments', $language);
+
+        if ($event->getSubject() === 'add_comment_subject') {
+            $this->parseMessage($event);
+            if ($this->activityManager->getRequirePNG()) {
+                $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.png')));
+            } else {
+                $event->setIcon($this->url->getAbsoluteURL($this->url->imagePath('core', 'actions/comment.svg')));
+            }
+
+            if ($this->activityManager->isFormattingFilteredObject()) {
+                try {
+                    return $this->parseShortVersion($event);
+                } catch (\InvalidArgumentException $e) {
+                    // Ignore and simply use the long version...
+                }
+            }
+
+            return $this->parseLongVersion($event);
+        } else {
+            throw new \InvalidArgumentException();
+        }
+    }
+
+    /**
+     * @param IEvent $event
+     * @return IEvent
+     * @throws \InvalidArgumentException
+     */
+    protected function parseShortVersion(IEvent $event) {
+        $subjectParameters = $this->getSubjectParameters($event);
+
+        if ($event->getSubject() === 'add_comment_subject') {
+            if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
+                $event->setParsedSubject($this->l->t('You commented'))
+                    ->setRichSubject($this->l->t('You commented'), []);
+            } else {
+                $author = $this->generateUserParameter($subjectParameters['actor']);
+                $event->setParsedSubject($this->l->t('%1$s commented', [$author['name']]))
+                    ->setRichSubject($this->l->t('{author} commented'), [
+                        'author' => $author,
+                    ]);
+            }
+        } else {
+            throw new \InvalidArgumentException();
+        }
+
+        return $event;
+    }
+
+    /**
+     * @param IEvent $event
+     * @return IEvent
+     * @throws \InvalidArgumentException
+     */
+    protected function parseLongVersion(IEvent $event) {
+        $subjectParameters = $this->getSubjectParameters($event);
+
+        if ($event->getSubject() === 'add_comment_subject') {
+            if ($subjectParameters['actor'] === $this->activityManager->getCurrentUserId()) {
+                $event->setParsedSubject($this->l->t('You commented on %1$s', [
+                    $subjectParameters['filePath'],
+                ]))
+                    ->setRichSubject($this->l->t('You commented on {file}'), [
+                        'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
+                    ]);
+            } else {
+                $author = $this->generateUserParameter($subjectParameters['actor']);
+                $event->setParsedSubject($this->l->t('%1$s commented on %2$s', [
+                    $author['name'],
+                    $subjectParameters['filePath'],
+                ]))
+                    ->setRichSubject($this->l->t('{author} commented on {file}'), [
+                        'author' => $author,
+                        'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
+                    ]);
+            }
+        } else {
+            throw new \InvalidArgumentException();
+        }
+
+        return $event;
+    }
+
+    protected function getSubjectParameters(IEvent $event) {
+        $subjectParameters = $event->getSubjectParameters();
+        if (isset($subjectParameters['fileId'])) {
+            return $subjectParameters;
+        }
+
+        // Fix subjects from 12.0.3 and older
+        //
+        // Do NOT Remove unless necessary
+        // Removing this will break parsing of activities that were created on
+        // Nextcloud 12, so we should keep this as long as it's acceptable.
+        // Otherwise if people upgrade over multiple releases in a short period,
+        // they will get the dead entries in their stream.
+        return [
+            'actor' => $subjectParameters[0],
+            'fileId' => $event->getObjectId(),
+            'filePath' => trim($subjectParameters[1], '/'),
+        ];
+    }
+
+    /**
+     * @param IEvent $event
+     */
+    protected function parseMessage(IEvent $event) {
+        $messageParameters = $event->getMessageParameters();
+        if (empty($messageParameters)) {
+            // Email
+            return;
+        }
+
+        $commentId = isset($messageParameters['commentId']) ? $messageParameters['commentId'] : $messageParameters[0];
+
+        try {
+            $comment = $this->commentsManager->get((string) $commentId);
+            $message = $comment->getMessage();
+
+            $mentionCount = 1;
+            $mentions = [];
+            foreach ($comment->getMentions() as $mention) {
+                if ($mention['type'] !== 'user') {
+                    continue;
+                }
+
+                $message = str_replace('@"' . $mention['id'] . '"', '{mention' . $mentionCount . '}', $message);
+                if (strpos($mention['id'], ' ') === false && strpos($mention['id'], 'guest/') !== 0) {
+                    $message = str_replace('@' . $mention['id'], '{mention' . $mentionCount . '}', $message);
+                }
+
+                $mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']);
+                $mentionCount++;
+            }
+
+            $event->setParsedMessage($comment->getMessage())
+                ->setRichMessage($message, $mentions);
+        } catch (NotFoundException $e) {
+        }
+    }
+
+    /**
+     * @param int $id
+     * @param string $path
+     * @return array
+     */
+    protected function generateFileParameter($id, $path) {
+        return [
+            'type' => 'file',
+            'id' => $id,
+            'name' => basename($path),
+            'path' => $path,
+            'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]),
+        ];
+    }
+
+    /**
+     * @param string $uid
+     * @return array
+     */
+    protected function generateUserParameter($uid) {
+        if (!isset($this->displayNames[$uid])) {
+            $this->displayNames[$uid] = $this->getDisplayName($uid);
+        }
+
+        return [
+            'type' => 'user',
+            'id' => $uid,
+            'name' => $this->displayNames[$uid],
+        ];
+    }
+
+    /**
+     * @param string $uid
+     * @return string
+     */
+    protected function getDisplayName($uid) {
+        $user = $this->userManager->get($uid);
+        if ($user instanceof IUser) {
+            return $user->getDisplayName();
+        } else {
+            return $uid;
+        }
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -213,12 +213,12 @@
 					continue;
 				}
 
-				$message = str_replace('@"' . $mention['id'] . '"', '{mention' . $mentionCount . '}', $message);
+				$message = str_replace('@"'.$mention['id'].'"', '{mention'.$mentionCount.'}', $message);
 				if (strpos($mention['id'], ' ') === false && strpos($mention['id'], 'guest/') !== 0) {
-					$message = str_replace('@' . $mention['id'], '{mention' . $mentionCount . '}', $message);
+					$message = str_replace('@'.$mention['id'], '{mention'.$mentionCount.'}', $message);
 				}
 
-				$mentions['mention' . $mentionCount] = $this->generateUserParameter($mention['id']);
+				$mentions['mention'.$mentionCount] = $this->generateUserParameter($mention['id']);
 				$mentionCount++;
 			}
 

lib/private/Comments/Comment.php

Indentation +425 added lines, -425 removed lines

@@ -31,429 +31,429 @@
 use OCP\Comments\MessageTooLongException;
 
 class Comment implements IComment {
-	protected $data = [
-		'id' => '',
-		'parentId' => '0',
-		'topmostParentId' => '0',
-		'childrenCount' => '0',
-		'message' => '',
-		'verb' => '',
-		'actorType' => '',
-		'actorId' => '',
-		'objectType' => '',
-		'objectId' => '',
-		'referenceId' => null,
-		'creationDT' => null,
-		'latestChildDT' => null,
-	];
-
-	/**
-	 * Comment constructor.
-	 *
-	 * @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)) {
-			$this->fromArray($data);
-		}
-	}
-
-	/**
-	 * returns the ID of the comment
-	 *
-	 * It may return an empty string, if the comment was not stored.
-	 * It is expected that the concrete Comment implementation gives an ID
-	 * by itself (e.g. after saving).
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getId() {
-		return $this->data['id'];
-	}
-
-	/**
-	 * sets the ID of the comment and returns itself
-	 *
-	 * It is only allowed to set the ID only, if the current id is an empty
-	 * string (which means it is not stored in a database, storage or whatever
-	 * the concrete implementation does), or vice versa. Changing a given ID is
-	 * not permitted and must result in an IllegalIDChangeException.
-	 *
-	 * @param string $id
-	 * @return IComment
-	 * @throws IllegalIDChangeException
-	 * @since 9.0.0
-	 */
-	public function setId($id) {
-		if (!is_string($id)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-
-		$id = trim($id);
-		if ($this->data['id'] === '' || ($this->data['id'] !== '' && $id === '')) {
-			$this->data['id'] = $id;
-			return $this;
-		}
-
-		throw new IllegalIDChangeException('Not allowed to assign a new ID to an already saved comment.');
-	}
-
-	/**
-	 * returns the parent ID of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getParentId() {
-		return $this->data['parentId'];
-	}
-
-	/**
-	 * sets the parent ID and returns itself
-	 *
-	 * @param string $parentId
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setParentId($parentId) {
-		if (!is_string($parentId)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$this->data['parentId'] = trim($parentId);
-		return $this;
-	}
-
-	/**
-	 * returns the topmost parent ID of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getTopmostParentId() {
-		return $this->data['topmostParentId'];
-	}
-
-
-	/**
-	 * sets the topmost parent ID and returns itself
-	 *
-	 * @param string $id
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setTopmostParentId($id) {
-		if (!is_string($id)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$this->data['topmostParentId'] = trim($id);
-		return $this;
-	}
-
-	/**
-	 * returns the number of children
-	 *
-	 * @return int
-	 * @since 9.0.0
-	 */
-	public function getChildrenCount() {
-		return $this->data['childrenCount'];
-	}
-
-	/**
-	 * sets the number of children
-	 *
-	 * @param int $count
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setChildrenCount($count) {
-		if (!is_int($count)) {
-			throw new \InvalidArgumentException('Integer expected.');
-		}
-		$this->data['childrenCount'] = $count;
-		return $this;
-	}
-
-	/**
-	 * returns the message of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getMessage() {
-		return $this->data['message'];
-	}
-
-	/**
-	 * sets the message of the comment and returns itself
-	 *
-	 * @param string $message
-	 * @param int $maxLength
-	 * @return IComment
-	 * @throws MessageTooLongException
-	 * @since 9.0.0
-	 */
-	public function setMessage($message, $maxLength = self::MAX_MESSAGE_LENGTH) {
-		if (!is_string($message)) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$message = trim($message);
-		if ($maxLength && mb_strlen($message, 'UTF-8') > $maxLength) {
-			throw new MessageTooLongException('Comment message must not exceed ' . $maxLength. ' characters');
-		}
-		$this->data['message'] = $message;
-		return $this;
-	}
-
-	/**
-	 * returns an array containing mentions that are included in the comment
-	 *
-	 * @return array each mention provides a 'type' and an 'id', see example below
-	 * @since 11.0.0
-	 *
-	 * The return array looks like:
-	 * [
-	 *   [
-	 *     'type' => 'user',
-	 *     'id' => 'citizen4'
-	 *   ],
-	 *   [
-	 *     'type' => 'group',
-	 *     'id' => 'media'
-	 *   ],
-	 *   …
-	 * ]
-	 *
-	 */
-	public function getMentions() {
-		$ok = preg_match_all("/\B(?<![^a-z0-9_\-@\.\'\s])@(\"guest\/[a-f0-9]+\"|\"[a-z0-9_\-@\.\' ]+\"|[a-z0-9_\-@\.\']+)/i", $this->getMessage(), $mentions);
-		if (!$ok || !isset($mentions[0]) || !is_array($mentions[0])) {
-			return [];
-		}
-		$uids = array_unique($mentions[0]);
-		usort($uids, static function ($uid1, $uid2) {
-			return mb_strlen($uid2) <=> mb_strlen($uid1);
-		});
-		$result = [];
-		foreach ($uids as $uid) {
-			$cleanUid = trim(substr($uid, 1), '"');
-			if (strpos($cleanUid, 'guest/') === 0) {
-				$result[] = ['type' => 'guest', 'id' => $cleanUid];
-			} else {
-				$result[] = ['type' => 'user', 'id' => $cleanUid];
-			}
-		}
-		return $result;
-	}
-
-	/**
-	 * returns the verb of the comment
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getVerb() {
-		return $this->data['verb'];
-	}
-
-	/**
-	 * sets the verb of the comment, e.g. 'comment' or 'like'
-	 *
-	 * @param string $verb
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setVerb($verb) {
-		if (!is_string($verb) || !trim($verb)) {
-			throw new \InvalidArgumentException('Non-empty String expected.');
-		}
-		$this->data['verb'] = trim($verb);
-		return $this;
-	}
-
-	/**
-	 * returns the actor type
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getActorType() {
-		return $this->data['actorType'];
-	}
-
-	/**
-	 * returns the actor ID
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getActorId() {
-		return $this->data['actorId'];
-	}
-
-	/**
-	 * sets (overwrites) the actor type and id
-	 *
-	 * @param string $actorType e.g. 'users'
-	 * @param string $actorId e.g. 'zombie234'
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setActor($actorType, $actorId) {
-		if (
-			   !is_string($actorType) || !trim($actorType)
-			|| !is_string($actorId) || $actorId === ''
-		) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$this->data['actorType'] = trim($actorType);
-		$this->data['actorId'] = $actorId;
-		return $this;
-	}
-
-	/**
-	 * returns the creation date of the comment.
-	 *
-	 * If not explicitly set, it shall default to the time of initialization.
-	 *
-	 * @return \DateTime
-	 * @since 9.0.0
-	 */
-	public function getCreationDateTime() {
-		return $this->data['creationDT'];
-	}
-
-	/**
-	 * sets the creation date of the comment and returns itself
-	 *
-	 * @param \DateTime $timestamp
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setCreationDateTime(\DateTime $timestamp) {
-		$this->data['creationDT'] = $timestamp;
-		return $this;
-	}
-
-	/**
-	 * returns the DateTime of the most recent child, if set, otherwise null
-	 *
-	 * @return \DateTime|null
-	 * @since 9.0.0
-	 */
-	public function getLatestChildDateTime() {
-		return $this->data['latestChildDT'];
-	}
-
-	/**
-	 * sets the date of the most recent child
-	 *
-	 * @param \DateTime $dateTime
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setLatestChildDateTime(\DateTime $dateTime = null) {
-		$this->data['latestChildDT'] = $dateTime;
-		return $this;
-	}
-
-	/**
-	 * returns the object type the comment is attached to
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getObjectType() {
-		return $this->data['objectType'];
-	}
-
-	/**
-	 * returns the object id the comment is attached to
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getObjectId() {
-		return $this->data['objectId'];
-	}
-
-	/**
-	 * sets (overwrites) the object of the comment
-	 *
-	 * @param string $objectType e.g. 'files'
-	 * @param string $objectId e.g. '16435'
-	 * @return IComment
-	 * @since 9.0.0
-	 */
-	public function setObject($objectType, $objectId) {
-		if (
-			   !is_string($objectType) || !trim($objectType)
-			|| !is_string($objectId) || trim($objectId) === ''
-		) {
-			throw new \InvalidArgumentException('String expected.');
-		}
-		$this->data['objectType'] = trim($objectType);
-		$this->data['objectId'] = trim($objectId);
-		return $this;
-	}
-
-	/**
-	 * returns the reference id of the comment
-	 *
-	 * @return string|null
-	 * @since 19.0.0
-	 */
-	public function getReferenceId(): ?string {
-		return $this->data['referenceId'];
-	}
-
-	/**
-	 * sets (overwrites) the reference id of the comment
-	 *
-	 * @param string $referenceId e.g. sha256 hash sum
-	 * @return IComment
-	 * @since 19.0.0
-	 */
-	public function setReferenceId(?string $referenceId): IComment {
-		if ($referenceId === null) {
-			$this->data['referenceId'] = $referenceId;
-		} else {
-			$referenceId = trim($referenceId);
-			if ($referenceId === '') {
-				throw new \InvalidArgumentException('Non empty string expected.');
-			}
-			$this->data['referenceId'] = $referenceId;
-		}
-		return $this;
-	}
-
-	/**
-	 * sets the comment data based on an array with keys as taken from the
-	 * database.
-	 *
-	 * @param array $data
-	 * @return IComment
-	 */
-	protected function fromArray($data) {
-		foreach (array_keys($data) as $key) {
-			// translate DB keys to internal setter names
-			$setter = 'set' . implode('', array_map('ucfirst', explode('_', $key)));
-			$setter = str_replace('Timestamp', 'DateTime', $setter);
-
-			if (method_exists($this, $setter)) {
-				$this->$setter($data[$key]);
-			}
-		}
-
-		foreach (['actor', 'object'] as $role) {
-			if (isset($data[$role . '_type']) && isset($data[$role . '_id'])) {
-				$setter = 'set' . ucfirst($role);
-				$this->$setter($data[$role . '_type'], $data[$role . '_id']);
-			}
-		}
-
-		return $this;
-	}
+    protected $data = [
+        'id' => '',
+        'parentId' => '0',
+        'topmostParentId' => '0',
+        'childrenCount' => '0',
+        'message' => '',
+        'verb' => '',
+        'actorType' => '',
+        'actorId' => '',
+        'objectType' => '',
+        'objectId' => '',
+        'referenceId' => null,
+        'creationDT' => null,
+        'latestChildDT' => null,
+    ];
+
+    /**
+     * Comment constructor.
+     *
+     * @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)) {
+            $this->fromArray($data);
+        }
+    }
+
+    /**
+     * returns the ID of the comment
+     *
+     * It may return an empty string, if the comment was not stored.
+     * It is expected that the concrete Comment implementation gives an ID
+     * by itself (e.g. after saving).
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getId() {
+        return $this->data['id'];
+    }
+
+    /**
+     * sets the ID of the comment and returns itself
+     *
+     * It is only allowed to set the ID only, if the current id is an empty
+     * string (which means it is not stored in a database, storage or whatever
+     * the concrete implementation does), or vice versa. Changing a given ID is
+     * not permitted and must result in an IllegalIDChangeException.
+     *
+     * @param string $id
+     * @return IComment
+     * @throws IllegalIDChangeException
+     * @since 9.0.0
+     */
+    public function setId($id) {
+        if (!is_string($id)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+
+        $id = trim($id);
+        if ($this->data['id'] === '' || ($this->data['id'] !== '' && $id === '')) {
+            $this->data['id'] = $id;
+            return $this;
+        }
+
+        throw new IllegalIDChangeException('Not allowed to assign a new ID to an already saved comment.');
+    }
+
+    /**
+     * returns the parent ID of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getParentId() {
+        return $this->data['parentId'];
+    }
+
+    /**
+     * sets the parent ID and returns itself
+     *
+     * @param string $parentId
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setParentId($parentId) {
+        if (!is_string($parentId)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $this->data['parentId'] = trim($parentId);
+        return $this;
+    }
+
+    /**
+     * returns the topmost parent ID of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getTopmostParentId() {
+        return $this->data['topmostParentId'];
+    }
+
+
+    /**
+     * sets the topmost parent ID and returns itself
+     *
+     * @param string $id
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setTopmostParentId($id) {
+        if (!is_string($id)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $this->data['topmostParentId'] = trim($id);
+        return $this;
+    }
+
+    /**
+     * returns the number of children
+     *
+     * @return int
+     * @since 9.0.0
+     */
+    public function getChildrenCount() {
+        return $this->data['childrenCount'];
+    }
+
+    /**
+     * sets the number of children
+     *
+     * @param int $count
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setChildrenCount($count) {
+        if (!is_int($count)) {
+            throw new \InvalidArgumentException('Integer expected.');
+        }
+        $this->data['childrenCount'] = $count;
+        return $this;
+    }
+
+    /**
+     * returns the message of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getMessage() {
+        return $this->data['message'];
+    }
+
+    /**
+     * sets the message of the comment and returns itself
+     *
+     * @param string $message
+     * @param int $maxLength
+     * @return IComment
+     * @throws MessageTooLongException
+     * @since 9.0.0
+     */
+    public function setMessage($message, $maxLength = self::MAX_MESSAGE_LENGTH) {
+        if (!is_string($message)) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $message = trim($message);
+        if ($maxLength && mb_strlen($message, 'UTF-8') > $maxLength) {
+            throw new MessageTooLongException('Comment message must not exceed ' . $maxLength. ' characters');
+        }
+        $this->data['message'] = $message;
+        return $this;
+    }
+
+    /**
+     * returns an array containing mentions that are included in the comment
+     *
+     * @return array each mention provides a 'type' and an 'id', see example below
+     * @since 11.0.0
+     *
+     * The return array looks like:
+     * [
+     *   [
+     *     'type' => 'user',
+     *     'id' => 'citizen4'
+     *   ],
+     *   [
+     *     'type' => 'group',
+     *     'id' => 'media'
+     *   ],
+     *   …
+     * ]
+     *
+     */
+    public function getMentions() {
+        $ok = preg_match_all("/\B(?<![^a-z0-9_\-@\.\'\s])@(\"guest\/[a-f0-9]+\"|\"[a-z0-9_\-@\.\' ]+\"|[a-z0-9_\-@\.\']+)/i", $this->getMessage(), $mentions);
+        if (!$ok || !isset($mentions[0]) || !is_array($mentions[0])) {
+            return [];
+        }
+        $uids = array_unique($mentions[0]);
+        usort($uids, static function ($uid1, $uid2) {
+            return mb_strlen($uid2) <=> mb_strlen($uid1);
+        });
+        $result = [];
+        foreach ($uids as $uid) {
+            $cleanUid = trim(substr($uid, 1), '"');
+            if (strpos($cleanUid, 'guest/') === 0) {
+                $result[] = ['type' => 'guest', 'id' => $cleanUid];
+            } else {
+                $result[] = ['type' => 'user', 'id' => $cleanUid];
+            }
+        }
+        return $result;
+    }
+
+    /**
+     * returns the verb of the comment
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getVerb() {
+        return $this->data['verb'];
+    }
+
+    /**
+     * sets the verb of the comment, e.g. 'comment' or 'like'
+     *
+     * @param string $verb
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setVerb($verb) {
+        if (!is_string($verb) || !trim($verb)) {
+            throw new \InvalidArgumentException('Non-empty String expected.');
+        }
+        $this->data['verb'] = trim($verb);
+        return $this;
+    }
+
+    /**
+     * returns the actor type
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getActorType() {
+        return $this->data['actorType'];
+    }
+
+    /**
+     * returns the actor ID
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getActorId() {
+        return $this->data['actorId'];
+    }
+
+    /**
+     * sets (overwrites) the actor type and id
+     *
+     * @param string $actorType e.g. 'users'
+     * @param string $actorId e.g. 'zombie234'
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setActor($actorType, $actorId) {
+        if (
+                !is_string($actorType) || !trim($actorType)
+            || !is_string($actorId) || $actorId === ''
+        ) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $this->data['actorType'] = trim($actorType);
+        $this->data['actorId'] = $actorId;
+        return $this;
+    }
+
+    /**
+     * returns the creation date of the comment.
+     *
+     * If not explicitly set, it shall default to the time of initialization.
+     *
+     * @return \DateTime
+     * @since 9.0.0
+     */
+    public function getCreationDateTime() {
+        return $this->data['creationDT'];
+    }
+
+    /**
+     * sets the creation date of the comment and returns itself
+     *
+     * @param \DateTime $timestamp
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setCreationDateTime(\DateTime $timestamp) {
+        $this->data['creationDT'] = $timestamp;
+        return $this;
+    }
+
+    /**
+     * returns the DateTime of the most recent child, if set, otherwise null
+     *
+     * @return \DateTime|null
+     * @since 9.0.0
+     */
+    public function getLatestChildDateTime() {
+        return $this->data['latestChildDT'];
+    }
+
+    /**
+     * sets the date of the most recent child
+     *
+     * @param \DateTime $dateTime
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setLatestChildDateTime(\DateTime $dateTime = null) {
+        $this->data['latestChildDT'] = $dateTime;
+        return $this;
+    }
+
+    /**
+     * returns the object type the comment is attached to
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getObjectType() {
+        return $this->data['objectType'];
+    }
+
+    /**
+     * returns the object id the comment is attached to
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getObjectId() {
+        return $this->data['objectId'];
+    }
+
+    /**
+     * sets (overwrites) the object of the comment
+     *
+     * @param string $objectType e.g. 'files'
+     * @param string $objectId e.g. '16435'
+     * @return IComment
+     * @since 9.0.0
+     */
+    public function setObject($objectType, $objectId) {
+        if (
+                !is_string($objectType) || !trim($objectType)
+            || !is_string($objectId) || trim($objectId) === ''
+        ) {
+            throw new \InvalidArgumentException('String expected.');
+        }
+        $this->data['objectType'] = trim($objectType);
+        $this->data['objectId'] = trim($objectId);
+        return $this;
+    }
+
+    /**
+     * returns the reference id of the comment
+     *
+     * @return string|null
+     * @since 19.0.0
+     */
+    public function getReferenceId(): ?string {
+        return $this->data['referenceId'];
+    }
+
+    /**
+     * sets (overwrites) the reference id of the comment
+     *
+     * @param string $referenceId e.g. sha256 hash sum
+     * @return IComment
+     * @since 19.0.0
+     */
+    public function setReferenceId(?string $referenceId): IComment {
+        if ($referenceId === null) {
+            $this->data['referenceId'] = $referenceId;
+        } else {
+            $referenceId = trim($referenceId);
+            if ($referenceId === '') {
+                throw new \InvalidArgumentException('Non empty string expected.');
+            }
+            $this->data['referenceId'] = $referenceId;
+        }
+        return $this;
+    }
+
+    /**
+     * sets the comment data based on an array with keys as taken from the
+     * database.
+     *
+     * @param array $data
+     * @return IComment
+     */
+    protected function fromArray($data) {
+        foreach (array_keys($data) as $key) {
+            // translate DB keys to internal setter names
+            $setter = 'set' . implode('', array_map('ucfirst', explode('_', $key)));
+            $setter = str_replace('Timestamp', 'DateTime', $setter);
+
+            if (method_exists($this, $setter)) {
+                $this->$setter($data[$key]);
+            }
+        }
+
+        foreach (['actor', 'object'] as $role) {
+            if (isset($data[$role . '_type']) && isset($data[$role . '_id'])) {
+                $setter = 'set' . ucfirst($role);
+                $this->$setter($data[$role . '_type'], $data[$role . '_id']);
+            }
+        }
+
+        return $this;
+    }
 }

Spacing +6 added lines, -6 removed lines

@@ -201,7 +201,7 @@ 
 		}
 		$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;
@@ -233,7 +233,7 @@ 
 			return [];
 		}
 		$uids = array_unique($mentions[0]);
-		usort($uids, static function ($uid1, $uid2) {
+		usort($uids, static function($uid1, $uid2) {
 			return mb_strlen($uid2) <=> mb_strlen($uid1);
 		});
 		$result = [];
@@ -439,7 +439,7 @@ 
 	protected function fromArray($data) {
 		foreach (array_keys($data) as $key) {
 			// translate DB keys to internal setter names
-			$setter = 'set' . implode('', array_map('ucfirst', explode('_', $key)));
+			$setter = 'set'.implode('', array_map('ucfirst', explode('_', $key)));
 			$setter = str_replace('Timestamp', 'DateTime', $setter);
 
 			if (method_exists($this, $setter)) {
@@ -448,9 +448,9 @@ 
 		}
 
 		foreach (['actor', 'object'] as $role) {
-			if (isset($data[$role . '_type']) && isset($data[$role . '_id'])) {
-				$setter = 'set' . ucfirst($role);
-				$this->$setter($data[$role . '_type'], $data[$role . '_id']);
+			if (isset($data[$role.'_type']) && isset($data[$role.'_id'])) {
+				$setter = 'set'.ucfirst($role);
+				$this->$setter($data[$role.'_type'], $data[$role.'_id']);
 			}
 		}