New features: Unread & Pinned (#377)

* New features: Unread & Pinned * New feature: Pinned * Fix tests * Update pin icon * Fix select of next read message for redirect after mark as unread
humhub · Jan 29, 2024 · d39daa5 · d39daa5
1 parent 011407a
commit d39daa5
Show file tree

Hide file tree

Showing 15 changed files with 255 additions and 52 deletions.
diff --git a/controllers/MailController.php b/controllers/MailController.php
@@ -205,7 +205,7 @@ public function actionAddUser($id)
      */
     public function actionNotificationList()
     {
-        $query = UserMessage::findByUser(null, 'message.updated_at DESC')->limit(5);
+        $query = UserMessage::findByUser()->limit(5);
         return $this->renderAjax('notificationList', ['userMessages' => $query->all()]);
     }
 
@@ -341,6 +341,58 @@ public function actionCreate($userGuid = null, ?string $title = null, ?string $m
         ]);
     }
 
+    /**
+     * Mark a Conversation as unread
+     *
+     * @param int $id
+     */
+    public function actionMarkUnread($id)
+    {
+        $this->forcePostRequest();
+        $this->getMessage($id, true)->markUnread();
+
+        $nextReadMessage = $this->getNextReadMessage($id);
+
+        return $this->asJson([
+            'success' => true,
+            'redirect' => $nextReadMessage ? Url::toMessenger($nextReadMessage) : Url::to(['/dashboard'])
+        ]);
+    }
+
+    /**
+     * Pin a Conversation
+     *
+     * @param int $id
+     */
+    public function actionPin($id)
+    {
+        $this->forcePostRequest();
+        $message = $this->getMessage($id, true);
+        $message->pin();
+
+        return $this->asJson([
+            'success' => true,
+            'redirect' => Url::toMessenger($message)
+        ]);
+    }
+
+    /**
+     * Unpin a Conversation
+     *
+     * @param int $id
+     */
+    public function actionUnpin($id)
+    {
+        $this->forcePostRequest();
+        $message = $this->getMessage($id, true);
+        $message->unpin();
+
+        return $this->asJson([
+            'success' => true,
+            'redirect' => Url::toMessenger($message)
+        ]);
+    }
+
     /**
      * Leave Message / Conversation
      *
@@ -355,7 +407,7 @@ public function actionCreate($userGuid = null, ?string $title = null, ?string $m
     public function actionLeave($id)
     {
         $this->forcePostRequest();
-        $this->getMessage($id, true)->leave(Yii::$app->user->id);
+        $this->getMessage($id, true)->leave();
 
         return $this->asJson([
             'success' => true,
@@ -441,18 +493,15 @@ public function actionGetNewMessageCountJson()
      *
      * @param int $id
      * @param bool $throw
-     * @return Message
+     * @return Message|null
      * @throws HttpException
      */
-    private function getMessage($id, $throw = false)
+    private function getMessage($id, $throw = false): ?Message
     {
         $message = Message::findOne(['id' => $id]);
 
-        if ($message) {
-            $userMessage = $message->getUserMessage();
-            if ($userMessage != null) {
-                return $message;
-            }
+        if ($message && $message->getUserMessage() !== null) {
+            return $message;
         }
 
         if ($throw) {
@@ -461,4 +510,18 @@ private function getMessage($id, $throw = false)
 
         return null;
     }
+
+    private function getNextReadMessage($id): ?Message
+    {
+        return Message::find()
+            ->leftJoin('user_message', 'user_message.message_id = message.id')
+            ->where(['user_id' => Yii::$app->user->id])
+            ->andWhere(['!=', 'message_id', $id])
+            ->andWhere('user_message.last_viewed >= message.updated_at')
+            ->orderBy([
+                'user_message.pinned' => SORT_DESC,
+                'message.updated_at' => SORT_DESC
+            ])
+            ->one();
+    }
 }
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -4,6 +4,7 @@ Changelog
 Unreleased
 ------------------------
 - Fix #369: Misplaced Online dot
+- Enh #377: New features: Unread & Pinned
 
 3.1.2 (January 22, 2024)
 ------------------------

diff --git a/helpers/Url.php b/helpers/Url.php
@@ -70,9 +70,24 @@ public static function toConversationUserList(Message $message)
         return static::to(['/mail/mail/user-list', 'id' => $message->id]);
     }
 
+    public static function toMarkUnreadConversation(Message $message)
+    {
+        return static::to(['/mail/mail/mark-unread', 'id' => $message->id]);
+    }
+
+    public static function toPinConversation(Message $message)
+    {
+        return static::to(['/mail/mail/pin', 'id' => $message->id]);
+    }
+
+    public static function toUnpinConversation(Message $message)
+    {
+        return static::to(['/mail/mail/unpin', 'id' => $message->id]);
+    }
+
     public static function toLeaveConversation(Message $message)
     {
-        return static::to(["/mail/mail/leave", 'id' => $message->id]);
+        return static::to(['/mail/mail/leave', 'id' => $message->id]);
     }
 
     public static function toMessenger(Message $message = null, $scheme = false)
