From c681b353f23522c71fdea1eb2f968d0d84fde9fc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9gis=20Hanol?= <regis@hanol.fr>
Date: Mon, 12 Jan 2015 12:10:15 +0100
Subject: [PATCH] FEATURE: bookmark topic button

---
 .../discourse/controllers/topic.js.es6        | 13 ++++---
 .../discourse/lib/keyboard_shortcuts.js       | 14 +++----
 .../javascripts/discourse/models/_post.js     | 37 +++++++++++--------
 .../javascripts/discourse/models/topic.js     | 15 +++++---
 .../modal/keyboard_shortcuts_help.hbs         |  2 +-
 .../discourse/views/bookmark-button.js.es6    | 19 ++++++++++
 .../views/topic-footer-buttons.js.es6         |  2 +
 app/controllers/posts_controller.rb           | 12 +++---
 app/controllers/topics_controller.rb          | 16 +++++++-
 app/models/post_action_type.rb                | 10 ++++-
 app/models/topic_user.rb                      |  1 -
 app/serializers/topic_view_serializer.rb      |  7 +++-
 config/locales/client.en.yml                  |  2 +-
 config/routes.rb                              |  1 +
 14 files changed, 103 insertions(+), 48 deletions(-)
 create mode 100644 app/assets/javascripts/discourse/views/bookmark-button.js.es6

diff --git a/app/assets/javascripts/discourse/controllers/topic.js.es6 b/app/assets/javascripts/discourse/controllers/topic.js.es6
index 672ea3313..0bb6ed3e0 100644
--- a/app/assets/javascripts/discourse/controllers/topic.js.es6
+++ b/app/assets/javascripts/discourse/controllers/topic.js.es6
@@ -213,8 +213,11 @@ export default ObjectController.extend(Discourse.SelectedPostsCount, BufferedCon
         alert(I18n.t("bookmarks.not_bookmarked"));
         return;
       }
