RpcMethod.cc 5.64 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
/* <!-- copyright */
/*
 * aria2 - The high speed download utility
 *
 * Copyright (C) 2009 Tatsuhiro Tsujikawa
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
 */
/* copyright --> */
#include "RpcMethod.h"
#include "DownloadEngine.h"
#include "LogFactory.h"
#include "RecoverableException.h"
#include "message.h"
#include "OptionParser.h"
#include "OptionHandler.h"
#include "Option.h"
#include "array_fun.h"
#include "download_helper.h"
#include "RpcRequest.h"
#include "RpcResponse.h"
#include "prefs.h"
#include "fmt.h"
#include "DlAbortEx.h"
#include "a2functional.h"
51
#include "util.h"
52 53 54 55 56 57 58 59 60 61 62

namespace aria2 {

namespace rpc {

RpcMethod::RpcMethod()
  : optionParser_(OptionParser::getInstance())
{}

RpcMethod::~RpcMethod() {}

63
std::unique_ptr<ValueBase> RpcMethod::createErrorResponse
64 65
(const Exception& e, const RpcRequest& req)
{
66
  auto params = Dict::g();
67 68
  params->put((req.jsonRpc ? "code" : "faultCode"), Integer::g(1));
  params->put((req.jsonRpc ? "message" : "faultString"), std::string(e.what()));
69
  return std::move(params);
70 71
}

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
void RpcMethod::authorize(RpcRequest& req, DownloadEngine* e)
{
  std::string token;
  // We always treat first parameter as token if it is string and
  // starts with "token:" and remove it from parameter list, so that
  // we don't have to add conditionals to all RPCMethod
  // implementations.
  if(req.params && !req.params->empty()) {
    auto t = downcast<String>(req.params->get(0));
    if(t) {
      if(util::startsWith(t->s(), "token:")) {
        token = t->s().substr(6);
        req.params->pop_front();
      }
    }
  }
88
  if (!e || !e->validateToken(token)) {
89
    throw DL_ABORT_EX("Unauthorized");
90 91 92
  }
}

93
RpcResponse RpcMethod::execute(RpcRequest req, DownloadEngine* e)
94
{
95
  auto authorized = RpcResponse::NOTAUTHORIZED;
96
  try {
97
    authorize(req, e);
98
    authorized = RpcResponse::AUTHORIZED;
99
    auto r = process(req, e);
100
    return RpcResponse(0, authorized, std::move(r), std::move(req.id));
101 102
  } catch(RecoverableException& ex) {
    A2_LOG_DEBUG_EX(EX_EXCEPTION_CAUGHT, ex);
103 104
    return RpcResponse(1, authorized, createErrorResponse(ex, req),
                       std::move(req.id));
105 106 107 108 109 110 111 112 113
  }
}

namespace {
template<typename InputIterator, typename Pred>
void gatherOption
(InputIterator first, InputIterator last,
 Pred pred,
 Option* option,
114
 const std::shared_ptr<OptionParser>& optionParser)
115 116 117
{
  for(; first != last; ++first) {
    const std::string& optionName = (*first).first;
118
    PrefPtr pref = option::k2p(optionName);
119
    const OptionHandler* handler = optionParser->find(pref);
120
    if(!handler || !pred(handler)) {
121 122
      // Just ignore the unacceptable options in this context.
      continue;
123 124 125 126 127 128 129 130
    }
    const String* opval = downcast<String>((*first).second);
    if(opval) {
      handler->parse(*option, opval->s());
    } else if(handler->getCumulative()) {
      // header and index-out option can take array as value
      const List* oplist = downcast<List>((*first).second);
      if(oplist) {
131 132
        for(auto & elem : *oplist) {
          const String* opval = downcast<String>(elem);
133 134 135 136 137 138
          if(opval) {
            handler->parse(*option, opval->s());
          }
        }
      }
    }
139
  }
140 141 142 143 144 145 146
}
} // namespace

void RpcMethod::gatherRequestOption(Option* option, const Dict* optionsDict)
{
  if(optionsDict) {
    gatherOption(optionsDict->begin(), optionsDict->end(),
147
                 std::mem_fn(&OptionHandler::getInitialOption),
148 149 150 151 152 153 154 155
                 option, optionParser_);
  }
}

void RpcMethod::gatherChangeableOption(Option* option, const Dict* optionsDict)
{
  if(optionsDict) {
    gatherOption(optionsDict->begin(), optionsDict->end(),
156
                 std::mem_fn(&OptionHandler::getChangeOption),
157 158 159 160 161 162 163 164 165 166
                 option, optionParser_);
  }
}

void RpcMethod::gatherChangeableOptionForReserved
(Option* option,
 const Dict* optionsDict)
{
  if(optionsDict) {
    gatherOption(optionsDict->begin(), optionsDict->end(),
167
                 std::mem_fn(&OptionHandler::getChangeOptionForReserved),
168 169 170 171 172 173 174 175 176
                 option, optionParser_);
  }
}

void RpcMethod::gatherChangeableGlobalOption
(Option* option, const Dict* optionsDict)
{
  if(optionsDict) {
    gatherOption(optionsDict->begin(), optionsDict->end(),
177
                 std::mem_fn(&OptionHandler::getChangeGlobalOption),
178 179 180 181 182 183 184
                 option, optionParser_);
  }
}

} // namespace rpc

} // namespace aria2