RpcMethod.cc 6.79 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

namespace aria2 {

namespace rpc {

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

59
RpcMethod::~RpcMethod() = default;
60

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

70 71 72 73 74 75 76
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.
77
  if (req.params && !req.params->empty()) {
78
    auto t = downcast<String>(req.params->get(0));
79 80
    if (t) {
      if (util::startsWith(t->s(), "token:")) {
81 82 83 84 85
        token = t->s().substr(6);
        req.params->pop_front();
      }
    }
  }
86
  if (!e || !e->validateToken(token)) {
87
    throw DL_ABORT_EX("Unauthorized");
88 89 90
  }
}

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

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

void RpcMethod::gatherRequestOption(Option* option, const Dict* optionsDict)
{
143
  if (optionsDict) {
144
    gatherOption(optionsDict->begin(), optionsDict->end(),
145 146
                 std::mem_fn(&OptionHandler::getInitialOption), option,
                 optionParser_);
147 148 149
  }
}

150 151
void RpcMethod::gatherChangeableOption(Option* option, Option* pendingOption,
                                       const Dict* optionsDict)
152
{
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
  if (!optionsDict) {
    return;
  }

  auto first = optionsDict->begin();
  auto last = optionsDict->end();

  for (; first != last; ++first) {
    const auto& optionName = (*first).first;
    auto pref = option::k2p(optionName);
    auto handler = optionParser_->find(pref);
    if (!handler) {
      // Just ignore the unacceptable options in this context.
      continue;
    }

    Option* dst = nullptr;
    if (handler->getChangeOption()) {
      dst = option;
    }
    else if (handler->getChangeOptionForReserved()) {
      dst = pendingOption;
    }

    if (!dst) {
      continue;
    }

    const auto opval = downcast<String>((*first).second);
    if (opval) {
      handler->parse(*dst, opval->s());
    }
    else if (handler->getCumulative()) {
      // header and index-out option can take array as value
      const auto oplist = downcast<List>((*first).second);
      if (oplist) {
        for (auto& elem : *oplist) {
          const auto opval = downcast<String>(elem);
          if (opval) {
            handler->parse(*dst, opval->s());
          }
        }
      }
    }
197 198 199
  }
}

200 201
void RpcMethod::gatherChangeableOptionForReserved(Option* option,
                                                  const Dict* optionsDict)
202
{
203
  if (optionsDict) {
204
    gatherOption(optionsDict->begin(), optionsDict->end(),
205
                 std::mem_fn(&OptionHandler::getChangeOptionForReserved),
206 207 208 209
                 option, optionParser_);
  }
}

210 211
void RpcMethod::gatherChangeableGlobalOption(Option* option,
                                             const Dict* optionsDict)
212
{
213
  if (optionsDict) {
214
    gatherOption(optionsDict->begin(), optionsDict->end(),
215 216
                 std::mem_fn(&OptionHandler::getChangeGlobalOption), option,
                 optionParser_);
217 218 219 220 221 222
  }
}

} // namespace rpc

} // namespace aria2