controller.cpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2025 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
 *
 * You should have received copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */
 
#include "ndn-cxx/mgmt/nfd/controller.hpp"
#include "ndn-cxx/face.hpp"
#include "ndn-cxx/security/key-chain.hpp"
 
#include <boost/lexical_cast.hpp>
 
namespace ndn::nfd {
 
Controller::Controller(Face& face, KeyChain& keyChain, security::Validator& validator)
  : m_face(face)
  , m_keyChain(keyChain)
  , m_validator(validator)
  , m_signer(keyChain)
{
}
 
Controller::~Controller()
{
  for (const auto& sp : m_fetchers) {
    sp->stop();
  }
}
 
void
Controller::sendCommandRequest(Interest& interest,
                               const security::SigningInfo& signingInfo,
                               ResponseParametersValidator checkResponse,
                               CommandSuccessCallback onSuccess,
                               const CommandFailureCallback& onFailure)
{
  BOOST_ASSERT(checkResponse);
 
  m_signer.makeSignedInterest(interest, signingInfo);
 
  m_face.expressInterest(interest,
    [=, check = std::move(checkResponse), success = std::move(onSuccess)] (const auto&, const Data& d) {
      processCommandResponse(d, std::move(check), std::move(success), onFailure);
    },
    [onFailure] (const Interest&, const lp::Nack& nack) {
      if (onFailure)
        onFailure(ControlResponse(Controller::ERROR_NACK,
                                  "received Nack: " + boost::lexical_cast<std::string>(nack.getReason())));
    },
    [onFailure] (const Interest&) {
      if (onFailure)
        onFailure(ControlResponse(Controller::ERROR_TIMEOUT, "request timed out"));
    });
}
 
void
Controller::processCommandResponse(const Data& data,
                                   ResponseParametersValidator checkResponse,
                                   CommandSuccessCallback onSuccess,
                                   const CommandFailureCallback& onFailure)
{
  m_validator.validate(data,
    [check = std::move(checkResponse), success = std::move(onSuccess), onFailure] (const Data& d) {
      processValidatedCommandResponse(d, check, success, onFailure);
    },
    [onFailure] (const Data&, const auto& error) {
      if (onFailure)
        onFailure(ControlResponse(ERROR_VALIDATION, boost::lexical_cast<std::string>(error)));
    }
  );
}
 
void
Controller::processValidatedCommandResponse(const Data& data,
                                            const ResponseParametersValidator& checkResponse,
                                            const CommandSuccessCallback& onSuccess,
                                            const CommandFailureCallback& onFailure)
{
  ControlResponse response;
  try {
    response.wireDecode(data.getContent().blockFromValue());
  }
  catch (const tlv::Error& e) {
    if (onFailure)
      onFailure(ControlResponse(ERROR_SERVER, "ControlResponse decoding failure: "s + e.what()));
    return;
  }
 
  if (response.getCode() >= ERROR_LBOUND) {
    if (onFailure)
      onFailure(response);
    return;
  }
 
  ControlParameters parameters;
  try {
    parameters.wireDecode(response.getBody());
  }
  catch (const tlv::Error& e) {
    if (onFailure)
      onFailure(ControlResponse(ERROR_SERVER, "ControlParameters decoding failure: "s + e.what()));
    return;
  }
 
  try {
    checkResponse(parameters);
  }
  catch (const std::invalid_argument& e) {
    if (onFailure)
      onFailure(ControlResponse(ERROR_SERVER, "Invalid response: "s + e.what()));
    return;
  }
 
  if (onSuccess)
    onSuccess(parameters);
}
 
void
Controller::fetchDataset(const Name& prefix,
                         const std::function<void(ConstBufferPtr)>& processResponse,
                         const DatasetFailureCallback& onFailure,
                         const CommandOptions& options)
{
  SegmentFetcher::Options fetcherOptions;
  fetcherOptions.maxTimeout = options.getTimeout();
 
  auto fetcher = SegmentFetcher::start(m_face, Interest(prefix), m_validator, fetcherOptions);
  fetcher->onComplete.connect(processResponse);
  if (onFailure) {
    fetcher->onError.connect([onFailure] (uint32_t code, const std::string& msg) {
      processDatasetFetchError(onFailure, code, msg);
    });
  }
 
  auto it = m_fetchers.insert(fetcher).first;
  fetcher->onComplete.connect([this, it] (auto&&...) { m_fetchers.erase(it); });
  fetcher->onError.connect([this, it] (auto&&...) { m_fetchers.erase(it); });
}
 
void
Controller::processDatasetFetchError(const DatasetFailureCallback& onFailure,
                                     uint32_t code, std::string msg)
{
  BOOST_ASSERT(onFailure);
 
  switch (static_cast<SegmentFetcher::ErrorCode>(code)) {
    // It's intentional to cast to SegmentFetcher::ErrorCode and to not have a 'default' clause.
    // This forces the switch statement to handle every defined SegmentFetcher::ErrorCode,
    // and breaks compilation if it does not.
    case SegmentFetcher::ErrorCode::INTEREST_TIMEOUT:
      onFailure(ERROR_TIMEOUT, msg);
      break;
    case SegmentFetcher::ErrorCode::DATA_HAS_NO_SEGMENT:
    case SegmentFetcher::ErrorCode::FINALBLOCKID_NOT_SEGMENT:
      onFailure(ERROR_SERVER, msg);
      break;
    case SegmentFetcher::ErrorCode::SEGMENT_VALIDATION_FAIL:
      // TODO: When SegmentFetcher exposes validator error code, Controller::ERROR_VALIDATION
      //       should be replaced with a range that corresponds to validator error codes.
      onFailure(ERROR_VALIDATION, msg);
      break;
    case SegmentFetcher::ErrorCode::NACK_ERROR:
      onFailure(ERROR_NACK, msg);
      break;
  }
}
 
} // namespace ndn::nfd