# frozen_string_literal: true class BookmarkManager include HasErrors def initialize(user) @user = user end ## # Creates a bookmark for a post where both the post and the topic are # not deleted. Only allows creation of bookmarks for posts the user # can access via Guardian. # # Any ActiveModel validation errors raised by the Bookmark model are # hoisted to the instance of this class for further reporting. # # Also handles setting the associated TopicUser.bookmarked value for # the post's topic for the user that is creating the bookmark. # # @param post_id A post ID for a post that is not deleted. # @param name A short note for the bookmark, shown on the user bookmark list # and on hover of reminder notifications. # @param reminder_at The datetime when a bookmark reminder should be sent after. # Note this is not the exact time a reminder will be sent, as # we send reminders on a rolling schedule. # See Jobs::BookmarkReminderNotifications # @param for_topic Whether we are creating a topic-level bookmark which # has different behaviour in the UI. Only bookmarks for # posts with post_number 1 can be marked as for_topic. # @params options Additional options when creating a bookmark # - auto_delete_preference: # See Bookmark.auto_delete_preferences, # this is used to determine when to delete a bookmark # automatically. # TODO (martin) (2021-12-01) Remove reminder_type keyword argument once plugins are not using it. def create( post_id:, name: nil, reminder_type: nil, reminder_at: nil, for_topic: false, options: {} ) post = Post.find_by(id: post_id) # no bookmarking deleted posts or topics raise Discourse::InvalidAccess if post.blank? || post.topic.blank? if !Guardian.new(@user).can_see_post?(post) || !Guardian.new(@user).can_see_topic?(post.topic) raise Discourse::InvalidAccess end bookmark = Bookmark.create( { user_id: @user.id, post: post, name: name, reminder_at: reminder_at, reminder_set_at: Time.zone.now, for_topic: for_topic }.merge(options) ) if bookmark.errors.any? return add_errors_from(bookmark) end update_topic_user_bookmarked(post.topic) bookmark end def destroy(bookmark_id) bookmark = find_bookmark_and_check_access(bookmark_id) bookmark.destroy bookmarks_remaining_in_topic = update_topic_user_bookmarked(bookmark.topic) { topic_bookmarked: bookmarks_remaining_in_topic } end def destroy_for_topic(topic, filter = {}, opts = {}) topic_bookmarks = Bookmark.for_user_in_topic(@user.id, topic.id) topic_bookmarks = topic_bookmarks.where(filter) Bookmark.transaction do topic_bookmarks.each do |bookmark| raise Discourse::InvalidAccess.new if !Guardian.new(@user).can_delete?(bookmark) bookmark.destroy end update_topic_user_bookmarked(topic, opts) end end def self.send_reminder_notification(id) bookmark = Bookmark.find_by(id: id) BookmarkReminderNotificationHandler.send_notification(bookmark) end # TODO (martin) (2021-12-01) Remove reminder_type keyword argument once plugins are not using it. def update(bookmark_id:, name:, reminder_at:, reminder_type: nil, options: {}) bookmark = find_bookmark_and_check_access(bookmark_id) success = bookmark.update( { name: name, reminder_at: reminder_at, reminder_set_at: Time.zone.now }.merge(options) ) if bookmark.errors.any? return add_errors_from(bookmark) end success end def toggle_pin(bookmark_id:) bookmark = find_bookmark_and_check_access(bookmark_id) bookmark.pinned = !bookmark.pinned success = bookmark.save if bookmark.errors.any? return add_errors_from(bookmark) end success end private def find_bookmark_and_check_access(bookmark_id) bookmark = Bookmark.find_by(id: bookmark_id) raise Discourse::NotFound if !bookmark raise Discourse::InvalidAccess.new if !Guardian.new(@user).can_edit?(bookmark) bookmark end def update_topic_user_bookmarked(topic, opts = {}) # PostCreator can specify whether auto_track is enabled or not, don't want to # create a TopicUser in that case bookmarks_remaining_in_topic = Bookmark.for_user_in_topic(@user.id, topic.id).exists? return bookmarks_remaining_in_topic if opts.key?(:auto_track) && !opts[:auto_track] TopicUser.change(@user.id, topic, bookmarked: bookmarks_remaining_in_topic) bookmarks_remaining_in_topic end end