mirror of
https://codeberg.org/redict/redict.git
synced 2025-01-23 08:38:27 -05:00
0bfccc55e2
This PR adds a spell checker CI action that will fail future PRs if they introduce typos and spelling mistakes. This spell checker is based on blacklist of common spelling mistakes, so it will not catch everything, but at least it is also unlikely to cause false positives. Besides that, the PR also fixes many spelling mistakes and types, not all are a result of the spell checker we use. Here's a summary of other changes: 1. Scanned the entire source code and fixes all sorts of typos and spelling mistakes (including missing or extra spaces). 2. Outdated function / variable / argument names in comments 3. Fix outdated keyspace masks error log when we check `config.notify-keyspace-events` in loadServerConfigFromString. 4. Trim the white space at the end of line in `module.c`. Check: https://github.com/redis/redis/pull/7751 5. Some outdated https link URLs. 6. Fix some outdated comment. Such as: - In README: about the rdb, we used to said create a `thread`, change to `process` - dbRandomKey function coment (about the dictGetRandomKey, change to dictGetFairRandomKey) - notifyKeyspaceEvent fucntion comment (add type arg) - Some others minor fix in comment (Most of them are incorrectly quoted by variable names) 7. Modified the error log so that users can easily distinguish between TCP and TLS in `changeBindAddr`
155 lines
5.2 KiB
C
155 lines
5.2 KiB
C
#define REDISMODULE_EXPERIMENTAL_API
|
|
#include "redismodule.h"
|
|
|
|
#include <string.h>
|
|
|
|
static RedisModuleString *log_key_name;
|
|
|
|
static const char log_command_name[] = "commandfilter.log";
|
|
static const char ping_command_name[] = "commandfilter.ping";
|
|
static const char unregister_command_name[] = "commandfilter.unregister";
|
|
static int in_log_command = 0;
|
|
|
|
static RedisModuleCommandFilter *filter = NULL;
|
|
|
|
int CommandFilter_UnregisterCommand(RedisModuleCtx *ctx, RedisModuleString **argv, int argc)
|
|
{
|
|
(void) argc;
|
|
(void) argv;
|
|
|
|
RedisModule_ReplyWithLongLong(ctx,
|
|
RedisModule_UnregisterCommandFilter(ctx, filter));
|
|
|
|
return REDISMODULE_OK;
|
|
}
|
|
|
|
int CommandFilter_PingCommand(RedisModuleCtx *ctx, RedisModuleString **argv, int argc)
|
|
{
|
|
(void) argc;
|
|
(void) argv;
|
|
|
|
RedisModuleCallReply *reply = RedisModule_Call(ctx, "ping", "c", "@log");
|
|
if (reply) {
|
|
RedisModule_ReplyWithCallReply(ctx, reply);
|
|
RedisModule_FreeCallReply(reply);
|
|
} else {
|
|
RedisModule_ReplyWithSimpleString(ctx, "Unknown command or invalid arguments");
|
|
}
|
|
|
|
return REDISMODULE_OK;
|
|
}
|
|
|
|
int CommandFilter_LogCommand(RedisModuleCtx *ctx, RedisModuleString **argv, int argc)
|
|
{
|
|
RedisModuleString *s = RedisModule_CreateString(ctx, "", 0);
|
|
|
|
int i;
|
|
for (i = 1; i < argc; i++) {
|
|
size_t arglen;
|
|
const char *arg = RedisModule_StringPtrLen(argv[i], &arglen);
|
|
|
|
if (i > 1) RedisModule_StringAppendBuffer(ctx, s, " ", 1);
|
|
RedisModule_StringAppendBuffer(ctx, s, arg, arglen);
|
|
}
|
|
|
|
RedisModuleKey *log = RedisModule_OpenKey(ctx, log_key_name, REDISMODULE_WRITE|REDISMODULE_READ);
|
|
RedisModule_ListPush(log, REDISMODULE_LIST_HEAD, s);
|
|
RedisModule_CloseKey(log);
|
|
RedisModule_FreeString(ctx, s);
|
|
|
|
in_log_command = 1;
|
|
|
|
size_t cmdlen;
|
|
const char *cmdname = RedisModule_StringPtrLen(argv[1], &cmdlen);
|
|
RedisModuleCallReply *reply = RedisModule_Call(ctx, cmdname, "v", &argv[2], argc - 2);
|
|
if (reply) {
|
|
RedisModule_ReplyWithCallReply(ctx, reply);
|
|
RedisModule_FreeCallReply(reply);
|
|
} else {
|
|
RedisModule_ReplyWithSimpleString(ctx, "Unknown command or invalid arguments");
|
|
}
|
|
|
|
in_log_command = 0;
|
|
|
|
return REDISMODULE_OK;
|
|
}
|
|
|
|
void CommandFilter_CommandFilter(RedisModuleCommandFilterCtx *filter)
|
|
{
|
|
if (in_log_command) return; /* don't process our own RM_Call() from CommandFilter_LogCommand() */
|
|
|
|
/* Fun manipulations:
|
|
* - Remove @delme
|
|
* - Replace @replaceme
|
|
* - Append @insertbefore or @insertafter
|
|
* - Prefix with Log command if @log encountered
|
|
*/
|
|
int log = 0;
|
|
int pos = 0;
|
|
while (pos < RedisModule_CommandFilterArgsCount(filter)) {
|
|
const RedisModuleString *arg = RedisModule_CommandFilterArgGet(filter, pos);
|
|
size_t arg_len;
|
|
const char *arg_str = RedisModule_StringPtrLen(arg, &arg_len);
|
|
|
|
if (arg_len == 6 && !memcmp(arg_str, "@delme", 6)) {
|
|
RedisModule_CommandFilterArgDelete(filter, pos);
|
|
continue;
|
|
}
|
|
if (arg_len == 10 && !memcmp(arg_str, "@replaceme", 10)) {
|
|
RedisModule_CommandFilterArgReplace(filter, pos,
|
|
RedisModule_CreateString(NULL, "--replaced--", 12));
|
|
} else if (arg_len == 13 && !memcmp(arg_str, "@insertbefore", 13)) {
|
|
RedisModule_CommandFilterArgInsert(filter, pos,
|
|
RedisModule_CreateString(NULL, "--inserted-before--", 19));
|
|
pos++;
|
|
} else if (arg_len == 12 && !memcmp(arg_str, "@insertafter", 12)) {
|
|
RedisModule_CommandFilterArgInsert(filter, pos + 1,
|
|
RedisModule_CreateString(NULL, "--inserted-after--", 18));
|
|
pos++;
|
|
} else if (arg_len == 4 && !memcmp(arg_str, "@log", 4)) {
|
|
log = 1;
|
|
}
|
|
pos++;
|
|
}
|
|
|
|
if (log) RedisModule_CommandFilterArgInsert(filter, 0,
|
|
RedisModule_CreateString(NULL, log_command_name, sizeof(log_command_name)-1));
|
|
}
|
|
|
|
int RedisModule_OnLoad(RedisModuleCtx *ctx, RedisModuleString **argv, int argc) {
|
|
if (RedisModule_Init(ctx,"commandfilter",1,REDISMODULE_APIVER_1)
|
|
== REDISMODULE_ERR) return REDISMODULE_ERR;
|
|
|
|
if (argc != 2) {
|
|
RedisModule_Log(ctx, "warning", "Log key name not specified");
|
|
return REDISMODULE_ERR;
|
|
}
|
|
|
|
long long noself = 0;
|
|
log_key_name = RedisModule_CreateStringFromString(ctx, argv[0]);
|
|
RedisModule_StringToLongLong(argv[1], &noself);
|
|
|
|
if (RedisModule_CreateCommand(ctx,log_command_name,
|
|
CommandFilter_LogCommand,"write deny-oom",1,1,1) == REDISMODULE_ERR)
|
|
return REDISMODULE_ERR;
|
|
|
|
if (RedisModule_CreateCommand(ctx,ping_command_name,
|
|
CommandFilter_PingCommand,"deny-oom",1,1,1) == REDISMODULE_ERR)
|
|
return REDISMODULE_ERR;
|
|
|
|
if (RedisModule_CreateCommand(ctx,unregister_command_name,
|
|
CommandFilter_UnregisterCommand,"write deny-oom",1,1,1) == REDISMODULE_ERR)
|
|
return REDISMODULE_ERR;
|
|
|
|
if ((filter = RedisModule_RegisterCommandFilter(ctx, CommandFilter_CommandFilter,
|
|
noself ? REDISMODULE_CMDFILTER_NOSELF : 0))
|
|
== NULL) return REDISMODULE_ERR;
|
|
|
|
return REDISMODULE_OK;
|
|
}
|
|
|
|
int RedisModule_OnUnload(RedisModuleCtx *ctx) {
|
|
RedisModule_FreeString(ctx, log_key_name);
|
|
return REDISMODULE_OK;
|
|
}
|