mirror of
http://github.com/valkey-io/valkey
synced 2024-11-22 09:17:20 +00:00
71204f9632
This implements the following main pieces of functionality: * Renames key spec "CHANNEL" to be "NOT_KEY", and update the documentation to indicate it's for cluster routing and not for any other key related purpose. * Add the getchannels-api, so that modules can now define commands that are subject to ACL channel permission checks. * Add 4 new flags that describe how a module interacts with a command (SUBSCRIBE, PUBLISH, UNSUBSCRIBE, and PATTERN). They are all technically composable, however not sure how a command could both subscribe and unsubscribe from a command at once, but didn't see a reason to add explicit validation there. * Add two new module apis RM_ChannelAtPosWithFlags and RM_IsChannelsPositionRequest to duplicate the functionality provided by the keys position APIs. * The RM_ACLCheckChannelPermissions (only released in 7.0 RC1) was changed to take flags rather than a boolean literal. * The RM_ACLCheckKeyPermissions (only released in 7.0 RC1) was changed to take flags corresponding to keyspecs instead of custom permission flags. These keyspec flags mimic the flags for ACLCheckChannelPermissions.
70 lines
2.4 KiB
C
70 lines
2.4 KiB
C
#include "redismodule.h"
|
|
#include <strings.h>
|
|
#include <assert.h>
|
|
#include <unistd.h>
|
|
#include <errno.h>
|
|
|
|
/* A sample with declarable channels, that are used to validate against ACLs */
|
|
int getChannels_subscribe(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
|
|
if ((argc - 1) % 3 != 0) {
|
|
RedisModule_WrongArity(ctx);
|
|
return REDISMODULE_OK;
|
|
}
|
|
char *err = NULL;
|
|
|
|
/* getchannels.command [[subscribe|unsubscribe|publish] [pattern|literal] <channel> ...]
|
|
* This command marks the given channel is accessed based on the
|
|
* provided modifiers. */
|
|
for (int i = 1; i < argc; i += 3) {
|
|
const char *operation = RedisModule_StringPtrLen(argv[i], NULL);
|
|
const char *type = RedisModule_StringPtrLen(argv[i+1], NULL);
|
|
int flags = 0;
|
|
|
|
if (!strcasecmp(operation, "subscribe")) {
|
|
flags |= REDISMODULE_CMD_CHANNEL_SUBSCRIBE;
|
|
} else if (!strcasecmp(operation, "unsubscribe")) {
|
|
flags |= REDISMODULE_CMD_CHANNEL_UNSUBSCRIBE;
|
|
} else if (!strcasecmp(operation, "publish")) {
|
|
flags |= REDISMODULE_CMD_CHANNEL_PUBLISH;
|
|
} else {
|
|
err = "Invalid channel operation";
|
|
break;
|
|
}
|
|
|
|
if (!strcasecmp(type, "literal")) {
|
|
/* No op */
|
|
} else if (!strcasecmp(type, "pattern")) {
|
|
flags |= REDISMODULE_CMD_CHANNEL_PATTERN;
|
|
} else {
|
|
err = "Invalid channel type";
|
|
break;
|
|
}
|
|
if (RedisModule_IsChannelsPositionRequest(ctx)) {
|
|
RedisModule_ChannelAtPosWithFlags(ctx, i+2, flags);
|
|
}
|
|
}
|
|
|
|
if (!RedisModule_IsChannelsPositionRequest(ctx)) {
|
|
if (err) {
|
|
RedisModule_ReplyWithError(ctx, err);
|
|
} else {
|
|
/* Normal implementation would go here, but for tests just return okay */
|
|
RedisModule_ReplyWithSimpleString(ctx, "OK");
|
|
}
|
|
}
|
|
|
|
return REDISMODULE_OK;
|
|
}
|
|
|
|
int RedisModule_OnLoad(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
|
|
REDISMODULE_NOT_USED(argv);
|
|
REDISMODULE_NOT_USED(argc);
|
|
if (RedisModule_Init(ctx, "getchannels", 1, REDISMODULE_APIVER_1) == REDISMODULE_ERR)
|
|
return REDISMODULE_ERR;
|
|
|
|
if (RedisModule_CreateCommand(ctx, "getchannels.command", getChannels_subscribe, "getchannels-api", 0, 0, 0) == REDISMODULE_ERR)
|
|
return REDISMODULE_ERR;
|
|
|
|
return REDISMODULE_OK;
|
|
}
|