mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2025-04-04 22:04:17 +02:00
23f5712d02
Validity by command was not granular enough so numerous options needed be marked internal so users would not stumble across them. Options were also needlessly being passed to roles that had no use for them. Introduce per-role validity lists that depend on what roles are valid per command. Also add a check to ensure that only valid roles are used with a command. This commit adds the functionality but does not introduce any new behavior, i.e. all options are valid for all roles that the command is valid for. A subsequent commit will introduce the new role restrictions to make the changes easier to audit.
245 lines
10 KiB
C
245 lines
10 KiB
C
/***********************************************************************************************************************************
|
|
Common Command Routines
|
|
***********************************************************************************************************************************/
|
|
#include "build.auto.h"
|
|
|
|
#include <inttypes.h>
|
|
#include <string.h>
|
|
|
|
#include "common/debug.h"
|
|
#include "common/log.h"
|
|
#include "common/memContext.h"
|
|
#include "common/stat.h"
|
|
#include "common/time.h"
|
|
#include "common/type/json.h"
|
|
#include "config/config.intern.h"
|
|
#include "config/parse.h"
|
|
#include "version.h"
|
|
|
|
/***********************************************************************************************************************************
|
|
Track time command started
|
|
***********************************************************************************************************************************/
|
|
static TimeMSec timeBegin;
|
|
static String *cmdOptionStr;
|
|
|
|
/**********************************************************************************************************************************/
|
|
void
|
|
cmdInit(void)
|
|
{
|
|
FUNCTION_LOG_VOID(logLevelTrace);
|
|
|
|
timeBegin = timeMSec();
|
|
|
|
FUNCTION_LOG_RETURN_VOID();
|
|
}
|
|
|
|
/**********************************************************************************************************************************/
|
|
const String *
|
|
cmdOption(void)
|
|
{
|
|
FUNCTION_TEST_VOID();
|
|
|
|
if (cmdOptionStr == NULL)
|
|
{
|
|
MEM_CONTEXT_BEGIN(memContextTop())
|
|
{
|
|
cmdOptionStr = strNew("");
|
|
|
|
MEM_CONTEXT_TEMP_BEGIN()
|
|
{
|
|
// Add command parameters if they exist
|
|
const StringList *commandParamList = cfgCommandParam();
|
|
|
|
if (strLstSize(commandParamList) != 0)
|
|
{
|
|
strCatFmt(cmdOptionStr, " [");
|
|
|
|
for (unsigned int commandParamIdx = 0; commandParamIdx < strLstSize(commandParamList); commandParamIdx++)
|
|
{
|
|
const String *commandParam = strLstGet(commandParamList, commandParamIdx);
|
|
|
|
if (commandParamIdx != 0)
|
|
strCatFmt(cmdOptionStr, ", ");
|
|
|
|
if (strchr(strZ(commandParam), ' ') != NULL)
|
|
commandParam = strNewFmt("\"%s\"", strZ(commandParam));
|
|
|
|
strCat(cmdOptionStr, commandParam);
|
|
}
|
|
|
|
strCatFmt(cmdOptionStr, "]");
|
|
}
|
|
|
|
// Loop though options and add the ones that are interesting
|
|
for (ConfigOption optionId = 0; optionId < CFG_OPTION_TOTAL; optionId++)
|
|
{
|
|
// Skip the option if not valid for this command. Generally only one command runs at a time, but sometimes
|
|
// commands are chained together (e.g. backup and expire) and the second command may not use all the options of
|
|
// the first command. Displaying them is harmless but might cause confusion.
|
|
if (!cfgOptionValid(optionId) || !cfgParseOptionValid(cfgCommand(), cfgCommandRole(), optionId))
|
|
continue;
|
|
|
|
// Loop through option indexes
|
|
unsigned int optionIdxTotal = cfgOptionGroup(optionId) ? cfgOptionGroupIdxTotal(cfgOptionGroupId(optionId)) : 1;
|
|
|
|
for (unsigned int optionIdx = 0; optionIdx < optionIdxTotal; optionIdx++)
|
|
{
|
|
// If option was negated
|
|
if (cfgOptionIdxNegate(optionId, optionIdx))
|
|
strCatFmt(cmdOptionStr, " --no-%s", cfgOptionIdxName(optionId, optionIdx));
|
|
// If option was reset
|
|
else if (cfgOptionIdxReset(optionId, optionIdx))
|
|
strCatFmt(cmdOptionStr, " --reset-%s", cfgOptionIdxName(optionId, optionIdx));
|
|
// Else not default
|
|
else if (cfgOptionIdxSource(optionId, optionIdx) != cfgSourceDefault)
|
|
{
|
|
// Don't show redacted options
|
|
if (cfgParseOptionSecure(optionId))
|
|
strCatFmt(cmdOptionStr, " --%s=<redacted>", cfgOptionIdxName(optionId, optionIdx));
|
|
// Output boolean option
|
|
else if (cfgParseOptionType(optionId) == cfgOptTypeBoolean)
|
|
strCatFmt(cmdOptionStr, " --%s", cfgOptionIdxName(optionId, optionIdx));
|
|
// Output other options
|
|
else
|
|
{
|
|
StringList *valueList = NULL;
|
|
|
|
// Generate the values of hash options
|
|
if (cfgParseOptionType(optionId) == cfgOptTypeHash)
|
|
{
|
|
valueList = strLstNew();
|
|
|
|
const KeyValue *optionKv = cfgOptionIdxKv(optionId, optionIdx);
|
|
const VariantList *keyList = kvKeyList(optionKv);
|
|
|
|
for (unsigned int keyIdx = 0; keyIdx < varLstSize(keyList); keyIdx++)
|
|
{
|
|
strLstAdd(
|
|
valueList,
|
|
strNewFmt(
|
|
"%s=%s", strZ(varStr(varLstGet(keyList, keyIdx))),
|
|
strZ(varStrForce(kvGet(optionKv, varLstGet(keyList, keyIdx))))));
|
|
}
|
|
}
|
|
// Generate values for list options
|
|
else if (cfgParseOptionType(optionId) == cfgOptTypeList)
|
|
{
|
|
valueList = strLstNewVarLst(cfgOptionIdxLst(optionId, optionIdx));
|
|
}
|
|
// Generate time value
|
|
else if (cfgParseOptionType(optionId) == cfgOptTypeTime)
|
|
{
|
|
valueList = strLstNew();
|
|
strLstAdd(
|
|
valueList, cvtDoubleToStr((double)cfgOptionIdxInt64(optionId, optionIdx) / MSEC_PER_SEC));
|
|
}
|
|
// Else only one value
|
|
else
|
|
{
|
|
valueList = strLstNew();
|
|
strLstAdd(valueList, varStrForce(cfgOptionIdx(optionId, optionIdx)));
|
|
}
|
|
|
|
// Output options and values
|
|
for (unsigned int valueListIdx = 0; valueListIdx < strLstSize(valueList); valueListIdx++)
|
|
{
|
|
const String *value = strLstGet(valueList, valueListIdx);
|
|
|
|
strCatFmt(cmdOptionStr, " --%s", cfgOptionIdxName(optionId, optionIdx));
|
|
|
|
if (strchr(strZ(value), ' ') != NULL)
|
|
value = strNewFmt("\"%s\"", strZ(value));
|
|
|
|
strCatFmt(cmdOptionStr, "=%s", strZ(value));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
MEM_CONTEXT_TEMP_END();
|
|
}
|
|
MEM_CONTEXT_END();
|
|
}
|
|
|
|
FUNCTION_TEST_RETURN(cmdOptionStr);
|
|
}
|
|
|
|
/**********************************************************************************************************************************/
|
|
void
|
|
cmdBegin(void)
|
|
{
|
|
FUNCTION_LOG_VOID(logLevelTrace);
|
|
|
|
ASSERT(cfgCommand() != cfgCmdNone);
|
|
|
|
// This is fairly expensive log message to generate so skip it if it won't be output
|
|
if (logAny(cfgLogLevelDefault()))
|
|
{
|
|
MEM_CONTEXT_TEMP_BEGIN()
|
|
{
|
|
// Basic info on command start
|
|
String *info = strNewFmt("%s command begin", strZ(cfgCommandRoleName()));
|
|
|
|
// Free the old option string if it exists. This is needed when more than one command is run in a row so an option
|
|
// string gets created for the new command.
|
|
strFree(cmdOptionStr);
|
|
cmdOptionStr = NULL;
|
|
|
|
// Add version and options
|
|
strCatFmt(info, " %s:%s", PROJECT_VERSION, strZ(cmdOption()));
|
|
|
|
LOG(cfgLogLevelDefault(), 0, strZ(info));
|
|
}
|
|
MEM_CONTEXT_TEMP_END();
|
|
}
|
|
|
|
FUNCTION_LOG_RETURN_VOID();
|
|
}
|
|
|
|
/**********************************************************************************************************************************/
|
|
void
|
|
cmdEnd(int code, const String *errorMessage)
|
|
{
|
|
FUNCTION_LOG_BEGIN(logLevelTrace);
|
|
FUNCTION_LOG_PARAM(INT, code);
|
|
FUNCTION_LOG_PARAM(STRING, errorMessage);
|
|
FUNCTION_LOG_END();
|
|
|
|
ASSERT(cfgCommand() != cfgCmdNone);
|
|
|
|
// Skip this log message if it won't be output. It's not too expensive but since we skipped cmdBegin(), may as well.
|
|
if (logAny(cfgLogLevelDefault()))
|
|
{
|
|
MEM_CONTEXT_TEMP_BEGIN()
|
|
{
|
|
// Output statistics if there are any
|
|
const KeyValue *statKv = statToKv();
|
|
|
|
if (varLstSize(kvKeyList(statKv)) > 0)
|
|
LOG_DETAIL_FMT("statistics: %s", strZ(jsonFromKv(statKv)));
|
|
|
|
// Basic info on command end
|
|
String *info = strNewFmt("%s command end: ", strZ(cfgCommandRoleName()));
|
|
|
|
if (errorMessage == NULL)
|
|
{
|
|
strCatZ(info, "completed successfully");
|
|
|
|
if (cfgOptionBool(cfgOptLogTimestamp))
|
|
strCatFmt(info, " (%" PRIu64 "ms)", timeMSec() - timeBegin);
|
|
}
|
|
else
|
|
strCat(info, errorMessage);
|
|
|
|
LOG(cfgLogLevelDefault(), 0, strZ(info));
|
|
}
|
|
MEM_CONTEXT_TEMP_END();
|
|
}
|
|
|
|
// Reset timeBegin in case there is another command following this one
|
|
timeBegin = timeMSec();
|
|
|
|
FUNCTION_LOG_RETURN_VOID();
|
|
}
|