diff --git a/ChangeLog b/ChangeLog index 6ad181ff..b36a9446 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,23 @@ +2010-09-19 Tatsuhiro Tsujikawa + + Added keys parameter to aria2.tellStatus, aria2.tellActive, + aria2.tellWaiting and aria2.tellStopped XML-RPC method. 'keys' is + array of string. If it is specified, the response contains only + keys in 'keys' array. If 'keys' is empty or not specified, the + response contains all keys. This is useful when you just want + specific keys and avoid unnecessary transfers. For example, + *aria2.tellStatus*("1", ["gid", "status"]) returns 'gid' and + 'status' key. Made get*Param() functions XmlRpcRequest's + methods and changed portions of the code that were affected by + this change. + * doc/aria2c.1.txt + * src/Makefile.am + * src/XmlRpcMethodImpl.cc + * src/XmlRpcMethodImpl.h + * src/XmlRpcRequest.cc + * src/XmlRpcRequest.h + * test/XmlRpcMethodTest.cc + 2010-09-15 Tatsuhiro Tsujikawa Release 1.10.3 diff --git a/doc/aria2c.1 b/doc/aria2c.1 index 26e25bd2..59b8cc15 100644 --- a/doc/aria2c.1 +++ b/doc/aria2c.1 @@ -2,12 +2,12 @@ .\" Title: aria2c .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 09/15/2010 +.\" Date: 09/19/2010 .\" Manual: Aria2 Manual .\" Source: Aria2 1.10.3 .\" Language: English .\" -.TH "ARIA2C" "1" "09/15/2010" "Aria2 1\&.10\&.3" "Aria2 Manual" +.TH "ARIA2C" "1" "09/19/2010" "Aria2 1\&.10\&.3" "Aria2 Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -2858,9 +2858,9 @@ This method changes the status of the download denoted by \fIgid\fR from "paused .sp This method is equal to calling \fBaria2\&.unpause\fR for every active/waiting download\&. This methods returns "OK" for success\&. .sp -\fBaria2\&.tellStatus\fR \fIgid\fR +\fBaria2\&.tellStatus\fR \fIgid[, keys]\fR .sp -This method returns download progress of the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. The response is of type struct and it contains following keys\&. The value type is string\&. +This method returns download progress of the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. \fIkeys\fR is array of string\&. If it is specified, the response contains only keys in \fIkeys\fR array\&. If \fIkeys\fR is empty or not specified, the response contains all keys\&. This is useful when you just want specific keys and avoid unnecessary transfers\&. For example, \fBaria2\&.tellStatus\fR("1", ["gid", "status"]) returns \fIgid\fR and \fIstatus\fR key\&. The response is of type struct and it contains following keys\&. The value type is string\&. .PP gid .RS 4 @@ -3125,13 +3125,13 @@ Download speed (byte/sec) .RE .RE .sp -\fBaria2\&.tellActive\fR +\fBaria2\&.tellActive\fR \fI[keys]\fR .sp -This method returns the list of active downloads\&. The response is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&. +This method returns the list of active downloads\&. The response is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&. For \fIkeys\fR parameter, please refer to \fBaria2\&.tellStatus\fR method\&. .sp -\fBaria2\&.tellWaiting\fR \fIoffset, num\fR +\fBaria2\&.tellWaiting\fR \fIoffset, num, [keys]\fR .sp -This method returns the list of waiting download, including paused downloads\&. \fIoffset\fR is of type integer and specifies the offset from the download waiting at the front\&. \fInum\fR is of type integer and specifies the number of downloads to be returned\&. +This method returns the list of waiting download, including paused downloads\&. \fIoffset\fR is of type integer and specifies the offset from the download waiting at the front\&. \fInum\fR is of type integer and specifies the number of downloads to be returned\&. For \fIkeys\fR parameter, please refer to \fBaria2\&.tellStatus\fR method\&. .sp If offset is a positive integer, this method returns downloads in the range of [\fIoffset\fR, \fIoffset\fR+\fInum\fR)\&. .sp @@ -3141,9 +3141,9 @@ For example, imagine that three downloads "A","B" and "C" are waiting in this or .sp The response is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&. .sp -\fBaria2\&.tellStopped\fR \fIoffset, num\fR +\fBaria2\&.tellStopped\fR \fIoffset, num, [keys]\fR .sp -This method returns the list of stopped download\&. \fIoffset\fR is of type integer and specifies the offset from the oldest download\&. \fInum\fR is of type integer and specifies the number of downloads to be returned\&. +This method returns the list of stopped download\&. \fIoffset\fR is of type integer and specifies the offset from the oldest download\&. \fInum\fR is of type integer and specifies the number of downloads to be returned\&. For \fIkeys\fR parameter, please refer to \fBaria2\&.tellStatus\fR method\&. .sp \fIoffset\fR and \fInum\fR have the same semantics as \fBaria2\&.tellWaiting\fR method\&. .sp diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index 6738a388..680cf627 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -3338,9 +3338,14 @@ download.