@@ -131,4 +146,4 @@ public static function toLoadMoreMessages()
     {
         return static::to(['/mail/mail/load-more']);
     }
-}
+}
diff --git a/migrations/m240125_080730_pinned.php b/migrations/m240125_080730_pinned.php
@@ -0,0 +1,26 @@
+<?php
+
+use humhub\components\Migration;
+use humhub\modules\mail\models\UserMessage;
+
+/**
+ * Class m240125_080730_pinned
+ */
+class m240125_080730_pinned extends Migration
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function safeUp()
+    {
+        $this->safeAddColumn(UserMessage::tableName(), 'pinned', $this->boolean()->defaultValue(false)->notNull());
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function safeDown()
+    {
+        $this->safeDropColumn(UserMessage::tableName(), 'pinned');
+    }
+}
diff --git a/models/Message.php b/models/Message.php
@@ -5,6 +5,7 @@
 
 use humhub\components\ActiveRecord;
 use humhub\modules\mail\Module;
+use humhub\modules\ui\icon\widgets\Icon;
 use humhub\modules\user\models\User;
 use Yii;
 use yii\helpers\Html;
@@ -105,12 +106,15 @@ public function getAuthor()
     }
 
     /**
-     * @param null $userId
+     * @param int|null $userId
      * @return UserMessage|null
      */
     public function getUserMessage($userId = null)
     {
         if (!$userId) {
+            if (Yii::$app->user->isGuest) {
+                return null;
+            }
             $userId = Yii::$app->user->id;
         }
 
@@ -233,23 +237,58 @@ public function deleteEntry($entry)
         }
     }
 
+    /**
+     * Mark this message as unread
+     *
+     * @param int|null $userId
+     */
+    public function markUnread($userId = null)
+    {
+        $userMessage = $this->getUserMessage($userId);
+        if ($userMessage) {
+            $userMessage->last_viewed = null;
+            $userMessage->save();
+        }
+    }
+
+    /**
+     * Pin this message
+     *
+     * @param int|null $userId
+     * @param bool $pin
+     */
+    public function pin($userId = null, bool $pin = true)
+    {
+        $userMessage = $this->getUserMessage($userId);
+        if ($userMessage) {
+            $userMessage->pinned = $pin;
+            $userMessage->save();
+        }
+    }
+
+    /**
+     * Unpin this message
+     *
+     * @param int|null $userId
+     */
+    public function unpin($userId = null)
+    {
+        $this->pin($userId, false);
+    }
+
     /**
      * User leaves a message
      *
      * If it's the last user, the whole message will be deleted.
      *
-     * @param int $userId
+     * @param int|null $userId
      * @throws \Throwable
      * @throws \yii\db\StaleObjectException
      */
-    public function leave($userId)
+    public function leave($userId = null)
     {
-        $userMessage = UserMessage::findOne([
-            'message_id' => $this->id,
-            'user_id' => $userId
-        ]);
-
-        if(!$userMessage) {
+        $userMessage = $this->getUserMessage($userId);
+        if (!$userMessage) {
             return;
         }
 
@@ -371,4 +410,21 @@ public function isBlocked(): bool
 
         return false;
     }
+
+    public function isPinned($userId = null): bool
+    {
+        $userMessage = $this->getUserMessage($userId);
+        return $userMessage && $userMessage->pinned;
+    }
+
+    public function getPinIcon($userId = null): ?Icon
+    {
+        if ($this->isPinned($userId)) {
+            return Icon::get('map-pin')
+                ->tooltip(Yii::t('MailModule.base', 'Pinned'))
+                ->color(Yii::$app->view->theme->variable('danger', 'red'));
+        }
+
+        return null;
+    }
 }
diff --git a/models/UserMessage.php b/models/UserMessage.php
@@ -22,6 +22,7 @@
  * @property integer $created_by
  * @property string $updated_at
  * @property integer $updated_by
+ * @property integer $pinned
  *
  * @property-read Message $message
  * @property-read User $user
@@ -113,19 +114,14 @@ public static function findByUser($userId = null)
 
         return static::find()->joinWith('message')
             ->where(['user_message.user_id' => $userId])
-            ->orderBy('message.updated_at DESC');
+            ->orderBy([
+                'user_message.pinned' => SORT_DESC,
+                'message.updated_at' => SORT_DESC
+            ]);
     }
 
-    public function isUnread($userId = null)
+    public function isUnread(): bool
     {
-        if ($userId === null) {
-            $userId = Yii::$app->user->id;
-        }
-
-        if($this->message->lastEntry && ($this->message->lastEntry->user_id === $userId)) {
-            return false;
-        }
-
         return $this->message->updated_at > $this->last_viewed;
     }
 

diff --git a/resources/css/humhub.mail.css b/resources/css/humhub.mail.css
@@ -228,7 +228,7 @@
 .mail-conversation-entry.hideUserInfo .author-label {
   display: none;
 }
-.mail-conversation-entry.hideUserInfo .author-image img {
+.mail-conversation-entry.hideUserInfo .author-image a {
   visibility: hidden;
   margin-top: 0;
 }