Class: CategoriesController

Inherits:
ApplicationController show all
Includes:
TopicQueryParams
Defined in:
app/controllers/categories_controller.rb

Constant Summary collapse

SYMMETRICAL_CATEGORIES_TO_TOPICS_FACTOR = 
1.5
MIN_CATEGORIES_TOPICS = 
5

Constants inherited from ApplicationController

ApplicationController::LEGACY_NO_THEMES, ApplicationController::LEGACY_NO_UNOFFICIAL_PLUGINS, ApplicationController::NO_PLUGINS, ApplicationController::NO_THEMES, ApplicationController::NO_UNOFFICIAL_PLUGINS, ApplicationController::SAFE_MODE

Constants included from CanonicalURL::ControllerExtensions

CanonicalURL::ControllerExtensions::ALLOWED_CANONICAL_PARAMS

Instance Attribute Summary

Attributes inherited from ApplicationController

#theme_id

Instance Method Summary collapse

Methods included from TopicQueryParams

#build_topic_list_options

Methods inherited from ApplicationController

#application_layout, #can_cache_content?, #clear_notifications, #conditionally_allow_site_embedding, #current_homepage, #discourse_expires_in, #dont_cache_page, #ember_cli_required?, #fetch_user_from_params, #guardian, #handle_permalink, #handle_theme, #handle_unverified_request, #has_escaped_fragment?, #immutable_for, #no_cookies, #perform_refresh_session, #post_ids_including_replies, #preload_json, #rate_limit_second_factor!, #redirect_with_client_support, #render_json_dump, #render_serialized, requires_plugin, #rescue_discourse_actions, #resolve_safe_mode, #secure_session, #serialize_data, #set_current_user_for_logs, #set_layout, #set_mobile_view, #set_mp_snapshot_fields, #show_browser_update?, #store_preloaded, #use_crawler_layout?, #with_resolved_locale

Methods included from VaryHeader

#ensure_vary_header

Methods included from ReadOnlyMixin

#add_readonly_header, #allowed_in_staff_writes_only_mode?, #block_if_readonly_mode, #check_readonly_mode, included, #staff_writes_only_mode?

Methods included from Hijack

#hijack

Methods included from GlobalPath

#cdn_path, #cdn_relative_path, #full_cdn_url, #path, #upload_cdn_path

Methods included from JsonError

#create_errors_json

Methods included from CanonicalURL::ControllerExtensions

#canonical_url, #default_canonical, included

Methods included from CurrentUser

#clear_current_user, #current_user, has_auth_cookie?, #is_api?, #is_user_api?, #log_off_user, #log_on_user, lookup_from_env, #refresh_session

Instance Method Details

#categories_and_latest ⇒ Object 



96
97
98
 
# File 'app/controllers/categories_controller.rb', line 96

def categories_and_latest
  categories_and_topics(:latest)
end

#categories_and_top ⇒ Object 



100
101
102
 
# File 'app/controllers/categories_controller.rb', line 100

def categories_and_top
  categories_and_topics(:top)
end

#create ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'app/controllers/categories_controller.rb', line 149

def create
  guardian.ensure_can_create!(Category)
  position = category_params.delete(:position)

  @category =
    begin
      Category.new(required_create_params.merge(user: current_user))
    rescue ArgumentError => e
      return render json: { errors: [e.message] }, status: 422
    end

  if @category.save
    @category.move_to(position.to_i) if position

    Scheduler::Defer.later "Log staff action create category" do
      @staff_action_logger.log_category_creation(@category)
    end

    render_serialized(@category, CategorySerializer)
  else
    render_json_error(@category)
  end
end

#destroy ⇒ Object 



248
249
250
251
252
253
254
255
256
257
 
# File 'app/controllers/categories_controller.rb', line 248

def destroy
  guardian.ensure_can_delete!(@category)
  @category.destroy

  Scheduler::Defer.later "Log staff action delete category" do
    @staff_action_logger.log_category_deletion(@category)
  end

  render json: success_json
end

#find_by_slug ⇒ Object

Raises:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'app/controllers/categories_controller.rb', line 259

def find_by_slug
  params.require(:category_slug)
  @category =
    Category.includes(:category_setting).find_by_slug_path(params[:category_slug].split("/"))

  raise Discourse::NotFound unless @category.present?

  if !guardian.can_see?(@category)
    if SiteSetting.detailed_404 && group = @category.access_category_via_group
      raise Discourse::InvalidAccess.new(
              "not in group",
              @category,
              custom_message: "not_in_group.title_category",
              custom_message_params: {
                group: group.name,
              },
              group: group,
            )
    else
      raise Discourse::NotFound
    end
  end

  @category.permission = CategoryGroup.permission_types[:full] if Category
    .topic_create_allowed(guardian)
    .where(id: @category.id)
    .exists?
  render_serialized(@category, CategorySerializer)
end

#index ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'app/controllers/categories_controller.rb', line 28

