Issues-577: Watching feature for public forums

Author: atelomycterus

config/vanilla/bootstrap.before.php

@@ -375,7 +375,7 @@ function watchIcon($hasWatched = false, $title='') {
      * @param int $categoryID
      * @return string
      */
-    function watchButton($category) {
+    function watchButton($category, $isHijackButton = true) {
         $output = ' ';
         $userID = Gdn::session()->UserID;
         if(is_numeric($category)) {
@@ -390,10 +390,15 @@ function watchButton($category) {
 
             $text = $hasWatched ? t('Stop watching the category') : t('Watch the category');
             $icon = watchIcon($hasWatched, $text);
+            $cssClasses =  'watchButton' . ($hasWatched ? ' isWatching': '');
+            if($isHijackButton) {
+                $cssClasses = 'Hijack '.$cssClasses;
+            }
+
             $output .= anchor(
                 $icon,
                 $hasWatched ? "/category/watched/{$categoryID}/" . Gdn::session()->transientKey() : "/category/watch/{$categoryID}/" . Gdn::session()->transientKey(),
-                'Hijack watchButton' . ($hasWatched ? ' isWatching' : ''),
+                $cssClasses,
                 ['title' => $text, 'aria-pressed' => $hasWatched ? 'true' : 'false', 'role' => 'button', 'tabindex' => '0']
             );
         }

vanilla/applications/vanilla/controllers/class.discussioncontroller.php

@@ -476,9 +476,9 @@ public function dismissAnnouncement($discussionID = '') {
      *
      * @param int $DiscussionID Unique discussion ID.
      */
-    public function bookmark($DiscussionID = null) {
+    public function bookmark($DiscussionID = null, $bookmarked=null, $tkey=null ) {
         // Make sure we are posting back.
-        if (!$this->Request->isAuthenticatedPostBack()) {
+        if (!$this->Request->isAuthenticatedPostBack() && !Gdn::session()->validateTransientKey($tkey)) {
             throw permissionException('Javascript');
         }
 
@@ -491,7 +491,11 @@ public function bookmark($DiscussionID = null) {
         // Check the form to see if the data was posted.
         $Form = new Gdn_Form();
         $DiscussionID = $Form->getFormValue('DiscussionID', $DiscussionID);
-        $Bookmark = $Form->getFormValue('Bookmark', null);
+        // FIX:  https://github.com/topcoder-platform/forums/issues/577
+        // 0 - not bookmarked
+        // 1 - bookmarked
+        // 2 - unbookmarked, if Discussion's Author
+        $Bookmark = $Form->getFormValue('Bookmark', $bookmarked);
         $UserID = $Form->getFormValue('UserID', $Session->UserID);
 
         // Check the permission on the user.
@@ -511,10 +515,11 @@ public function bookmark($DiscussionID = null) {
         $Bookmark = $this->DiscussionModel->bookmark($DiscussionID, $UserID, $Bookmark);
 
         // Set the new value for api calls and json targets.
+        // FIX: https://github.com/topcoder-platform/forums/issues/577
         $this->setData([
             'UserID' => $UserID,
             'DiscussionID' => $DiscussionID,
-            'Bookmarked' => (bool)$Bookmark
+            'Bookmarked' => (int)$Bookmark
         ]);
         setValue('Bookmarked', $Discussion, (int)$Bookmark);
 

vanilla/applications/vanilla/models/class.commentmodel.php

@@ -1397,6 +1397,7 @@ public function recordAdvancedNotications($activityModel, $activity, $discussion
         }
 
         $categoryID = val('CategoryID', $discussion);
+        $discussionID = val('DiscussionID', $discussion);
 
         // Figure out the category that governs this notification preference.
         $category = CategoryModel::categories($categoryID);
@@ -1414,6 +1415,13 @@ public function recordAdvancedNotications($activityModel, $activity, $discussion
             $parentCategory = CategoryModel::categories($parentCategory["ParentCategoryID"]);
         }
 
+        $discussionModel = new DiscussionModel();
+        // FIX: https://github.com/topcoder-platform/forums/issues/577
+        $removeUserIDs = array_column(
+            $discussionModel->getUnBookmarkUsers($discussionID)->resultArray(),
+            "UserID"
+        );
+
         // Grab all of the users that need to be notified.
         $data = $this->SQL
             ->whereIn('Name', ['Preferences.Email.NewComment.'.$category['CategoryID'], 'Preferences.Popup.NewComment.'.$category['CategoryID']])
@@ -1426,8 +1434,12 @@ public function recordAdvancedNotications($activityModel, $activity, $discussion
             }
 
             $userID = $row['UserID'];
+
+            if (in_array($userID, $removeUserIDs)) {
+                continue;
+            }
+
             // Check user can still see the discussion.
-            $discussionModel = new DiscussionModel();
             if (!$discussionModel->canView($discussion, $userID)) {
                 continue;
             }

vanilla/applications/vanilla/models/class.discussionmodel.php

@@ -1339,6 +1339,20 @@ public function getBookmarkUsers($discussionID) {
             ->where('Bookmarked', '1')
             ->get();
     }
+    /**
+     * Gets all users who have unbookmarked the specified discussion.
+     *
+     */
+    // FIX: https://github.com/topcoder-platform/forums/issues/577
+    public function getUnBookmarkUsers($discussionID) {
+        return $this->SQL
+            ->select('UserID')
+            ->from('UserDiscussion')
+            ->where('DiscussionID', $discussionID)
+            ->whereIn('Bookmarked', [0, 2])
+            ->get();
+    }
+
 
     /**
      *
@@ -2872,8 +2886,8 @@ public function bookmark($discussionID, $userID, $bookmarked = null) {
         $this->EventArguments['UserID'] = $userID;
         $this->EventArguments['Bookmarked'] = $bookmarked;
         $this->fireEvent('AfterBookmark');
-
-        return (bool)$bookmarked;
+        // FIX: https://github.com/topcoder-platform/forums/issues/577
+        return (int)$bookmarked;
     }
 
     /**

vanilla/applications/vanilla/views/discussion/index.php

@@ -3,6 +3,9 @@
 if (!function_exists('WriteComment'))
     include $this->fetchViewLocation('helper_functions', 'discussion');
 
+if (!function_exists('bookmarkButton'))
+    include $this->fetchViewLocation('helper_functions', 'discussions');
+
 // Wrap the discussion related content in a div.
 echo '<div class="MessageList Discussion">';
 
@@ -13,7 +16,8 @@
 echo '<div class="Options">';
 
 $this->fireEvent('BeforeDiscussionOptions');
-writeBookmarkLink();
+//writeBookmarkLink();
+echo bookmarkButton($this->data('Discussion'));
 echo getDiscussionOptionsDropdown();
 writeAdminCheck();
 

vanilla/applications/vanilla/views/discussions/helper_functions.php

@@ -71,15 +71,59 @@ function bookmarkButton($discussion) {
         }
 
         // Bookmark link
-        $hasWatched = $discussion->Bookmarked == '1';
-        $title = t($hasWatched ? 'Stop watching the discussion' : 'Watch the discussion');
-        $icon = watchIcon($hasWatched, $title);
-        return anchor(
-            $icon,
-            '/discussion/bookmark/'.$discussion->DiscussionID.'/'.Gdn::session()->transientKey(),
-            'Hijack  watchButton '.($hasWatched ? ' isWatching' : ''),
-            ['title' => $title]
-        );
+        // FIX : https://github.com/topcoder-platform/forums/issues/577
+        // If User is watching a category then show it as bookmarked
+        $categoryModel = new CategoryModel();
+        $category = CategoryModel::categories($discussion->CategoryID);
+        $groupID = val('GroupID', $category);
+        // No changes for Challenge Forums
+        if($groupID && $groupID > 0) {
+            // New value should be opposite
+            $hasWatched = $discussion->Bookmarked == 1;
+            $newValue = $hasWatched ? 0 : 1;
+            $title = t($hasWatched ? 'Stop watching the discussion' : 'Watch the discussion');
+            $icon = watchIcon($hasWatched, $title);
+            return anchor(
+                $icon,
+                '/discussion/bookmark/' . $discussion->DiscussionID . '/?tkey=' . Gdn::session()->transientKey() . '&bookmarked=' . $newValue,
+                'Hijack  watchButton ' . ($hasWatched ? ' isWatching' : ''),
+                ['title' => $title]
+            );
+        } else {
+            $hasWatchedCategory = $categoryModel->hasWatched($discussion->CategoryID, Gdn::session()->UserID);
+            $hasWatched = false;
+
+            // Author is added by default with Bookmarked = 0, Participated = 1
+            $isAuthor = ($discussion->InsertUserID == Gdn::session()->UserID);
+
+            // If Watched Category: unwatched discussion
+            if ($discussion->Bookmarked === null) {
+                $hasWatched = $hasWatchedCategory;
+                $newValue = $hasWatched === true ? 0 : 1;
+            } else if ($discussion->Bookmarked == 0) {
+                $hasWatched = false;
+                if ($isAuthor) {
+                    $hasWatched = $hasWatchedCategory;
+                    $newValue = 2;
+                } else {
+                    $newValue = 1;
+                }
+            } else if ($discussion->Bookmarked == 1) {
+                $hasWatched = true;
+                $newValue = $isAuthor? 2 : 0;
+            } else if ($discussion->Bookmarked == 2) {
+                $hasWatched = false;
+                $newValue = 1;
+            }
+            $title = t($hasWatched ? 'Stop watching the discussion' : 'Watch the discussion');
+            $icon = watchIcon($hasWatched, $title);
+            return anchor(
+                $icon,
+                '/discussion/bookmark/' . $discussion->DiscussionID . '/?tkey=' . Gdn::session()->transientKey() . '&bookmarked=' . $newValue,
+                'Hijack  watchButton ' . ($hasWatched ? ' isWatching' : ''),
+                ['title' => $title]
+            );
+        }
     }
 }
 

vanilla/applications/vanilla/views/discussions/index.php

@@ -3,11 +3,13 @@
 include_once $this->fetchViewLocation('helper_functions', 'discussions', 'vanilla');
 include_once $this->fetchViewLocation('helper_functions', 'categories', 'vanilla');
 
-echo '<h1 class="H HomepageTitle">'.
-    adminCheck(NULL, ['', ' ']).
-    $this->data('Title').
-    followButton($this->data('Category.CategoryID')).'</h1>';
-    //watchButton($this->data('Category.CategoryID')).
+// FIX: https://github.com/topcoder-platform/forums/issues/577
+$title = adminCheck(NULL, ['', ' ']).$this->data('Title');
+if(!$this->data('Category.GroupID')) {
+    $title .= watchButton($this->data('Category.CategoryID'), false);
+}
+//followButton($this->data('Category.CategoryID'))
+echo '<h1 class="H HomepageTitle">'.$title.'</h1>';
 
 
 $Description = $this->data('Category.Description', $this->description());