refactor: Tighten ActorType fields and methods

Signed-off-by: provokateurin <kate@provokateurin.de>
nextcloud · Mar 1, 2024 · 616b3a1 · 616b3a1
1 parent 90e5c0b
commit 616b3a1
Show file tree

Hide file tree

Showing 30 changed files with 320 additions and 80 deletions.
diff --git a/lib/Chat/ChatManager.php b/lib/Chat/ChatManager.php
@@ -116,6 +116,7 @@ public function __construct(
 	/**
 	 * Sends a new message to the given chat.
 	 *
+	 * @psalm-param Attendee::ACTOR_* $actorType
 	 * @param bool $shouldSkipLastMessageUpdate If multiple messages will be posted
 	 *             (e.g. when adding multiple users to a room) we can skip the last
 	 *             message and last activity update until the last entry was created

diff --git a/lib/Chat/CommentsManager.php b/lib/Chat/CommentsManager.php
@@ -25,6 +25,7 @@
 
 use OC\Comments\Comment;
 use OC\Comments\Manager;
+use OCA\Talk\Model\Attendee;
 use OCP\Comments\IComment;
 use OCP\DB\Exception;
 use OCP\DB\QueryBuilder\IQueryBuilder;
@@ -66,7 +67,7 @@ public function getCommentsById(array $ids): array {
 	}
 
 	/**
-	 * @param string $actorType
+	 * @psalm-param Attendee::ACTOR_* $actorType
 	 * @param string $actorId
 	 * @param string[] $messageIds
 	 * @return array
@@ -100,6 +101,7 @@ public function retrieveReactionsByActor(string $actorType, string $actorId, arr
 	 * @param string $objectType Limit the search by object type
 	 * @param string[] $objectIds Limit the search by object ids
 	 * @param string $verb Limit the verb of the comment
+	 * @psalm-param ?Attendee::ACTOR_* $actorType
 	 * @return list<IComment>
 	 */
 	public function searchForObjectsWithFilters(string $search, string $objectType, array $objectIds, string $verb, ?\DateTimeImmutable $since, ?\DateTimeImmutable $until, ?string $actorType, ?string $actorId, int $offset, int $limit = 50): array {

diff --git a/lib/Chat/MessageParser.php b/lib/Chat/MessageParser.php
@@ -112,6 +112,9 @@ protected function setLastEditInfo(Message $message): void {
 		}
 	}
 
+	/**
+	 * @psalm-param Attendee::ACTOR_* $actorType
+	 */
 	protected function getActorInformation(Message $message, string $actorType, string $actorId, string $displayName = ''): array {
 		if ($actorType === Attendee::ACTOR_USERS) {
 			$tempDisplayName = $this->userManager->getDisplayName($actorId);

diff --git a/lib/Chat/Parser/SystemMessage.php b/lib/Chat/Parser/SystemMessage.php
@@ -843,6 +843,9 @@ protected function getActorFromComment(Room $room, IComment $comment): array {
 		return $this->getActor($room, $comment->getActorType(), $comment->getActorId());
 	}
 
+	/**
+	 * @psalm-param Attendee::ACTOR_* $actorType
+	 */
 	protected function getActor(Room $room, string $actorType, string $actorId): array {
 		if ($actorType === Attendee::ACTOR_GUESTS || $actorType === Attendee::ACTOR_EMAILS) {
 			return $this->getGuest($room, $actorType, $actorId);

diff --git a/lib/Chat/ReactionManager.php b/lib/Chat/ReactionManager.php
@@ -28,6 +28,7 @@
 use OCA\Talk\Exceptions\ReactionAlreadyExistsException;
 use OCA\Talk\Exceptions\ReactionNotSupportedException;
 use OCA\Talk\Exceptions\ReactionOutOfContextException;
+use OCA\Talk\Model\Attendee;
 use OCA\Talk\Participant;
 use OCA\Talk\ResponseDefinitions;
 use OCA\Talk\Room;
@@ -56,7 +57,7 @@ public function __construct(
 	 * Add reaction
 	 *
 	 * @param Room $chat
-	 * @param string $actorType
+	 * @psalm-param Attendee::ACTOR_* $actorType
 	 * @param string $actorId
 	 * @param integer $messageId
 	 * @param string $reaction
@@ -99,7 +100,7 @@ public function addReactionMessage(Room $chat, string $actorType, string $actorI
 	 * Delete reaction
 	 *
 	 * @param Room $chat
-	 * @param string $actorType
+	 * @psalm-param Attendee::ACTOR_* $actorType
 	 * @param string $actorId
 	 * @param integer $messageId
 	 * @param string $reaction
@@ -159,8 +160,10 @@ public function retrieveReactionMessages(Room $chat, Participant $participant, i
 			$message = $this->messageParser->createMessage($chat, $participant, $comment, $this->l);
 			$this->messageParser->parseMessage($message);
 
+			/** @var Attendee::ACTOR_* $actorType */
+			$actorType = $comment->getActorType();
 			$reactions[$comment->getMessage()][] = [
-				'actorType' => $comment->getActorType(),
+				'actorType' => $actorType,
 				'actorId' => $comment->getActorId(),
 				'actorDisplayName' => $message->getActorDisplayName(),
 				'timestamp' => $comment->getCreationDateTime()->getTimestamp(),

diff --git a/lib/Listener/DisplayNameListener.php b/lib/Listener/DisplayNameListener.php
@@ -51,6 +51,9 @@ public function handle(Event $event): void {
 		}
 	}
 
+	/**
+	 * @psalm-param Attendee::ACTOR_* $actorType
+	 */
 	protected function updateCachedName(string $actorType, string $actorId, string $newName): void {
 		$this->participantService->updateDisplayNameForActor(
 			$actorType,

diff --git a/lib/Manager.php b/lib/Manager.php
@@ -318,7 +318,7 @@ public function getRoomsForUser(string $userId, array $sessionIds = [], bool $in
 	}
 
 	/**
-	 * @param string $actorType
+	 * @psalm-param Attendee::ACTOR_* $actorType
 	 * @param string $actorId
 	 * @param array $sessionIds A list of talk sessions to consider for loading (otherwise no session is loaded)
 	 * @param bool $includeLastMessage

diff --git a/lib/Model/Attachment.php b/lib/Model/Attachment.php
@@ -34,8 +34,6 @@
  * @method int getMessageTime()
  * @method void setObjectType(string $objectType)
  * @method string getObjectType()
- * @method void setActorType(string $actorType)
- * @method string getActorType()
  * @method void setActorId(string $actorId)
  * @method string getActorId()
  */
@@ -62,7 +60,10 @@ class Attachment extends Entity {
 	/** @var string */
 	protected $objectType;
 
-	/** @var string */
+	/**
+	 * @var string
+	 * @psalm-var Attendee::ACTOR_*
+	 */
 	protected $actorType;
 
 	/** @var string */
@@ -77,6 +78,20 @@ public function __construct() {
 		$this->addType('actorId', 'string');
 	}
 
+	/**
+	 * @psalm-param Attendee::ACTOR_* $actorType
+	 */
+	public function setActorType(string $actorType): void {
+		$this->actorType = $actorType;
+	}
+
+	/**
+	 * @psalm-return Attendee::ACTOR_*
+	 */
+	public function getActorType(): string {
+		return $this->actorType;
+	}
+
 	/**
 	 * @return array
 	 */

diff --git a/lib/Model/Attendee.php b/lib/Model/Attendee.php
@@ -28,8 +28,6 @@
 /**
  * @method void setRoomId(int $roomId)
  * @method int getRoomId()
- * @method void setActorType(string $actorType)
- * @method string getActorType()
  * @method void setActorId(string $actorId)
  * @method string getActorId()
  * @method void setDisplayName(string $displayName)
@@ -111,7 +109,10 @@ class Attendee extends Entity {
 	/** @var int */
 	protected $roomId;
 
-	/** @var string */
+	/**
+	 * @var string
+	 * @psalm-var Attendee::ACTOR_*
+	 */
 	protected $actorType;
 
 	/** @var string */
@@ -191,6 +192,20 @@ public function __construct() {
 		$this->addType('callId', 'string');
 	}
 
+	/**
+	 * @psalm-param Attendee::ACTOR_* $actorType
+	 */
+	public function setActorType(string $actorType): void {
+		$this->actorType = $actorType;
+	}
+
+	/**
+	 * @psalm-return Attendee::ACTOR_*
+	 */
+	public function getActorType(): string {
+		return $this->actorType;
+	}
+
 	public function getDisplayName(): string {
 		return (string) $this->displayName;
 	}

diff --git a/lib/Model/AttendeeMapper.php b/lib/Model/AttendeeMapper.php
@@ -46,7 +46,7 @@ public function __construct(IDBConnection $db) {
 
 	/**
 	 * @param int $roomId
-	 * @param string $actorType
+	 * @psalm-param Attendee::ACTOR_* $actorType
 	 * @param string $actorId
 	 * @return Attendee
 	 * @throws DoesNotExistException

diff --git a/lib/Model/Consent.php b/lib/Model/Consent.php
@@ -30,16 +30,17 @@
 /**
  * @method void setToken(string $token)
  * @method string getToken()
- * @method void setActorType(string $actorType)
- * @method string getActorType()
  * @method void setActorId(string $actorId)
  * @method string getActorId()
  * @method void setDateTime(\DateTime $dateTime)
  * @method \DateTime getDateTime()
  */
 class Consent extends Entity implements \JsonSerializable {
 	protected string $token = '';
-	protected string $actorType = '';
+	/**
+	 * @psalm-var Attendee::ACTOR_*
+	 */
+	protected string $actorType;
 	protected string $actorId = '';
 	protected ?\DateTime $dateTime = null;
 
@@ -50,6 +51,20 @@ public function __construct() {
 		$this->addType('dateTime', 'datetime');
 	}
 
+	/**
+	 * @psalm-param Attendee::ACTOR_* $actorType
+	 */
+	public function setActorType(string $actorType): void {
+		$this->actorType = $actorType;
+	}
+
+	/**
+	 * @psalm-return Attendee::ACTOR_*
+	 */
+	public function getActorType(): string {
+		return $this->actorType;
+	}
+
 	public function jsonSerialize(): array {
 		return [
 			'token' => $this->getToken(),

diff --git a/lib/Model/ConsentMapper.php b/lib/Model/ConsentMapper.php
@@ -63,6 +63,7 @@ public function deleteByToken(string $token): int {
 	}
 
 	/**
+	 * @psalm-param Attendee::ACTOR_* $actorType
 	 * @return Consent[]
 	 */
 	public function findForActor(string $actorType, string $actorId): array {
@@ -75,6 +76,9 @@ public function findForActor(string $actorType, string $actorId): array {
 		return $this->findEntities($query);
 	}
 
+	/**
+	 * @psalm-param Attendee::ACTOR_* $actorType
+	 */
 	public function deleteByActor(string $actorType, string $actorId): int {
 		$query = $this->db->getQueryBuilder();
 		$query->delete($this->getTableName())
@@ -85,6 +89,7 @@ public function deleteByActor(string $actorType, string $actorId): int {
 	}
 
 	/**
+	 * @psalm-param Attendee::ACTOR_* $actorType
 	 * @return Consent[]
 	 */
 	public function findForTokenByActor(string $token, string $actorType, string $actorId): array {

diff --git a/lib/Model/Message.php b/lib/Model/Message.php
@@ -55,8 +55,11 @@ class Message {
 	/** @var array */
 	protected $parameters = [];
 
-	/** @var string */
-	protected $actorType = '';
+	/**
+	 * @var string
+	 * @psalm-var Attendee::ACTOR_*
+	 */
+	protected $actorType;
 
 	/** @var string */
 	protected $actorId = '';
@@ -148,6 +151,9 @@ public function getMessageType(): string {
 		return $this->type;
 	}
 
+	/**
+	 * @psalm-param Attendee::ACTOR_* $type
+	 */
 	public function setActor(string $type, string $id, string $displayName): void {
 		$this->actorType = $type;
 		$this->actorId = $id;
@@ -161,6 +167,9 @@ public function setLastEdit(string $type, string $id, string $displayName, int $
 		$this->lastEditTimestamp = $timestamp;
 	}
 
+	/**
+	 * @psalm-return Attendee::ACTOR_*
+	 */
 	public function getActorType(): string {
 		return $this->actorType;
 	}

diff --git a/lib/Model/Poll.php b/lib/Model/Poll.php
@@ -40,8 +40,6 @@
  * @method string getVotes()
  * @method void setNumVoters(int $numVoters)
  * @method int getNumVoters()
- * @method void setActorType(string $actorType)
- * @method string getActorType()
  * @method void setActorId(string $actorId)
  * @method string getActorId()
  * @method void setDisplayName(string $displayName)
@@ -67,7 +65,10 @@ class Poll extends Entity {
 	protected string $options = '';
 	protected string $votes = '';
 	protected int $numVoters = 0;
-	protected string $actorType = '';
+	/**
+	 * @psalm-var Attendee::ACTOR_*
+	 */
+	protected string $actorType;
 	protected string $actorId = '';
 	protected ?string $displayName = null;
 	protected int $status = self::STATUS_OPEN;
@@ -88,6 +89,20 @@ public function __construct() {
 		$this->addType('maxVotes', 'int');
 	}
 
+	/**
+	 * @psalm-param Attendee::ACTOR_* $actorType
+	 */
+	public function setActorType(string $actorType): void {
+		$this->actorType = $actorType;
+	}
+
+	/**
+	 * @psalm-return Attendee::ACTOR_*
+	 */
+	public function getActorType(): string {
+		return $this->actorType;
+	}
+
 	/**
 	 * @return TalkPoll
 	 */

diff --git a/lib/Model/ProxyCacheMessages.php b/lib/Model/ProxyCacheMessages.php
@@ -39,8 +39,6 @@
  * @method string getRemoteToken()
  * @method void setRemoteMessageId(int $remoteMessageId)
  * @method int getRemoteMessageId()
- * @method void setActorType(string $actorType)
- * @method string getActorType()
  * @method void setActorId(string $actorId)
  * @method string getActorId()
  * @method void setActorDisplayName(string $actorDisplayName)
@@ -62,7 +60,10 @@ class ProxyCacheMessages extends Entity implements \JsonSerializable {
 	protected string $remoteServerUrl = '';
 	protected string $remoteToken = '';
 	protected int $remoteMessageId = 0;
-	protected string $actorType = '';
+	/**
+	 * @psalm-var Attendee::ACTOR_*
+	 */
+	protected string $actorType;
 	protected string $actorId = '';
 	protected ?string $actorDisplayName = null;
 	/**
@@ -104,6 +105,20 @@ public function getMessageType(): string {
 		return $this->messageType;
 	}
 
+	/**
+	 * @psalm-param Attendee::ACTOR_* $actorType
+	 */
+	public function setActorType(string $actorType): void {
+		$this->actorType = $actorType;
+	}
+
+	/**
+	 * @psalm-return Attendee::ACTOR_*
+	 */
+	public function getActorType(): string {
+		return $this->actorType;
+	}
+
 	/**
 	 * @return TalkRoomProxyMessage
 	 */