def index
  discourse_expires_in 1.minute

  @description = SiteSetting.site_description

  parent_category =
    Category.find_by_slug(params[:parent_category_id]) ||
      Category.find_by(id: params[:parent_category_id].to_i)

  include_subcategories =
    SiteSetting.desktop_category_page_style == "subcategories_with_featured_topics" ||
      params[:include_subcategories] == "true"

  category_options = {
    is_homepage: current_homepage == "categories",
    parent_category_id: params[:parent_category_id],
    include_topics: include_topics(parent_category),
    include_subcategories: include_subcategories,
    tag: params[:tag],
  }

  @category_list = CategoryList.new(guardian, category_options)

  if category_options[:is_homepage] && SiteSetting.short_site_description.present?
    @title = "#{SiteSetting.title} - #{SiteSetting.short_site_description}"
  elsif !category_options[:is_homepage]
    @title = "#{I18n.t("js.filters.categories.title")} - #{SiteSetting.title}"
  end

  respond_to do |format|
    format.html do
      store_preloaded(
        @category_list.preload_key,
        MultiJson.dump(CategoryListSerializer.new(@category_list, scope: guardian)),
      )

      style = SiteSetting.desktop_category_page_style
      topic_options = { per_page: CategoriesController.topics_per_page, no_definitions: true }

      if style == "categories_and_latest_topics_created_date"
        topic_options[:order] = "created"
        @topic_list = TopicQuery.new(current_user, topic_options).list_latest
        @topic_list.more_topics_url = url_for(public_send("latest_path", sort: :created))
      elsif style == "categories_and_latest_topics"
        @topic_list = TopicQuery.new(current_user, topic_options).list_latest
        @topic_list.more_topics_url = url_for(public_send("latest_path"))
      elsif style == "categories_and_top_topics"
        @topic_list =
          TopicQuery.new(current_user, topic_options).list_top_for(
            SiteSetting.top_page_default_timeframe.to_sym,
          )
        @topic_list.more_topics_url = url_for(public_send("top_path"))
      end

      if @topic_list.present? && @topic_list.topics.present?
        store_preloaded(
          @topic_list.preload_key,
          MultiJson.dump(TopicListSerializer.new(@topic_list, scope: guardian)),
        )
      end

      render
    end

    format.json { render_serialized(@category_list, CategoryListSerializer) }
  end
end

#move ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'app/controllers/categories_controller.rb', line 104

def move
  guardian.ensure_can_create_category!

  params.require("category_id")
  params.require("position")

  if category = Category.find(params["category_id"])
    category.move_to(params["position"].to_i)
    render json: success_json
  else
    render status: 500, json: failed_json
  end
end

#redirect ⇒ Object 



23
24
25
26
 
# File 'app/controllers/categories_controller.rb', line 23

def redirect
  return if handle_permalink("/category/#{params[:path]}")
  redirect_to path("/c/#{params[:path]}")
end

#reorder ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'app/controllers/categories_controller.rb', line 118

def reorder
  guardian.ensure_can_create_category!

  params.require(:mapping)
  change_requests = MultiJson.load(params[:mapping])
  by_category = Hash[change_requests.map { |cat, pos| [Category.find(cat.to_i), pos] }]

  unless guardian.is_admin?
    unless by_category.keys.all? { |c| guardian.can_see_category? c }
      raise Discourse::InvalidAccess
    end
  end

  by_category.each do |cat, pos|
    cat.position = pos
    cat.save! if cat.will_save_change_to_position?
  end

  render json: success_json
end

#set_notifications ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'app/controllers/categories_controller.rb', line 234

def set_notifications
  category_id = params[:category_id].to_i
  notification_level = params[:notification_level].to_i

  CategoryUser.set_notification_level_for_category(current_user, notification_level, category_id)
  render json:
           success_json.merge(
             {
               indirectly_muted_category_ids:
                 CategoryUser.indirectly_muted_category_ids(current_user),
             },
           )
end

#show ⇒ Object 



139
140
141
142
143
144
145
146
147
 
# File 'app/controllers/categories_controller.rb', line 139

def show
  guardian.ensure_can_see!(@category)

  if Category.topic_create_allowed(guardian).where(id: @category.id).exists?
    @category.permission = CategoryGroup.permission_types[:full]
  end

  render_serialized(@category, CategorySerializer)
end

#update ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'app/controllers/categories_controller.rb', line 173

def update
  guardian.ensure_can_edit!(@category)

  json_result(@category, serializer: CategorySerializer) do |cat|
    old_category_params = category_params.dup

    cat.move_to(category_params[:position].to_i) if category_params[:position]
    category_params.delete(:position)

    old_custom_fields = cat.custom_fields.dup
    if category_params[:custom_fields]
      category_params[:custom_fields].each do |key, value|
        if value.present?
          cat.custom_fields[key] = value
        else
          cat.custom_fields.delete(key)
        end
      end
    end
    category_params.delete(:custom_fields)

    # properly null the value so the database constraint doesn't catch us
    category_params[:email_in] = nil if category_params[:email_in]&.blank?
    category_params[:minimum_required_tags] = 0 if category_params[:minimum_required_tags]&.blank?

    old_permissions = cat.permissions_params
    old_permissions = { "everyone" => 1 } if old_permissions.empty?

    if result = cat.update(category_params)
      Scheduler::Defer.later "Log staff action change category settings" do
        @staff_action_logger.log_category_settings_change(
          @category,
          old_category_params,
          old_permissions: old_permissions,
          old_custom_fields: old_custom_fields,
        )
      end
    end

    DiscourseEvent.trigger(:category_updated, cat) if result

    result
  end
end

#update_slug ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'app/controllers/categories_controller.rb', line 218

def update_slug
  @category = Category.find(params[:category_id].to_i)
  guardian.ensure_can_edit!(@category)

  custom_slug = params[:slug].to_s

  if custom_slug.blank?
    error = @category.errors.full_message(:slug, I18n.t("errors.messages.blank"))
    render_json_error(error)
  elsif @category.update(slug: custom_slug)
    render json: success_json
  else
    render_json_error(@category)
  end
end

#visible_groups ⇒ Object 



289
290
291
292
293
294
295
296
297
298
 
# File 'app/controllers/categories_controller.rb', line 289

def visible_groups
  @guardian.ensure_can_see!(@category)

  groups =
    if !@category.groups.exists?(id: Group::AUTO_GROUPS[:everyone])
      @category.groups.merge(Group.visible_groups(current_user)).pluck("name")
    end

  render json: success_json.merge(groups: groups || [])
end