0
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2026-08-06 13:08:40 +08:00
discourse/lib/theme_settings_group_resolver/object_setting.rb
Martin Brennan bee1be8599
DEV: Add resolve_group_membership for theme object settings of group type (#41756)
Followup 7e77ce4bd3

We need to automatically resolve group membership into a boolean
for theme object type settings which are of the group type, similar
to what we did in the original commit above for group list type
settings.

This behaves in the same way -- for an object setting schema like this:

```
menu_sections:
  type: objects
  default:
    - name: section 1
      groups:
        - 1
        - 3
  schema:
    name: menu section
    properties:
      name:
        type: string
      groups:
        type: groups
        resolve_group_membership: true
```

We replace `groups` with a boolean `user_in_groups` (groups is just
the property name, it could be foo_bar etc.) and then you can
do this on the client:

```
for (const section of settings.menu_sections) {
  if (section.user_in_groups) {
    // User is in at least one selected group for this section.
  }
}
```

Rather than inspecting the `currentUser.groups`, which only includes
visible groups, not all groups the user is a member of. This allows
for more accurate permission checks for theme settings that are group
based.

Also c.f.
https://meta.discourse.org/t/granular-group-based-permissions-for-anonymous-and-logged-in-users/402273/18?u=martin
2026-07-17 10:19:29 +10:00

75 lines
2.4 KiB
Ruby
Vendored

# frozen_string_literal: true
class ThemeSettingsGroupResolver
# Resolves opted-in `type: groups` properties inside object settings while
# leaving stored/admin values untouched.
#
# c.f. ThemeSettingsGroupResolver.resolve
#
# Example:
# input: { menu_sections: [{ "groups" => [1, 2], "name" => "Main" }] }
# output: { menu_sections: [{ "user_in_groups" => true, "name" => "Main" }] }
class ObjectSetting
def self.applies?(setting_info)
setting_info[:type] == "objects"
end
def initialize(setting_name:, setting_info:, guardian:)
@setting_name = setting_name
@schema = setting_info[:schema]
@guardian = guardian
end
def resolve!(settings)
objects = settings[@setting_name]
return if !objects.is_a?(Array) || !resolves_groups?(@schema)
settings[@setting_name] = objects.deep_dup.each { |object| resolve_object!(object, @schema) }
end
private
def resolves_groups?(schema)
return false if schema.blank?
schema[:properties].any? do |_, property|
(property[:type] == "groups" && property[:resolve_group_membership]) ||
(property[:type] == "objects" && resolves_groups?(property[:schema]))
end
end
def resolve_object!(object, schema)
schema[:properties].each do |property_name, property|
if property[:type] == "groups" && property[:resolve_group_membership]
resolve_group_property!(object, property_name)
elsif property[:type] == "objects"
resolve_nested_objects!(object, property_name, property[:schema])
end
end
end
def resolve_group_property!(object, property_name)
key = object_key(object, property_name)
group_ids = Array(object.delete(key)).map(&:to_i)
object[resolved_key(key, property_name)] = @guardian.in_any_groups?(group_ids)
end
def resolve_nested_objects!(object, property_name, schema)
nested_objects = object[object_key(object, property_name)]
return if !nested_objects.is_a?(Array)
nested_objects.each { |nested_object| resolve_object!(nested_object, schema) }
end
def object_key(object, property_name)
string_key = property_name.to_s
return string_key if object.key?(string_key)
property_name.to_sym
end
def resolved_key(original_key, property_name)
original_key.is_a?(String) ? "user_in_#{property_name}" : :"user_in_#{property_name}"
end
end
end