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, 586 insertions, 0 deletions

diff --git a/src/RpcMethodImpl.h b/src/RpcMethodImpl.h
new file mode 100644
index 00000000..b83c4dfe
--- /dev/null
+++ b/src/RpcMethodImpl.h
@@ -0,0 +1,586 @@
+/* <!-- 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 --> */
+#ifndef D_RPC_METHOD_IMPL_H
+#define D_RPC_METHOD_IMPL_H
+
+#include "RpcMethod.h"
+
+#include <cassert>
+#include <deque>
+#include <algorithm>
+
+#include "RpcRequest.h"
+#include "ValueBase.h"
+#include "TorrentAttribute.h"
+#include "DlAbortEx.h"
+
+namespace aria2 {
+
+struct DownloadResult;
+class RequestGroup;
+
+namespace rpc {
+
+template<typename OutputIterator>
+void toStringList(OutputIterator out, const List* src)
+{
+  if(!src) {
+    return;
+  }
+  for(List::ValueType::const_iterator i = src->begin(), eoi = src->end();
+      i != eoi; ++i) {
+    const String* s = asString(*i);
+    if(s) {
+      *out++ = s->s();
+    }
+  }
+}
+
+class AddUriRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.addUri";
+    return methodName;
+  }
+};
+
+class RemoveRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.remove";
+    return methodName;
+  }
+};
+
+class ForceRemoveRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.forceRemove";
+    return methodName;
+  }
+};
+
+class PauseRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.pause";
+    return methodName;
+  }
+};
+
+class ForcePauseRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.forcePause";
+    return methodName;
+  }
+};
+
+class PauseAllRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.pauseAll";
+    return methodName;
+  }
+};
+
+class ForcePauseAllRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.forcePauseAll";
+    return methodName;
+  }
+};
+
+class UnpauseRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.unpause";
+    return methodName;
+  }
+};
+
+class UnpauseAllRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.unpauseAll";
+    return methodName;
+  }
+};
+
+#ifdef ENABLE_BITTORRENT
+class AddTorrentRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.addTorrent";
+    return methodName;
+  }
+};
+#endif // ENABLE_BITTORRENT
+
+#ifdef ENABLE_METALINK
+class AddMetalinkRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.addMetalink";
+    return methodName;
+  }
+};
+#endif // ENABLE_METALINK
+
+class PurgeDownloadResultRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.purgeDownloadResult";
+    return methodName;
+  }
+};
+
+class RemoveDownloadResultRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.removeDownloadResult";
+    return methodName;
+  }
+};
+
+class GetUrisRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.getUris";
+    return methodName;
+  }
+};
+
+class GetFilesRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.getFiles";
+    return methodName;
+  }
+};
+
+#ifdef ENABLE_BITTORRENT
+class GetPeersRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.getPeers";
+    return methodName;
+  }
+};
+#endif // ENABLE_BITTORRENT
+
+class GetServersRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.getServers";
+    return methodName;
+  }
+};
+
+class TellStatusRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.tellStatus";
+    return methodName;
+  }
+};
+
+class TellActiveRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.tellActive";
+    return methodName;
+  }
+};
+
+template<typename T>
+class AbstractPaginationRpcMethod:public RpcMethod {
+private:
+  template<typename InputIterator>
+  std::pair<InputIterator, InputIterator>
+  getPaginationRange
+  (ssize_t offset, size_t num, InputIterator first, InputIterator last)
+  {
+    size_t size = std::distance(first, last);
+    if(offset < 0) {
+      ssize_t tempoffset = offset+size;
+      if(tempoffset < 0) {
+        return std::make_pair(last, last);
+      }
+      offset = tempoffset-(num-1);
+      if(offset < 0) {
+        offset = 0;
+        num = tempoffset+1;
+      }
+    } else if(size <= (size_t)offset) {
+      return std::make_pair(last, last);
+    }
+    size_t lastDistance;
+    if(size < offset+num) {
+      lastDistance = size;
+    } else {
+      lastDistance = offset+num;
+    }
+    last = first;
+    std::advance(first, offset);
+    std::advance(last, lastDistance);
+    return std::make_pair(first, last);
+  }
+
+  void checkPaginationParams(const SharedHandle<List>& params) const
+  {
+    if(params->size() < 2) {
+      throw DL_ABORT_EX("Invalid argument. Specify offset and num in integer.");
+    }
+    const Integer* p1 = asInteger(params->get(0));
+    const Integer* p2 = asInteger(params->get(1));
+    if(!p1 || !p2 || p2->i() < 0) {
+      throw DL_ABORT_EX("Invalid argument. Specify offset and num in integer.");
+    }
+  }
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e)
+  {
+    const SharedHandle<List>& params = req.params;
+    checkPaginationParams(params);
+    ssize_t offset = req.getIntegerParam(0)->i();
+    size_t num = req.getIntegerParam(1)->i();
+    const List* keysParam = req.getListParam(2);
+    std::vector<std::string> keys;
+    toStringList(std::back_inserter(keys), keysParam);
+    const std::deque<SharedHandle<T> >& items = getItems(e);
+    std::pair<typename std::deque<SharedHandle<T> >::const_iterator,
+      typename std::deque<SharedHandle<T> >::const_iterator> range =
+      getPaginationRange(offset, num, items.begin(), items.end());
+    SharedHandle<List> list = List::g();
+    for(; range.first != range.second; ++range.first) {
+      SharedHandle<Dict> entryDict = Dict::g();
+      createEntry(entryDict, *range.first, e, keys);
+      list->append(entryDict);
+    }
+    if(offset < 0) {
+      std::reverse(list->begin(), list->end());
+    }
+    return list;
+  }
+
+  virtual const std::deque<SharedHandle<T> >&
+  getItems(DownloadEngine* e) const = 0;
+
+  virtual void createEntry
+  (const SharedHandle<Dict>& entryDict,
+   const SharedHandle<T>& item,
+   DownloadEngine* e,
+   const std::vector<std::string>& keys) const = 0;
+};
+
+class TellWaitingRpcMethod:
+    public AbstractPaginationRpcMethod<RequestGroup> {
+protected:
+  virtual const std::deque<SharedHandle<RequestGroup> >&
+  getItems(DownloadEngine* e) const;
+
+  virtual void createEntry
+  (const SharedHandle<Dict>& entryDict,
+   const SharedHandle<RequestGroup>& item,
+   DownloadEngine* e,
+   const std::vector<std::string>& keys) const;
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.tellWaiting";
+    return methodName;
+  }
+};
+
+class TellStoppedRpcMethod:
+    public AbstractPaginationRpcMethod<DownloadResult> {
+protected:
+   virtual const std::deque<SharedHandle<DownloadResult> >&
+   getItems(DownloadEngine* e) const;
+
+  virtual void createEntry
+  (const SharedHandle<Dict>& entryDict,
+   const SharedHandle<DownloadResult>& item,
+   DownloadEngine* e,
+   const std::vector<std::string>& keys) const;
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.tellStopped";
+    return methodName;
+  }
+};
+
+class ChangeOptionRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.changeOption";
+    return methodName;
+  }
+};
+
+class ChangeGlobalOptionRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.changeGlobalOption";
+    return methodName;
+  }
+};
+
+class GetVersionRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.getVersion";
+    return methodName;
+  }
+};
+
+class GetOptionRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.getOption";
+    return methodName;
+  }
+};
+
+class GetGlobalOptionRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.getGlobalOption";
+    return methodName;
+  }
+};
+
+class ChangePositionRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.changePosition";
+    return methodName;
+  }
+};
+
+class ChangeUriRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.changeUri";
+    return methodName;
+  }
+};
+
+class GetSessionInfoRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.getSessionInfo";
+    return methodName;
+  }
+};
+
+class ShutdownRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.shutdown";
+    return methodName;
+  }
+};
+
+class ForceShutdownRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "aria2.forceShutdown";
+    return methodName;
+  }
+};
+
+class SystemMulticallRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+public:
+  static const std::string& getMethodName()
+  {
+    static std::string methodName = "system.multicall";
+    return methodName;
+  }
+};
+
+class NoSuchMethodRpcMethod:public RpcMethod {
+protected:
+  virtual SharedHandle<ValueBase> process
+  (const RpcRequest& req, DownloadEngine* e);
+};
+
+// Helper function to store data to entryDict from ds. This function
+// is used by tellStatus method.
+void gatherStoppedDownload
+(const SharedHandle<Dict>& entryDict, const SharedHandle<DownloadResult>& ds,
+ const std::vector<std::string>& keys);
+
+// Helper function to store data to entryDict from group. This
+// function is used by tellStatus/tellActive/tellWaiting method
+void gatherProgressCommon
+(const SharedHandle<Dict>& entryDict, const SharedHandle<RequestGroup>& group,
+ const std::vector<std::string>& keys);
+
+#ifdef ENABLE_BITTORRENT
+// Helper function to store BitTorrent metadata from torrentAttrs.
+void gatherBitTorrentMetadata
+(const SharedHandle<Dict>& btDict,
+ const SharedHandle<TorrentAttribute>& torrentAttrs);
+#endif // ENABLE_BITTORRENT
+
+} // namespace rpc
+
+} // namespace aria2
+
+#endif // D_RPC_METHOD_IMPL_H