blob: 8d3d45cd3ea683f5383b376fb6a7abf132ea946e [file] [log] [blame]
// Copyright 2015 The Weave Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <map>
#include <memory>
#include <set>
#include <string>
#include <vector>
#include <base/macros.h>
#include <weave/error.h>
#include "src/commands/command_definition.h"
namespace base {
class Value;
class DictionaryValue;
} // namespace base
namespace weave {
class ObjectSchema;
// CommandDictionary is a wrapper around a map of command name and the
// corresponding command definition schema. The command name (the key in
// the map) is a compound name in a form of "package_name.command_name",
// where "package_name" is a name of command package such as "base", "printers",
// and others. So the full command name could be "base.reboot", for example.
class CommandDictionary final {
CommandDictionary() = default;
// Loads command definitions from a JSON object. This is done at the daemon
// startup and whenever a device daemon decides to update its command list.
// |json| is a JSON dictionary that describes the complete commands. Optional
// |base_commands| parameter specifies the definition of standard GCD commands
// for parameter schema validation. Can be set to nullptr if no validation is
// needed. Returns false on failure and |error| provides additional error
// information when provided.
bool LoadCommands(const base::DictionaryValue& json,
const CommandDictionary* base_commands,
ErrorPtr* error);
// Converts all the command definitions to a JSON object for CDD/Device
// draft.
// |filter| is a predicate used to filter out the command definitions to
// be returned by this method. Only command definitions for which the
// predicate returns true will be included in the resulting JSON.
// |full_schema| specifies whether full command definitions must be generated
// (true) for CDD or only overrides from the base schema (false).
// Returns empty unique_ptr in case of an error and fills in the additional
// error details in |error|.
std::unique_ptr<base::DictionaryValue> GetCommandsAsJson(
const std::function<bool(const CommandDefinition*)>& filter,
bool full_schema,
ErrorPtr* error) const;
// Returns the number of command definitions in the dictionary.
size_t GetSize() const { return definitions_.size(); }
// Checks if the dictionary has no command definitions.
bool IsEmpty() const { return definitions_.empty(); }
// Remove all the command definitions from the dictionary.
void Clear();
// Finds a definition for the given command.
const CommandDefinition* FindCommand(const std::string& command_name) const;
CommandDefinition* FindCommand(const std::string& command_name);
using CommandMap = std::map<std::string, std::unique_ptr<CommandDefinition>>;
std::unique_ptr<ObjectSchema> BuildObjectSchema(
const base::DictionaryValue* command_def_json,
const char* property_name,
const ObjectSchema* base_def,
const std::string& command_name,
ErrorPtr* error);
CommandMap definitions_; // List of all available command definitions.
} // namespace weave