Renamed classes in abstract layer of RPC service from XmlRpc* to Rpc*.

Now JSON-RPC is available by default regardless of XML library.
XML-RPC becomes available when XML library is available.

1 files changed, 213 insertions, 0 deletions

diff --git a/src/RpcMethod.cc b/src/RpcMethod.cc
new file mode 100644
index 00000000..96d05461
--- /dev/null
+++ b/src/RpcMethod.cc
@@ -0,0 +1,213 @@
+/* <!-- 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"
+
+namespace aria2 {
+
+namespace rpc {
+
+RpcMethod::RpcMethod()
+  : optionParser_(OptionParser::getInstance()),
+    jsonRpc_(false)
+{}
+
+RpcMethod::~RpcMethod() {}
+
+SharedHandle<ValueBase> RpcMethod::createErrorResponse
+(const Exception& e)
+{
+  SharedHandle<Dict> params = Dict::g();
+  params->put((jsonRpc_ ? "code" : "faultCode"), Integer::g(1));
+  params->put((jsonRpc_ ? "message" : "faultString"), std::string(e.what()));
+  return params;
+}
+
+RpcResponse RpcMethod::execute
+(const RpcRequest& req, DownloadEngine* e)
+{
+  try {
+    return RpcResponse(0, process(req, e), req.id);
+  } catch(RecoverableException& e) {
+    A2_LOG_DEBUG_EX(EX_EXCEPTION_CAUGHT, e);
+    return RpcResponse(1, createErrorResponse(e), req.id);
+  }
+}
+
+namespace {
+template<typename InputIterator>
+void gatherOption
+(InputIterator first, InputIterator last,
+ const std::set<std::string>& allowedOptions,
+ const SharedHandle<Option>& option,
+ const SharedHandle<OptionParser>& optionParser)
+{
+  for(; first != last; ++first) {
+    const std::string& optionName = (*first).first;
+    if(allowedOptions.count(optionName) == 0) {
+      throw DL_ABORT_EX
+        (fmt("%s option cannot be used in this context.",
+             optionName.c_str()));
+    } else {
+      SharedHandle<OptionHandler> optionHandler =
+        optionParser->findByName(optionName);
+      if(!optionHandler) {
+        throw DL_ABORT_EX
+          (fmt("We don't know how to deal with %s option",
+               optionName.c_str()));
+      }
+      const String* opval = asString((*first).second);
+      if(opval) {
+        optionHandler->parse(*option.get(), opval->s());
+      } else {
+        // header and index-out option can take array as value
+        const List* oplist = asList((*first).second);
+        if(oplist &&
+           (optionName == PREF_HEADER || optionName == PREF_INDEX_OUT)) {
+          for(List::ValueType::const_iterator argiter = oplist->begin(),
+                eoi = oplist->end(); argiter != eoi; ++argiter) {
+            const String* opval = asString(*argiter);
+            if(opval) {
+              optionHandler->parse(*option.get(), opval->s());
+            }
+          }
+        }
+      }
+    }
+  }  
+}
+} // namespace
+
+void RpcMethod::gatherRequestOption
+(const SharedHandle<Option>& option, const Dict* optionsDict)
+{
+  if(optionsDict) {
+    gatherOption(optionsDict->begin(), optionsDict->end(),
+                 listRequestOptions(),
+                 option, optionParser_);
+  }
+}
+
+namespace {
+// Copy option in the range [optNameFirst, optNameLast) from src to
+// dest.
+template<typename InputIterator>
+void applyOption(InputIterator optNameFirst,
+                 InputIterator optNameLast,
+                 Option* dest,
+                 Option* src)
+{
+  for(; optNameFirst != optNameLast; ++optNameFirst) {
+    if(src->defined(*optNameFirst)) {
+      dest->put(*optNameFirst, src->get(*optNameFirst));
+    }
+  }
+}
+} // namespace
+
+const std::set<std::string>& listChangeableOptions()
+{
+  static const std::string OPTIONS[] = {
+    PREF_BT_MAX_PEERS,
+    PREF_BT_REQUEST_PEER_SPEED_LIMIT,
+    PREF_MAX_DOWNLOAD_LIMIT,
+    PREF_MAX_UPLOAD_LIMIT
+  };
+  static std::set<std::string> options(vbegin(OPTIONS), vend(OPTIONS));
+  return options;
+}
+
+void RpcMethod::gatherChangeableOption
+(const SharedHandle<Option>& option, const Dict* optionsDict)
+{
+  if(optionsDict) {
+    gatherOption(optionsDict->begin(), optionsDict->end(),
+                 listChangeableOptions(),
+                 option, optionParser_);
+  }
+}
+
+void RpcMethod::applyChangeableOption(Option* dest, Option* src) const
+{
+  applyOption(listChangeableOptions().begin(), listChangeableOptions().end(),
+              dest, src);
+}
+
+const std::set<std::string>& listChangeableGlobalOptions()
+{
+  static const std::string OPTIONS[] = {
+    PREF_MAX_OVERALL_UPLOAD_LIMIT,
+    PREF_MAX_OVERALL_DOWNLOAD_LIMIT,
+    PREF_MAX_CONCURRENT_DOWNLOADS,
+    PREF_LOG,
+    PREF_LOG_LEVEL
+  };
+  static std::set<std::string> options(vbegin(OPTIONS), vend(OPTIONS));
+  return options;
+}
+
+void RpcMethod::gatherChangeableGlobalOption
+(const SharedHandle<Option>& option, const Dict* optionsDict)
+{
+  if(optionsDict) {
+    gatherOption(optionsDict->begin(), optionsDict->end(),
+                 listChangeableGlobalOptions(),
+                 option, optionParser_);
+  }
+}
+
+void RpcMethod::applyChangeableGlobalOption(Option* dest, Option* src) const
+{
+  applyOption(listChangeableGlobalOptions().begin(),
+              listChangeableGlobalOptions().end(),
+              dest, src);
+}
+
+} // namespace rpc
+
+} // namespace aria2