MOD-7919 Expand redis_command! to support ACL

examples/acl.rs

@@ -26,7 +26,7 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["verify_key_access_for_user", verify_key_access_for_user, "", 0, 0, 0],
-        ["get_current_user", get_current_user, "", 0, 0, 0],
+        ["verify_key_access_for_user", verify_key_access_for_user, "", 0, 0, 0, ""],
+        ["get_current_user", get_current_user, "", 0, 0, 0, ""],
     ],
 }

examples/block.rs

@@ -25,6 +25,6 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["block", block, "", 0, 0, 0],
+        ["block", block, "", 0, 0, 0, ""],
     ],
 }

examples/call.rs

@@ -164,8 +164,8 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["call.test", call_test, "", 0, 0, 0],
-        ["call.blocking", call_blocking, "", 0, 0, 0],
-        ["call.blocking_from_detached_ctx", call_blocking_from_detach_ctx, "", 0, 0, 0],
+        ["call.test", call_test, "", 0, 0, 0, ""],
+        ["call.blocking", call_blocking, "", 0, 0, 0, ""],
+        ["call.blocking_from_detached_ctx", call_blocking_from_detach_ctx, "", 0, 0, 0, ""],
     ],
 }

examples/configuration.rs

@@ -55,7 +55,7 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["configuration.num_changes", num_changes, "", 0, 0, 0],
+        ["configuration.num_changes", num_changes, "", 0, 0, 0, ""],
     ],
     configurations: [
         i64: [

examples/ctx_flags.rs

@@ -18,6 +18,6 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["my_role", role, "readonly", 0, 0, 0],
+        ["my_role", role, "readonly", 0, 0, 0, ""],
     ],
 }

examples/data_type.rs

@@ -160,8 +160,8 @@ redis_module! {
         MY_REDIS_TYPE,
     ],
     commands: [
-        ["alloc.set", alloc_set, "write", 1, 1, 1],
-        ["alloc.get", alloc_get, "readonly", 1, 1, 1],
-        ["alloc.defragstats", alloc_defragstats, "readonly", 0, 0, 0]
+        ["alloc.set", alloc_set, "write", 1, 1, 1, ""],
+        ["alloc.get", alloc_get, "readonly", 1, 1, 1, ""],
+        ["alloc.defragstats", alloc_defragstats, "readonly", 0, 0, 0, ""],
     ],
 }

examples/events.rs

@@ -68,9 +68,9 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["events.send", event_send, "", 0, 0, 0],
-        ["events.num_key_miss", num_key_miss, "", 0, 0, 0],
-        ["events.num_keys", num_keys, "", 0, 0, 0],
+        ["events.send", event_send, "", 0, 0, 0, ""],
+        ["events.num_key_miss", num_key_miss, "", 0, 0, 0, ""],
+        ["events.num_keys", num_keys, "", 0, 0, 0, ""],
     ],
     event_handlers: [
         [@STRING: on_event],

examples/expire.rs

@@ -25,6 +25,6 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["expire.cmd", expire_cmd, "write fast deny-oom", 1, 1, 1],
+        ["expire.cmd", expire_cmd, "write fast deny-oom", 1, 1, 1, ""],
     ],
 }

examples/hello.rs

@@ -27,6 +27,6 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["hello.mul", hello_mul, "", 0, 0, 0],
+        ["hello.mul", hello_mul, "", 0, 0, 0, ""],
     ],
 }

examples/info.rs

@@ -26,6 +26,6 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["infoex", info_cmd, "", 0, 0, 0],
+        ["infoex", info_cmd, "", 0, 0, 0, ""],
     ],
 }

examples/keys_pos.rs

@@ -28,6 +28,6 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["keys_pos", keys_pos, "getkeys-api", 1, 1, 1],
+        ["keys_pos", keys_pos, "getkeys-api", 1, 1, 1, ""],
     ],
 }

examples/lists.rs

@@ -43,6 +43,6 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["LPOPRPUSH", lpoprpush, "write fast deny-oom", 1, 2, 1],
+        ["LPOPRPUSH", lpoprpush, "write fast deny-oom", 1, 2, 1, ""],
     ],
 }

examples/response.rs

@@ -67,7 +67,7 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["map.mget", map_mget, "readonly", 1, 1, 1],
-        ["map.unique", map_unique, "readonly", 1, 1, 1],
+        ["map.mget", map_mget, "readonly", 1, 1, 1, ""],
+        ["map.unique", map_unique, "readonly", 1, 1, 1, ""],
     ],
 }

examples/scan_keys.rs

@@ -24,6 +24,6 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["scan_keys", scan_keys, "readonly", 0, 0, 0],
+        ["scan_keys", scan_keys, "readonly", 0, 0, 0, ""],
     ],
 }

examples/server_events.rs

@@ -51,8 +51,8 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["num_flushed", num_flushed, "readonly", 0, 0, 0],
-        ["num_max_memory_changes", num_maxmemory_changes, "readonly", 0, 0, 0],
-        ["num_crons", num_crons, "readonly", 0, 0, 0],
+        ["num_flushed", num_flushed, "readonly", 0, 0, 0, ""],
+        ["num_max_memory_changes", num_maxmemory_changes, "readonly", 0, 0, 0, ""],
+        ["num_crons", num_crons, "readonly", 0, 0, 0, ""],
     ],
 }