-      post.toggleProperty('bookmarked');
-      return false;
+      if (post) {
+        return post.toggleBookmark();
+      } else {
+        return this.get("model").toggleBookmark();
+      }
     },
 
     jumpTop: function() {
@@ -547,15 +550,13 @@ export default ObjectController.extend(Discourse.SelectedPostsCount, BufferedCon
 
   // Receive notifications for this topic
   subscribe: function() {
-
     // Unsubscribe before subscribing again
     this.unsubscribe();
 
-    var bus = Discourse.MessageBus;
-
     var topicController = this;
-    bus.subscribe("/topic/" + (this.get('id')), function(data) {
+    Discourse.MessageBus.subscribe("/topic/" + this.get('id'), function(data) {
       var topic = topicController.get('model');
+
       if (data.notification_level_change) {
         topic.set('details.notification_level', data.notification_level_change);
         topic.set('details.notifications_reason_id', data.notifications_reason_id);
diff --git a/app/assets/javascripts/discourse/lib/keyboard_shortcuts.js b/app/assets/javascripts/discourse/lib/keyboard_shortcuts.js
index d7c6d0c14..f96e7fd33 100644
--- a/app/assets/javascripts/discourse/lib/keyboard_shortcuts.js
+++ b/app/assets/javascripts/discourse/lib/keyboard_shortcuts.js
@@ -18,15 +18,13 @@ var PATH_BINDINGS = {
     },
 
     CLICK_BINDINGS = {
-      // star topic
-      'f': '#topic-footer-buttons button.star, .topic-list tr.topic-list-item.selected a.star',
-
+      'f': '#topic-footer-buttons button.bookmark',                             // bookmark topic
       'm m': 'div.notification-options li[data-id="0"] a',                      // mark topic as muted
       'm r': 'div.notification-options li[data-id="1"] a',                      // mark topic as regular
       'm t': 'div.notification-options li[data-id="2"] a',                      // mark topic as tracking
       'm w': 'div.notification-options li[data-id="3"] a',                      // mark topic as watching
       'x r': '#dismiss-new,#dismiss-new-top,#dismiss-posts,#dismiss-posts-top', // dismiss new/posts
-      'x t': '#dismiss-topics,#dismiss-topics-top',                             //dismiss topics
+      'x t': '#dismiss-topics,#dismiss-topics-top',                             // dismiss topics
       '.': '.alert.alert-info.clickable',                                       // show incoming/updated topics
       'n': '#user-notifications',                                               // open notifications menu
       'o,enter': '.topic-list tr.selected a.title',                             // open selected topic
@@ -36,7 +34,7 @@ var PATH_BINDINGS = {
     },
 
     FUNCTION_BINDINGS = {
-      'c': 'createTopic',                                         // create new topic
+      'c': 'createTopic',                                                       // create new topic
       'home': 'goToFirstPost',
       '#': 'toggleProgress',
       'end': 'goToLastPost',
@@ -47,11 +45,11 @@ var PATH_BINDINGS = {
       'k': 'selectUp',
       'u': 'goBack',
       '/': 'showSearch',
-      '=': 'showSiteMap',                                             // open site map menu
-      'p': 'showCurrentUser',                                         // open current user menu
+      '=': 'showSiteMap',                                                       // open site map menu
+      'p': 'showCurrentUser',                                                   // open current user menu
       'ctrl+f': 'showBuiltinSearch',
       'command+f': 'showBuiltinSearch',
-      '?': 'showHelpModal',                                          // open keyboard shortcut help
+      '?': 'showHelpModal',                                                     // open keyboard shortcut help
       'q': 'quoteReply'
     };
 
diff --git a/app/assets/javascripts/discourse/models/_post.js b/app/assets/javascripts/discourse/models/_post.js
index 686e8230f..9df35ab8d 100644
--- a/app/assets/javascripts/discourse/models/_post.js
+++ b/app/assets/javascripts/discourse/models/_post.js
@@ -68,17 +68,6 @@ Discourse.Post = Discourse.Model.extend({
     return this.get("user_id") === Discourse.User.currentProp("id") || Discourse.User.currentProp('staff');
   }.property("user_id"),
 
-  bookmarkedChanged: function() {
-    Discourse.Post.bookmark(this.get('id'), this.get('bookmarked'))
-             .then(null, function (error) {
-               if (error && error.responseText) {
-                 bootbox.alert($.parseJSON(error.responseText).errors[0]);
-               } else {
-                 bootbox.alert(I18n.t('generic_error'));
-               }
-             });
-  }.observes('bookmarked'),
-
   wikiChanged: function() {
     var data = { wiki: this.get("wiki") };
     this._updatePost("wiki", data);
@@ -421,6 +410,28 @@ Discourse.Post = Discourse.Model.extend({
 
   unhide: function () {
     return Discourse.ajax("/posts/" + this.get("id") + "/unhide", { type: "PUT" });
+  },
+
+  toggleBookmark: function() {
+    var self = this;
+
+    this.toggleProperty("bookmarked");
+    if (this.get("post_number") === 1) { this.toggleProperty("topic.bookmarked"); }
+
+    return Discourse.ajax("/posts/" + this.get("id") + "/bookmark", {
+      type: 'PUT',
+      data: { bookmarked: this.get("bookmarked") }
+    }).then(null, function (error) {
+
+      self.toggleProperty("bookmarked");
+      if (this.get("post_number") === 1) { this.toggleProperty("topic.bookmarked"); }
+
+      if (error && error.responseText) {
+        bootbox.alert($.parseJSON(error.responseText).errors[0]);
+      } else {
+        bootbox.alert(I18n.t('generic_error'));
+      }
+    });
   }
 });
 
@@ -491,10 +502,6 @@ Discourse.Post.reopenClass({
     return Discourse.ajax("/posts/" + postId + ".json").then(function (result) {
       return Discourse.Post.create(result);
     });
-  },
-
-  bookmark: function(postId, bookmarked) {
-    return Discourse.ajax("/posts/" + postId + "/bookmark", { type: 'PUT', data: { bookmarked: bookmarked } });
   }
 
 });
diff --git a/app/assets/javascripts/discourse/models/topic.js b/app/assets/javascripts/discourse/models/topic.js
index f4b13f818..dc20e4430 100644
--- a/app/assets/javascripts/discourse/models/topic.js
+++ b/app/assets/javascripts/discourse/models/topic.js
@@ -181,14 +181,17 @@ Discourse.Topic = Discourse.Model.extend({
   }.property('word_count'),
 
   toggleBookmark: function() {
-    var topic = this;
-    topic.toggleProperty('bookmarked');
-    return Discourse.ajax({
-      url: "" + (this.get('url')) + "/bookmark",
+    var self = this, firstPost = this.get("postStream.posts")[0];
+
+    this.toggleProperty('bookmarked');
+    if (this.get("postStream.firstPostPresent")) { firstPost.toggleProperty("bookmarked"); }
+
+    return Discourse.ajax('/t/' + this.get('id') + '/bookmark', {
       type: 'PUT',
-      data: { bookmarked: topic.get('bookmarked') ? true : false }
+      data: { bookmarked: self.get('bookmarked') }
     }).then(null, function (error) {
-      topic.toggleProperty('bookmarked');
+      self.toggleProperty('bookmarked');
+      if (self.get("postStream.firstPostPresent")) { firstPost.toggleProperty('bookmarked'); }
 
       if (error && error.responseText) {
         bootbox.alert($.parseJSON(error.responseText).errors);
diff --git a/app/assets/javascripts/discourse/templates/modal/keyboard_shortcuts_help.hbs b/app/assets/javascripts/discourse/templates/modal/keyboard_shortcuts_help.hbs
index c13311cea..2b6ec44f5 100644
--- a/app/assets/javascripts/discourse/templates/modal/keyboard_shortcuts_help.hbs
+++ b/app/assets/javascripts/discourse/templates/modal/keyboard_shortcuts_help.hbs
@@ -36,7 +36,7 @@
     <div class="span6">
       <h4>{{i18n 'keyboard_shortcuts_help.actions.title'}}</h4>
       <ul>
-        <li>{{{i18n 'keyboard_shortcuts_help.actions.star'}}}</li>
+        <li>{{{i18n 'keyboard_shortcuts_help.actions.bookmark_topic'}}}</li>
         <li>{{{i18n 'keyboard_shortcuts_help.actions.pin_unpin_topic'}}}</li>
         <li>{{{i18n 'keyboard_shortcuts_help.actions.share_topic'}}}</li>
         <li>{{{i18n 'keyboard_shortcuts_help.actions.share_post'}}}</li>
diff --git a/app/assets/javascripts/discourse/views/bookmark-button.js.es6 b/app/assets/javascripts/discourse/views/bookmark-button.js.es6
new file mode 100644
index 000000000..c6a98c6e8
--- /dev/null
+++ b/app/assets/javascripts/discourse/views/bookmark-button.js.es6
@@ -0,0 +1,19 @@
+import ButtonView from 'discourse/views/button';
+
+export default ButtonView.extend({
+  classNames: ['bookmark'],
+  textKey: 'bookmarked.title',
+  helpKeyBinding: 'controller.bookmarkTooltipKey',
+  attributeBindings: ['disabled'],
+
+  rerenderTriggers: ['controller.bookmarked'],
+
+  click: function() {
+    this.get('controller').send('toggleBookmark');
+  },
+
+  renderIcon: function(buffer) {
+    var className = this.get("controller.bookmarked") ? "fa-bookmark" : "fa-bookmark-o";
+    buffer.push("<i class='fa " + className + "'></i>");
+  }
+});
diff --git a/app/assets/javascripts/discourse/views/topic-footer-buttons.js.es6 b/app/assets/javascripts/discourse/views/topic-footer-buttons.js.es6
index 918845ca6..f013611dc 100644
--- a/app/assets/javascripts/discourse/views/topic-footer-buttons.js.es6
+++ b/app/assets/javascripts/discourse/views/topic-footer-buttons.js.es6
@@ -1,6 +1,7 @@
 import TopicAdminMenuButton from 'discourse/views/topic-admin-menu-button';
 import LoginReplyButton from 'discourse/views/login-reply-button';
 import FlagTopicButton from 'discourse/views/flag-topic-button';
+import BookmarkButton from 'discourse/views/bookmark-button';
 import ShareButton from 'discourse/views/share-button';
 import InviteReplyButton from 'discourse/views/invite-reply-button';
 import ReplyButton from 'discourse/views/reply-button';
@@ -29,6 +30,7 @@ export default DiscourseContainerView.extend({
         if (this.get('topic.details.can_invite_to')) {
           this.attachViewClass(InviteReplyButton);
         }
+        this.attachViewClass(BookmarkButton);
         this.attachViewClass(ShareButton);
         if (this.get('topic.details.can_flag_topic')) {
           this.attachViewClass(FlagTopicButton);
diff --git a/app/controllers/posts_controller.rb b/app/controllers/posts_controller.rb
index 84e1cd20d..2d0b936d0 100644
--- a/app/controllers/posts_controller.rb
+++ b/app/controllers/posts_controller.rb
@@ -248,13 +248,13 @@ class PostsController < ApplicationController
 
   def bookmark
     post = find_post_from_params
-    if current_user
-      if params[:bookmarked] == "true"
-        PostAction.act(current_user, post, PostActionType.types[:bookmark])
-      else
-        PostAction.remove_act(current_user, post, PostActionType.types[:bookmark])
-      end
+
+    if params[:bookmarked] == "true"
+      PostAction.act(current_user, post, PostActionType.types[:bookmark])
+    else
+      PostAction.remove_act(current_user, post, PostActionType.types[:bookmark])
     end
+
     render nothing: true
   end
 
diff --git a/app/controllers/topics_controller.rb b/app/controllers/topics_controller.rb
index 9b7f71cfa..6ca90f6a2 100644
--- a/app/controllers/topics_controller.rb
+++ b/app/controllers/topics_controller.rb
@@ -25,7 +25,8 @@ class TopicsController < ApplicationController
                                           :autoclose,
                                           :bulk,
                                           :reset_new,
-                                          :change_post_owners]
+                                          :change_post_owners,
+                                          :bookmark]
 
   before_filter :consider_user_for_promotion, only: :show
 
@@ -212,6 +213,19 @@ class TopicsController < ApplicationController
     render nothing: true
   end
 
+  def bookmark
+    topic = Topic.find_by(id: params[:topic_id])
+    first_post = topic.ordered_posts.first
+
+    if params[:bookmarked] == "true"
+      PostAction.act(current_user, first_post, PostActionType.types[:bookmark])
+    else
+      PostAction.remove_act(current_user, first_post, PostActionType.types[:bookmark])
+    end
+
+    render nothing: true
+  end
+
   def destroy
     topic = Topic.find_by(id: params[:id])
     guardian.ensure_can_delete!(topic)
diff --git a/app/models/post_action_type.rb b/app/models/post_action_type.rb
index 4f2f8699c..847c03a64 100644
--- a/app/models/post_action_type.rb
+++ b/app/models/post_action_type.rb
@@ -7,8 +7,14 @@ class PostActionType < ActiveRecord::Base
     end
 
     def types
-      @types ||= Enum.new(:bookmark, :like, :off_topic, :inappropriate, :vote,
-                          :notify_user, :notify_moderators, :spam)
+      @types ||= Enum.new(:bookmark,
+                          :like,
+                          :off_topic,
+                          :inappropriate,
+                          :vote,
+                          :notify_user,
+                          :notify_moderators,
+                          :spam)
     end
 
     def auto_action_flag_types
diff --git a/app/models/topic_user.rb b/app/models/topic_user.rb
index a0768e1c1..9ca519085 100644
--- a/app/models/topic_user.rb
+++ b/app/models/topic_user.rb
@@ -280,7 +280,6 @@ SQL
   end
 
   def self.ensure_consistency!(topic_id=nil)
-
     update_post_action_cache
 
     # TODO this needs some reworking, when we mark stuff skipped
diff --git a/app/serializers/topic_view_serializer.rb b/app/serializers/topic_view_serializer.rb
index c48c2c1d3..d0fc7f281 100644
--- a/app/serializers/topic_view_serializer.rb
+++ b/app/serializers/topic_view_serializer.rb
@@ -42,7 +42,8 @@ class TopicViewSerializer < ApplicationSerializer
              :actions_summary,
              :expandable_first_post,
              :is_warning,
-             :chunk_size
+             :chunk_size,
+             :bookmarked
 
   # Define a delegator for each attribute of the topic we want
   attributes(*topic_attributes)
@@ -203,4 +204,8 @@ class TopicViewSerializer < ApplicationSerializer
     object.topic.expandable_first_post?
   end
 
+  def bookmarked
+    object.topic_user.try(:bookmarked)
+  end
+
 end
diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml
index a224ce22a..45ff9c38d 100644
--- a/config/locales/client.en.yml
+++ b/config/locales/client.en.yml
@@ -2229,7 +2229,7 @@ en:
         dismiss_topics: '<b>x</b>, <b>t</b> Dismiss Topics'
       actions:
         title: 'Actions'
-        star: '<b>f</b> Star topic'
+        bookmark_topic: '<b>f</b> Bookmark topic'
         pin_unpin_topic: '<b>shift</b>+<b>p</b> Pin/Unpin topic'
         share_topic: '<b>shift</b>+<b>s</b> Share topic'
         share_post: '<b>s</b> Share post'
diff --git a/config/routes.rb b/config/routes.rb
index a9a71db67..d7453e878 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -414,6 +414,7 @@ Discourse::Application.routes.draw do
   post "t/:topic_id/merge-topic" => "topics#merge_topic", constraints: {topic_id: /\d+/}
   post "t/:topic_id/change-owner" => "topics#change_post_owners", constraints: {topic_id: /\d+/}
   delete "t/:topic_id/timings" => "topics#destroy_timings", constraints: {topic_id: /\d+/}
+  put "t/:topic_id/bookmark" => "topics#bookmark", constraints: {topic_id: /\d+/}
 
   post "t/:topic_id/notifications" => "topics#set_notifications" , constraints: {topic_id: /\d+/}