feat(role): add support for new roles ACL permissions (#391)

Author: larcin

app/controllers/forest_liana/resources_controller.rb

@@ -16,18 +16,15 @@ class ResourcesController < ForestLiana::ApplicationController
     def index
       begin
         if request.format == 'csv'
-          checker = ForestLiana::PermissionsChecker.new(@resource, 'export', @rendering_id)
-          return head :forbidden unless checker.is_authorized?
-        elsif params.has_key?(:searchToEdit)
-          checker = ForestLiana::PermissionsChecker.new(@resource, 'searchToEdit', @rendering_id)
+          checker = ForestLiana::PermissionsChecker.new(@resource, 'exportEnabled', @rendering_id, user_id: forest_user['id'])
           return head :forbidden unless checker.is_authorized?
         else
           checker = ForestLiana::PermissionsChecker.new(
             @resource,
-            'list',
+            'browseEnabled',
             @rendering_id,
-            nil,
-            get_collection_list_permission_info(forest_user, request)
+            user_id: forest_user['id'],
+            collection_list_parameters: get_collection_list_permission_info(forest_user, request)
           )
           return head :forbidden unless checker.is_authorized?
         end
@@ -59,10 +56,10 @@ def count
       begin
         checker = ForestLiana::PermissionsChecker.new(
           @resource,
-          'list',
+          'browseEnabled',
           @rendering_id,
-          nil,
-          get_collection_list_permission_info(forest_user, request)
+          user_id: forest_user['id'],
+          collection_list_parameters: get_collection_list_permission_info(forest_user, request)
         )
         return head :forbidden unless checker.is_authorized?
 
@@ -89,7 +86,7 @@ def count
 
     def show
       begin
-        checker = ForestLiana::PermissionsChecker.new(@resource, 'show', @rendering_id)
+        checker = ForestLiana::PermissionsChecker.new(@resource, 'readEnabled', @rendering_id, user_id: forest_user['id'])
         return head :forbidden unless checker.is_authorized?
 
         getter = ForestLiana::ResourceGetter.new(@resource, params)
@@ -104,7 +101,7 @@ def show
 
     def create
       begin
-        checker = ForestLiana::PermissionsChecker.new(@resource, 'create', @rendering_id)
+        checker = ForestLiana::PermissionsChecker.new(@resource, 'addEnabled', @rendering_id, user_id: forest_user['id'])
         return head :forbidden unless checker.is_authorized?
 
         creator = ForestLiana::ResourceCreator.new(@resource, params)
@@ -127,7 +124,7 @@ def create
 
     def update
       begin
-        checker = ForestLiana::PermissionsChecker.new(@resource, 'update', @rendering_id)
+        checker = ForestLiana::PermissionsChecker.new(@resource, 'editEnabled', @rendering_id, user_id: forest_user['id'])
         return head :forbidden unless checker.is_authorized?
 
         updater = ForestLiana::ResourceUpdater.new(@resource, params)
@@ -149,7 +146,7 @@ def update
     end
 
     def destroy
-      checker = ForestLiana::PermissionsChecker.new(@resource, 'delete', @rendering_id)
+      checker = ForestLiana::PermissionsChecker.new(@resource, 'deleteEnabled', @rendering_id, user_id: forest_user['id'])
       return head :forbidden unless checker.is_authorized?
 
       @resource.destroy(params[:id]) if @resource.exists?(params[:id])
@@ -161,7 +158,7 @@ def destroy
     end
 
     def destroy_bulk
-      checker = ForestLiana::PermissionsChecker.new(@resource, 'delete', @rendering_id)
+      checker = ForestLiana::PermissionsChecker.new(@resource, 'deleteEnabled', @rendering_id, user_id: forest_user['id'])
       return head :forbidden unless checker.is_authorized?
 
       ids = ForestLiana::ResourcesGetter.get_ids_from_request(params)
@@ -245,8 +242,8 @@ def get_collection
       @collection ||= ForestLiana.apimap.find { |collection| collection.name.to_s == collection_name }
     end
 
-    # NOTICE: Return a formatted object containing the request condition filters and 
-    #         the user id used by the scope validator class to validate if scope is 
+    # NOTICE: Return a formatted object containing the request condition filters and
+    #         the user id used by the scope validator class to validate if scope is
     #         in request
     def get_collection_list_permission_info(user, collection_list_request)
       {

app/controllers/forest_liana/smart_actions_controller.rb

@@ -19,14 +19,15 @@ def get_smart_action_request
 
     def check_permission_for_smart_route
       begin
-        
+
         smart_action_request = get_smart_action_request
         if !smart_action_request.nil? && smart_action_request.has_key?(:smart_action_id)
           checker = ForestLiana::PermissionsChecker.new(
             find_resource(smart_action_request[:collection_name]),
             'actions',
             @rendering_id,
-            get_smart_action_permission_info(forest_user, smart_action_request)
+            user_id: forest_user['id'],
+            smart_action_request_info: get_smart_action_request_info
           )
           return head :forbidden unless checker.is_authorized?
         else
@@ -54,10 +55,14 @@ def find_resource(collection_name)
       end
     end
 
-    def get_smart_action_permission_info(user, smart_action_request)
+    # smart action permissions are retrieved from the action's endpoint and http_method
+    def get_smart_action_request_info
+      endpoint = request.fullpath
+      # Trim starting '/'
+      endpoint[0] = '' if endpoint[0] == '/'
       {
-        user_id: user['id'],
-        action_id: smart_action_request[:smart_action_id],
+        endpoint: endpoint,
+        http_method: request.request_method
       }
     end
   end

app/services/forest_liana/permissions_checker.rb

@@ -1,100 +1,162 @@
 module ForestLiana
   class PermissionsChecker
-    @@permissions_per_rendering = Hash.new
+    @@permissions_cached = Hash.new
+    @@scopes_cached = Hash.new
+    @@roles_acl_activated = false
+    # TODO: handle cache scopes per rendering
     @@expiration_in_seconds = (ENV['FOREST_PERMISSIONS_EXPIRATION_IN_SECONDS'] || 3600).to_i
 
-    def initialize(resource, permission_name, rendering_id, smart_action_parameters = nil, collection_list_parameters = nil)
+    def initialize(resource, permission_name, rendering_id, user_id:, smart_action_request_info: nil, collection_list_parameters: nil)
+      @user_id = user_id
       @collection_name = ForestLiana.name_for(resource)
       @permission_name = permission_name
       @rendering_id = rendering_id
-      @smart_action_parameters = smart_action_parameters
+      @smart_action_request_info = smart_action_request_info
       @collection_list_parameters = collection_list_parameters
     end
 
     def is_authorized?
-      (is_permission_expired? || !is_allowed?) ? retrieve_permissions_and_check_allowed : true
-    end
-
-    private
+      # User is still authorized if he already was and the permission has not expire
+      # if !have_permissions_expired && is_allowed
+      return true unless have_permissions_expired? || !is_allowed
 
-    def get_permissions
-      @@permissions_per_rendering &&
-        @@permissions_per_rendering[@rendering_id] &&
-        @@permissions_per_rendering[@rendering_id]['data']
+      fetch_permissions
+      is_allowed
     end
 
-    def get_last_retrieve
-      @@permissions_per_rendering &&
-        @@permissions_per_rendering[@rendering_id] &&
-        @@permissions_per_rendering[@rendering_id]['last_retrieve']
-    end
+    private
 
-    def smart_action_allowed?(smart_actions_permissions) 
-      if !@smart_action_parameters||
-          !@smart_action_parameters[:user_id] ||
-          !@smart_action_parameters[:action_id] ||
-          !smart_actions_permissions ||
-          !smart_actions_permissions[@smart_action_parameters[:action_id]]
-        return false
+    def fetch_permissions
+      permissions = ForestLiana::PermissionsGetter::get_permissions_for_rendering(@rendering_id)
+      @@roles_acl_activated = permissions['meta']['rolesACLActivated']
+      permissions['last_fetch'] = Time.now
+      if @@roles_acl_activated
+        @@permissions_cached = permissions
+      else
+        permissions['data'] = ForestLiana::PermissionsFormatter.convert_to_new_format(permissions['data'], @rendering_id)
+        @@permissions_cached[@rendering_id] = permissions
       end
-
-      @user_id = @smart_action_parameters[:user_id]
-      @action_id = @smart_action_parameters[:action_id]
-      @smart_action_permissions = smart_actions_permissions[@action_id]
-      @allowed = @smart_action_permissions['allowed']
-      @users = @smart_action_permissions['users']
-
-      return @allowed && (@users.nil?|| @users.include?(@user_id.to_i));
+      add_scopes_to_cache(permissions)
     end
 
-    def collection_list_allowed?(scope_permissions)
-      return ForestLiana::ScopeValidator.new(
-        scope_permissions['filter'],
-        scope_permissions['dynamicScopesValues']['users']
-      ).is_scope_in_request?(@collection_list_parameters)
+    def add_scopes_to_cache(permissions)
+      permissions['data']['renderings'].keys.each { |rendering_id|
+        @@scopes_cached[rendering_id] = permissions['data']['renderings'][rendering_id]
+        @@scopes_cached[rendering_id]['last_fetch'] = Time.now
+      } if permissions['data']['renderings']
     end
 
-    def is_allowed?
-      permissions = get_permissions
+    def is_allowed
+      permissions = get_permissions_content
+
       if permissions && permissions[@collection_name] &&
         permissions[@collection_name]['collection']
         if @permission_name === 'actions'
           return smart_action_allowed?(permissions[@collection_name]['actions'])
-        # NOTICE: Permissions[@collection_name]['scope'] will either contains conditions filter and
-        #         dynamic user values definition, or null for collection that does not use scopes
-        elsif @permission_name === 'list' and permissions[@collection_name]['scope']
-          return collection_list_allowed?(permissions[@collection_name]['scope'])
         else
-          return permissions[@collection_name]['collection'][@permission_name]
+          if @permission_name === 'browseEnabled'
+            refresh_scope_cache if scope_cache_expired?
+            scope_permissions = get_scope_in_permissions
+            if scope_permissions
+              # NOTICE: current_scope will either contains conditions filter and
+              #         dynamic user values definition, or null for collection that does not use scopes
+              return false unless are_scopes_valid?(scope_permissions)
+            end
+          end
+          return is_user_allowed(permissions[@collection_name]['collection'][@permission_name])
         end
       else
         false
       end
     end
 
-    def retrieve_permissions
-      @@permissions_per_rendering[@rendering_id] = Hash.new
-      permissions = ForestLiana::PermissionsGetter.new(@rendering_id).perform()
-      @@permissions_per_rendering[@rendering_id]['data'] = permissions
-      @@permissions_per_rendering[@rendering_id]['last_retrieve'] = Time.now
+    def get_scope_in_permissions
+      @@scopes_cached[@rendering_id] &&
+      @@scopes_cached[@rendering_id][@collection_name] &&
+      @@scopes_cached[@rendering_id][@collection_name]['scope']
+    end
+
+    def scope_cache_expired?
+      return true unless @@scopes_cached[@rendering_id] && @@scopes_cached[@rendering_id]['last_fetch']
+
+      elapsed_seconds = date_difference_in_seconds(Time.now, @@scopes_cached[@rendering_id]['last_fetch'])
+      elapsed_seconds >= @@expiration_in_seconds
+    end
+
+    # This will happen only on rolesACLActivated (as scope cache will always be up to date on disabled)
+    def refresh_scope_cache
+      permissions = ForestLiana::PermissionsGetter::get_permissions_for_rendering(@rendering_id, rendering_specific_only: true)
+      add_scopes_to_cache(permissions)
+    end
+
+    # When acl disabled permissions are stored and retrieved by rendering
+    def get_permissions
+      @@roles_acl_activated ? @@permissions_cached : @@permissions_cached[@rendering_id]
+    end
+
+    def get_permissions_content
+      permissions = get_permissions
+      permissions && permissions['data'] && permissions['data']['collections']
+    end
+
+    def get_last_fetch
+      permissions = get_permissions
+      permissions && permissions['last_fetch']
+    end
+
+    def get_smart_action_permissions(smart_actions_permissions)
+      endpoint = @smart_action_request_info[:endpoint]
+      http_method = @smart_action_request_info[:http_method]
+
+      return nil unless endpoint && http_method
+
+      schema_smart_action = ForestLiana::Utils::BetaSchemaUtils.find_action_from_endpoint(@collection_name, endpoint, http_method)
+
+      schema_smart_action &&
+        schema_smart_action.name &&
+        smart_actions_permissions &&
+        smart_actions_permissions[schema_smart_action.name]
+    end
+
+    def is_user_allowed(permission_value)
+      return false if permission_value.nil?
+      return permission_value if permission_value.in? [true, false]
+      permission_value.include?(@user_id.to_i)
+    end
+
+    def smart_action_allowed?(smart_actions_permissions)
+      smart_action_permissions = get_smart_action_permissions(smart_actions_permissions)
+
+      return false unless smart_action_permissions
+
+      is_user_allowed(smart_action_permissions['triggerEnabled'])
+    end
+
+    def are_scopes_valid?(scope_permissions)
+      return ForestLiana::ScopeValidator.new(
+        scope_permissions['filter'],
+        scope_permissions['dynamicScopesValues']['users']
+      ).is_scope_in_request?(@collection_list_parameters)
     end
 
     def date_difference_in_seconds(date1, date2)
       (date1 - date2).to_i
     end
 
-    def is_permission_expired?
-      last_retrieve = get_last_retrieve
-
-      return true if last_retrieve.nil?
+    def have_permissions_expired?
+      last_fetch = get_last_fetch
+      return true unless last_fetch
 
-      elapsed_seconds = date_difference_in_seconds(Time.now, last_retrieve)
+      elapsed_seconds = date_difference_in_seconds(Time.now, last_fetch)
       elapsed_seconds >= @@expiration_in_seconds
     end
 
-    def retrieve_permissions_and_check_allowed
-      retrieve_permissions
-      is_allowed?
+    # Used only for testing purpose
+    def self.empty_cache
+      @@permissions_cached = Hash.new
+      @@scopes_cached = Hash.new
+      @@roles_acl_activated = false
+      @@expiration_in_seconds = (ENV['FOREST_PERMISSIONS_EXPIRATION_IN_SECONDS'] || 3600).to_i
     end
   end
 end