examples/stream.rs

@@ -41,6 +41,6 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["STREAM_POP", stream_read_from, "write", 1, 1, 1],
+        ["STREAM_POP", stream_read_from, "write", 1, 1, 1, ""],
     ],
 }

examples/string.rs

@@ -40,7 +40,7 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["string.set", string_set, "write fast deny-oom", 1, 1, 1],
-        ["string.get", string_get, "readonly", 1, 1, 1],
+        ["string.set", string_set, "write fast deny-oom", 1, 1, 1, ""],
+        ["string.get", string_get, "readonly", 1, 1, 1, ""],
     ],
 }

examples/test_helper.rs

@@ -45,9 +45,9 @@ redis_module! {
     data_types: [],
     info: add_info,
     commands: [
-        ["test_helper.version", test_helper_version, "", 0, 0, 0],
-        ["test_helper._version_rm_call", test_helper_version_rm_call, "", 0, 0, 0],
-        ["test_helper.name", test_helper_command_name, "", 0, 0, 0],
-        ["test_helper.err", test_helper_err, "", 0, 0, 0],
+        ["test_helper.version", test_helper_version, "", 0, 0, 0, ""],
+        ["test_helper._version_rm_call", test_helper_version_rm_call, "", 0, 0, 0, ""],
+        ["test_helper.name", test_helper_command_name, "", 0, 0, 0, ""],
+        ["test_helper.err", test_helper_err, "", 0, 0, 0, ""],
     ],
 }

examples/threads.rs

@@ -65,9 +65,9 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["threads", threads, "", 0, 0, 0],
-        ["set_static_data", set_static_data, "", 0, 0, 0],
-        ["get_static_data", get_static_data, "", 0, 0, 0],
-        ["get_static_data_on_thread", get_static_data_on_thread, "", 0, 0, 0],
+        ["threads", threads, "", 0, 0, 0, ""],
+        ["set_static_data", set_static_data, "", 0, 0, 0, ""],
+        ["get_static_data", get_static_data, "", 0, 0, 0, ""],
+        ["get_static_data_on_thread", get_static_data_on_thread, "", 0, 0, 0, ""],
     ],
 }

examples/timer.rs

@@ -45,8 +45,8 @@ redis_module! {
     allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
     data_types: [],
     commands: [
-        ["timer.create", timer_create, "", 0, 0, 0],
-        ["timer.info", timer_info, "", 0, 0, 0],
-        ["timer.stop", timer_stop, "", 0, 0, 0],
+        ["timer.create", timer_create, "", 0, 0, 0, ""],
+        ["timer.info", timer_info, "", 0, 0, 0, ""],
+        ["timer.stop", timer_stop, "", 0, 0, 0, ""],
     ],
 }

src/macros.rs

@@ -6,7 +6,8 @@ macro_rules! redis_command {
      $command_flags:expr,
      $firstkey:expr,
      $lastkey:expr,
-     $keystep:expr) => {{
+     $keystep:expr,
+     $acl_categories:expr) => {{
         let name = CString::new($command_name).unwrap();
         let flags = CString::new($command_flags).unwrap();
 
@@ -38,6 +39,26 @@ macro_rules! redis_command {
         {
             return $crate::raw::Status::Err as c_int;
         }
+
+        if $acl_categories != "" {
+            let acl_categories = CString::new($acl_categories).unwrap();
+
+            let command =
+                unsafe { $crate::raw::RedisModule_GetCommand.unwrap()($ctx, name.as_ptr()) };
+            if command.is_null() {
+                return $crate::raw::Status::Err as c_int;
+            }
+
+            if unsafe {
+                $crate::raw::RedisModule_SetCommandACLCategories.unwrap()(
+                    command,
+                    acl_categories.as_ptr(),
+                )
+            } == $crate::raw::Status::Err as c_int
+            {
+                return $crate::raw::Status::Err as c_int;
+            }
+        }
     }};
 }
 
@@ -116,7 +137,8 @@ macro_rules! redis_module {
                 $flags:expr,
                 $firstkey:expr,
                 $lastkey:expr,
-                $keystep:expr
+                $keystep:expr,
+                $acl_categories:expr
               ]),* $(,)*
         ] $(,)*
         $(event_handlers: [
@@ -241,7 +263,7 @@ macro_rules! redis_module {
             )*
 
             $(
-                $crate::redis_command!(ctx, $name, $command, $flags, $firstkey, $lastkey, $keystep);
+                $crate::redis_command!(ctx, $name, $command, $flags, $firstkey, $lastkey, $keystep, $acl_categories);
             )*
 
             if $crate::commands::register_commands(&context) == raw::Status::Err {
@@ -329,13 +351,13 @@ macro_rules! redis_module {
                 $(
                     $crate::redis_command!(ctx, $module_config_get_command, |ctx, args: Vec<RedisString>| {
                         module_config_get(ctx, args, $module_name)
-                    }, "", 0, 0, 0);
+                    }, "", 0, 0, 0, "");
                 )?
 
                 $(
                     $crate::redis_command!(ctx, $module_config_set_command, |ctx, args: Vec<RedisString>| {
                         module_config_set(ctx, args, $module_name)
-                    }, "", 0, 0, 0);
+                    }, "", 0, 0, 0, "");
                 )?
             )?