mirror of
https://github.com/valitydev/osquery-1.git
synced 2024-11-07 18:08:53 +00:00
109 lines
3.3 KiB
C++
109 lines
3.3 KiB
C++
// Copyright 2004-present Facebook. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include <boost/make_shared.hpp>
|
|
|
|
#define STRIP_FLAG_HELP 1
|
|
#include <gflags/gflags.h>
|
|
|
|
#include "osquery/registry.h"
|
|
|
|
namespace osquery {
|
|
|
|
typedef std::pair<std::string, std::string> FlagDetail;
|
|
|
|
/**
|
|
* @brief A small tracking wrapper for options, binary flags.
|
|
*
|
|
* The osquery-specific gflags-like options define macro `DEFINE_osquery_flag`
|
|
* uses a Flag instance to track the options data.
|
|
*/
|
|
class Flag {
|
|
public:
|
|
/*
|
|
* @brief the instance accessor, but also can register flag data.
|
|
*
|
|
* @param name The 'name' or the options switch data.
|
|
* @param value The default value for this flag.
|
|
* @param desc The description printed to the screen during help.
|
|
*/
|
|
static Flag& get(const std::string& name = "",
|
|
const std::string& value = "",
|
|
const std::string& desc = "",
|
|
bool shell_only = false) {
|
|
static Flag f;
|
|
if (name != "") {
|
|
f.add(name, value, desc, shell_only);
|
|
}
|
|
return f;
|
|
}
|
|
|
|
/*
|
|
* @brief Wrapper by the Flag::get.
|
|
*
|
|
* @param name The 'name' or the options switch data.
|
|
* @param value The default value for this flag.
|
|
* @param desc The description printed to the screen during help.
|
|
* @param shell_only Restrict this flag to the shell.
|
|
*/
|
|
void add(const std::string& name,
|
|
const std::string& value,
|
|
const std::string& desc,
|
|
bool shell_only) {
|
|
if (!shell_only) {
|
|
flags_.insert(std::make_pair(name, std::make_pair(value, desc)));
|
|
} else {
|
|
shell_flags_.insert(std::make_pair(name, std::make_pair(value, desc)));
|
|
}
|
|
}
|
|
|
|
private:
|
|
/// Keep the ctor private, for accessing through `add` wrapper.
|
|
Flag() {}
|
|
|
|
public:
|
|
/// The public flags instance, usable when parsing `--help`.
|
|
std::map<std::string, FlagDetail> flags() { return flags_; }
|
|
/// The public flags instance, usable when parsing `--help` for the shell.
|
|
std::map<std::string, FlagDetail> shellFlags() { return shell_flags_; }
|
|
static void print_flags(const std::map<std::string, FlagDetail> flags) {
|
|
for (const auto& flag : flags) {
|
|
fprintf(stdout,
|
|
" --%s, --%s=VALUE\n %s (default: %s)\n",
|
|
flag.first.c_str(),
|
|
flag.first.c_str(),
|
|
flag.second.second.c_str(),
|
|
flag.second.first.c_str());
|
|
}
|
|
}
|
|
|
|
private:
|
|
/// The private simple map of name to value/desc flag data.
|
|
std::map<std::string, FlagDetail> flags_;
|
|
/// The private simple map of name to value/desc shell-only flag data.
|
|
std::map<std::string, FlagDetail> shell_flags_;
|
|
};
|
|
}
|
|
|
|
/*
|
|
* @brief Replace gflags' `DEFINE_type` macros to track osquery flags.
|
|
*
|
|
* @param type The `_type` symbol portion of the gflags define.
|
|
* @param name The name symbol passed to gflags' `DEFINE_type`.
|
|
* @param value The default value, use a C++ literal.
|
|
* @param desc A string literal used for help display.
|
|
*/
|
|
#define DEFINE_osquery_flag(type, name, value, desc) \
|
|
DEFINE_##type(name, value, desc); \
|
|
namespace flag_##name { \
|
|
Flag flag = Flag::get(#name, #value, #desc); \
|
|
}
|
|
|
|
/// Wrapper to bypass osquery help output
|
|
#define DEFINE_shell_flag(type, name, value, desc) \
|
|
DEFINE_##type(name, value, desc); \
|
|
namespace flag_##name { \
|
|
Flag flag = Flag::get(#name, #value, #desc, true); \
|
|
} \
|