aria2.unpauseAll

This method is equal to calling aria2.unpause for every active/waiting download. This methods returns "OK" for success.

-

aria2.tellStatus gid

+

aria2.tellStatus gid[, keys]

This method returns download progress of the download denoted by -gid. gid is of type string. The response is of type struct and it +gid. gid is of type string. keys is array of string. If it is +specified, the response contains only keys in keys array. If keys +is empty or not specified, the response contains all keys. This is +useful when you just want specific keys and avoid unnecessary +transfers. For example, aria2.tellStatus("1", ["gid", "status"]) +returns gid and status key. The response is of type struct and it contains following keys. The value type is string.

@@ -3779,15 +3784,17 @@ downloadSpeed
-

aria2.tellActive

+

aria2.tellActive [keys]

This method returns the list of active downloads. The response is of type array and its element is the same struct returned by +aria2.tellStatus method. For keys parameter, please refer to aria2.tellStatus method.

-

aria2.tellWaiting offset, num

+

aria2.tellWaiting offset, num, [keys]

This method returns the list of waiting download, including paused downloads. offset is of type integer and specifies the offset from the download waiting at the front. num is of type integer and -specifies the number of downloads to be returned.

+specifies the number of downloads to be returned. For keys +parameter, please refer to aria2.tellStatus method.

If offset is a positive integer, this method returns downloads in the range of [offset, offset+num).

offset can be a negative integer. offset == -1 points last @@ -3800,10 +3807,11 @@ in this order. aria2.tellWaiting(0, 1) returns aria2.tellWaiting(-1, 2) returns ["C", "B"].

The response is of type array and its element is the same struct returned by aria2.tellStatus method.

-

aria2.tellStopped offset, num

+

aria2.tellStopped offset, num, [keys]

This method returns the list of stopped download. offset is of type integer and specifies the offset from the oldest download. num is of -type integer and specifies the number of downloads to be returned.

+type integer and specifies the number of downloads to be returned. +For keys parameter, please refer to aria2.tellStatus method.

offset and num have the same semantics as aria2.tellWaiting method.

The response is of type array and its element is the same struct @@ -4404,7 +4412,7 @@ files in the program, then also delete it here.

diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index 71e8a25f..43df73c7 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -1549,10 +1549,15 @@ download. This method is equal to calling *aria2.unpause* for every active/waiting download. This methods returns "OK" for success. -*aria2.tellStatus* 'gid' +*aria2.tellStatus* 'gid[, keys]' This method returns download progress of the download denoted by -'gid'. 'gid' is of type string. The response is of type struct and it +'gid'. 'gid' is of type string. 'keys' is array of string. If it is +specified, the response contains only keys in 'keys' array. If 'keys' +is empty or not specified, the response contains all keys. This is +useful when you just want specific keys and avoid unnecessary +transfers. For example, *aria2.tellStatus*("1", ["gid", "status"]) +returns 'gid' and 'status' key. The response is of type struct and it contains following keys. The value type is string. gid:: @@ -1801,18 +1806,20 @@ servers:: Download speed (byte/sec) -*aria2.tellActive* +*aria2.tellActive* '[keys]' This method returns the list of active downloads. The response is of type array and its element is the same struct returned by +*aria2.tellStatus* method. For 'keys' parameter, please refer to *aria2.tellStatus* method. -*aria2.tellWaiting* 'offset, num' +*aria2.tellWaiting* 'offset, num, [keys]' This method returns the list of waiting download, including paused downloads. 'offset' is of type integer and specifies the offset from the download waiting at the front. 'num' is of type integer and -specifies the number of downloads to be returned. +specifies the number of downloads to be returned. For 'keys' +parameter, please refer to *aria2.tellStatus* method. If offset is a positive integer, this method returns downloads in the range of ['offset', 'offset'+'num'). @@ -1830,11 +1837,12 @@ aria2.tellWaiting(-1, 2) returns ["C", "B"]. The response is of type array and its element is the same struct returned by *aria2.tellStatus* method. -*aria2.tellStopped* 'offset, num' +*aria2.tellStopped* 'offset, num, [keys]' This method returns the list of stopped download. 'offset' is of type integer and specifies the offset from the oldest download. 'num' is of type integer and specifies the number of downloads to be returned. +For 'keys' parameter, please refer to *aria2.tellStatus* method. 'offset' and 'num' have the same semantics as *aria2.tellWaiting* method. diff --git a/src/Makefile.am b/src/Makefile.am index 1ae0de03..bce6f9f8 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -218,7 +218,7 @@ SRCS += XmlRpcRequestParserController.cc XmlRpcRequestParserController.h\ XmlRpcRequestParserState.h\ XmlRpcRequestParserStateImpl.cc XmlRpcRequestParserStateImpl.h\ XmlRpcElements.cc XmlRpcElements.h\ - XmlRpcRequest.h\ + XmlRpcRequest.cc XmlRpcRequest.h\ XmlRpcRequestProcessor.h\ HttpServerBodyCommand.cc HttpServerBodyCommand.h\ XmlRpcMethod.cc XmlRpcMethod.h\ diff --git a/src/Makefile.in b/src/Makefile.in index 52de6713..a1b55ad9 100644 --- a/src/Makefile.in +++ b/src/Makefile.in @@ -42,7 +42,7 @@ bin_PROGRAMS = aria2c$(EXEEXT) @ENABLE_XML_RPC_TRUE@ XmlRpcRequestParserState.h\ @ENABLE_XML_RPC_TRUE@ XmlRpcRequestParserStateImpl.cc XmlRpcRequestParserStateImpl.h\ @ENABLE_XML_RPC_TRUE@ XmlRpcElements.cc XmlRpcElements.h\ -@ENABLE_XML_RPC_TRUE@ XmlRpcRequest.h\ +@ENABLE_XML_RPC_TRUE@ XmlRpcRequest.cc XmlRpcRequest.h\ @ENABLE_XML_RPC_TRUE@ XmlRpcRequestProcessor.h\ @ENABLE_XML_RPC_TRUE@ HttpServerBodyCommand.cc HttpServerBodyCommand.h\ @ENABLE_XML_RPC_TRUE@ XmlRpcMethod.cc XmlRpcMethod.h\ @@ -452,10 +452,11 @@ am__libaria2c_a_SOURCES_DIST = Socket.h SocketCore.cc SocketCore.h \ XmlRpcRequestParserStateMachine.cc \ XmlRpcRequestParserStateMachine.h XmlRpcRequestParserState.h \ XmlRpcRequestParserStateImpl.cc XmlRpcRequestParserStateImpl.h \ - XmlRpcElements.cc XmlRpcElements.h XmlRpcRequest.h \ - XmlRpcRequestProcessor.h HttpServerBodyCommand.cc \ - HttpServerBodyCommand.h XmlRpcMethod.cc XmlRpcMethod.h \ - XmlRpcMethodImpl.cc XmlRpcMethodImpl.h XmlRpcMethodFactory.cc \ + XmlRpcElements.cc XmlRpcElements.h XmlRpcRequest.cc \ + XmlRpcRequest.h XmlRpcRequestProcessor.h \ + HttpServerBodyCommand.cc HttpServerBodyCommand.h \ + XmlRpcMethod.cc XmlRpcMethod.h XmlRpcMethodImpl.cc \ + XmlRpcMethodImpl.h XmlRpcMethodFactory.cc \ XmlRpcMethodFactory.h XmlRpcResponse.cc XmlRpcResponse.h \ HttpListenCommand.cc HttpListenCommand.h HttpServerCommand.cc \ HttpServerCommand.h HttpServerResponseCommand.cc \ @@ -628,6 +629,7 @@ am__libaria2c_a_SOURCES_DIST = Socket.h SocketCore.cc SocketCore.h \ @ENABLE_XML_RPC_TRUE@ XmlRpcRequestParserStateMachine.$(OBJEXT) \ @ENABLE_XML_RPC_TRUE@ XmlRpcRequestParserStateImpl.$(OBJEXT) \ @ENABLE_XML_RPC_TRUE@ XmlRpcElements.$(OBJEXT) \ +@ENABLE_XML_RPC_TRUE@ XmlRpcRequest.$(OBJEXT) \ @ENABLE_XML_RPC_TRUE@ HttpServerBodyCommand.$(OBJEXT) \ @ENABLE_XML_RPC_TRUE@ XmlRpcMethod.$(OBJEXT) \ @ENABLE_XML_RPC_TRUE@ XmlRpcMethodImpl.$(OBJEXT) \ @@ -1655,6 +1657,7 @@ distclean-compile: @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/XmlRpcMethod.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/XmlRpcMethodFactory.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/XmlRpcMethodImpl.Po@am__quote@ +@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/XmlRpcRequest.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/XmlRpcRequestParserController.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/XmlRpcRequestParserStateImpl.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/XmlRpcRequestParserStateMachine.Po@am__quote@ diff --git a/src/XmlRpcMethodImpl.cc b/src/XmlRpcMethodImpl.cc index 4cb2e843..3e3d63a7 100644 --- a/src/XmlRpcMethodImpl.cc +++ b/src/XmlRpcMethodImpl.cc @@ -168,66 +168,26 @@ findRequestGroup(const SharedHandle& rgman, gid_t gid) return group; } -static const String* getStringParam -(const SharedHandle& params, size_t index) -{ - const String* stringParam = 0; - if(params->size() > index) { - stringParam = asString(params->get(index)); - } - return stringParam; -} - -static const Integer* getIntegerParam -(const SharedHandle& params, size_t index) -{ - const Integer* integerParam = 0; - if(params->size() > index) { - integerParam = asInteger(params->get(index)); - } - return integerParam; -} - -static const List* getListParam(const SharedHandle& params, size_t index) -{ - const List* listParam = 0; - if(params->size() > index) { - listParam = asList(params->get(index)); - } - return listParam; -} - -static const Dict* getDictParam(const SharedHandle& params, size_t index) -{ - const Dict* dictParam = 0; - if(params->size() > index) { - dictParam = asDict(params->get(index)); - } - return dictParam; -} - -static void getPosParam(const SharedHandle& params, size_t posParamIndex, +static void getPosParam(const XmlRpcRequest& req, size_t posParamIndex, bool& posGiven, size_t& pos) { - if(params->size() > posParamIndex) { - const Integer* p = asInteger(params->get(posParamIndex)); - if(p) { - if(p->i() >= 0) { - pos = p->i(); - posGiven = true; - return; - } else { - throw DL_ABORT_EX("Position must be greater than or equal to 0."); - } + const Integer* p = req.getIntegerParam(posParamIndex); + if(p) { + if(p->i() >= 0) { + pos = p->i(); + posGiven = true; + return; + } else { + throw DL_ABORT_EX("Position must be greater than or equal to 0."); } } posGiven = false; } static gid_t getRequiredGidParam -(const SharedHandle& params, size_t posParamIndex) +(const XmlRpcRequest& req, size_t posParamIndex) { - const String* gidParam = getStringParam(params, posParamIndex); + const String* gidParam = req.getStringParam(posParamIndex); if(gidParam) { return util::parseLLInt(gidParam->s()); } else { @@ -252,19 +212,18 @@ static void extractUris(OutputIterator out, const List* src) SharedHandle AddUriXmlRpcMethod::process (const XmlRpcRequest& req, DownloadEngine* e) { - const SharedHandle& params = req.params; std::vector uris; - extractUris(std::back_inserter(uris), getListParam(params, 0)); + extractUris(std::back_inserter(uris), req.getListParam(0)); if(uris.empty()) { throw DL_ABORT_EX("URI is not provided."); } SharedHandle