diff --git a/ChangeLog b/ChangeLog index 36075f39..679e9f52 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,21 @@ +2010-02-26 Tatsuhiro Tsujikawa + + Added MetalinkMetaurl class. It corresponds to metalink:metaurl + element. + * src/Makefile.am + * src/Metalink2RequestGroup.cc + * src/MetalinkEntry.cc + * src/MetalinkEntry.h + * src/MetalinkMetaurl.cc + * src/MetalinkMetaurl.h + * src/MetalinkParserController.cc + * src/MetalinkParserController.h + * src/MetalinkParserStateMachine.cc + * src/MetalinkParserStateMachine.h + * src/MetalinkParserStateV4Impl.cc + * src/MetalinkParserStateV4Impl.h + * test/MetalinkProcessorTest.cc + 2010-02-25 Tatsuhiro Tsujikawa Added Metalink4 support. Currently, name attribute of diff --git a/src/Makefile.am b/src/Makefile.am index db06f044..81e97112 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -452,6 +452,7 @@ if ENABLE_METALINK SRCS += Metalinker.cc Metalinker.h\ MetalinkEntry.cc MetalinkEntry.h\ MetalinkResource.cc MetalinkResource.h\ + MetalinkMetaurl.cc MetalinkMetaurl.h\ MetalinkProcessor.h\ MetalinkParserController.cc MetalinkParserController.h\ MetalinkParserStateMachine.cc MetalinkParserStateMachine.h\ diff --git a/src/Makefile.in b/src/Makefile.in index 0d1d81b8..49ad140c 100644 --- a/src/Makefile.in +++ b/src/Makefile.in @@ -253,6 +253,7 @@ bin_PROGRAMS = aria2c$(EXEEXT) @ENABLE_METALINK_TRUE@am__append_14 = Metalinker.cc Metalinker.h\ @ENABLE_METALINK_TRUE@ MetalinkEntry.cc MetalinkEntry.h\ @ENABLE_METALINK_TRUE@ MetalinkResource.cc MetalinkResource.h\ +@ENABLE_METALINK_TRUE@ MetalinkMetaurl.cc MetalinkMetaurl.h\ @ENABLE_METALINK_TRUE@ MetalinkProcessor.h\ @ENABLE_METALINK_TRUE@ MetalinkParserController.cc MetalinkParserController.h\ @ENABLE_METALINK_TRUE@ MetalinkParserStateMachine.cc MetalinkParserStateMachine.h\ @@ -583,7 +584,8 @@ am__libaria2c_a_SOURCES_DIST = Socket.h SocketCore.cc SocketCore.h \ LpdReceiveMessageCommand.cc LpdReceiveMessageCommand.h \ LpdDispatchMessageCommand.cc LpdDispatchMessageCommand.h \ Metalinker.cc Metalinker.h MetalinkEntry.cc MetalinkEntry.h \ - MetalinkResource.cc MetalinkResource.h MetalinkProcessor.h \ + MetalinkResource.cc MetalinkResource.h MetalinkMetaurl.cc \ + MetalinkMetaurl.h MetalinkProcessor.h \ MetalinkParserController.cc MetalinkParserController.h \ MetalinkParserStateMachine.cc MetalinkParserStateMachine.h \ MetalinkParserState.h MetalinkParserStateImpl.cc \ @@ -755,6 +757,7 @@ am__objects_6 = @ENABLE_METALINK_TRUE@am__objects_14 = Metalinker.$(OBJEXT) \ @ENABLE_METALINK_TRUE@ MetalinkEntry.$(OBJEXT) \ @ENABLE_METALINK_TRUE@ MetalinkResource.$(OBJEXT) \ +@ENABLE_METALINK_TRUE@ MetalinkMetaurl.$(OBJEXT) \ @ENABLE_METALINK_TRUE@ MetalinkParserController.$(OBJEXT) \ @ENABLE_METALINK_TRUE@ MetalinkParserStateMachine.$(OBJEXT) \ @ENABLE_METALINK_TRUE@ MetalinkParserStateImpl.$(OBJEXT) \ @@ -1494,6 +1497,7 @@ distclean-compile: @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/Metalink2RequestGroup.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/MetalinkEntry.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/MetalinkHelper.Po@am__quote@ +@AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/MetalinkMetaurl.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/MetalinkParserController.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/MetalinkParserStateImpl.Po@am__quote@ @AMDEP_TRUE@@am__include@ @am__quote@./$(DEPDIR)/MetalinkParserStateMachine.Po@am__quote@ diff --git a/src/Metalink2RequestGroup.cc b/src/Metalink2RequestGroup.cc index 2c429931..74e1b2d5 100644 --- a/src/Metalink2RequestGroup.cc +++ b/src/Metalink2RequestGroup.cc @@ -50,6 +50,7 @@ #include "TrueRequestGroupCriteria.h" #include "MetalinkEntry.h" #include "MetalinkResource.h" +#include "MetalinkMetaurl.h" #include "FileEntry.h" #include "A2STR.h" #include "a2functional.h" @@ -175,19 +176,17 @@ Metalink2RequestGroup::createRequestGroup } } entry->dropUnsupportedResource(); - if(entry->resources.size() == 0) { + if(entry->resources.empty() && entry->metaurls.empty()) { continue; } _logger->info(MSG_METALINK_QUEUEING, entry->getPath().c_str()); - std::deque >::iterator itr = - std::find_if(entry->resources.begin(), entry->resources.end(), FindBitTorrentUrl()); - #ifdef ENABLE_BITTORRENT SharedHandle torrentRg; - // there is torrent entry - if(itr != entry->resources.end()) { + if(!entry->metaurls.empty()) { + entry->reorderMetaurlsByPriority(); + // there is torrent entry std::deque uris; - uris.push_back((*itr)->url); + uris.push_back(entry->metaurls[0]->url); { std::deque > result; createRequestGroupForUri(result, option, uris, diff --git a/src/MetalinkEntry.cc b/src/MetalinkEntry.cc index 25a86a0c..218f8ba5 100644 --- a/src/MetalinkEntry.cc +++ b/src/MetalinkEntry.cc @@ -37,6 +37,7 @@ #include #include "MetalinkResource.h" +#include "MetalinkMetaurl.h" #include "FileEntry.h" #include "util.h" #include "a2functional.h" @@ -133,10 +134,11 @@ void MetalinkEntry::setProtocolPriority(const std::string& protocol, AddProtocolPriority(protocol, priorityToAdd)); } -class PrefOrder { +template +class PriorityHigher { public: - bool operator()(const SharedHandle& res1, - const SharedHandle& res2) + bool operator()(const SharedHandle& res1, + const SharedHandle& res2) { return res1->priority < res2->priority; } @@ -145,7 +147,13 @@ public: void MetalinkEntry::reorderResourcesByPriority() { std::random_shuffle(resources.begin(), resources.end(), *(SimpleRandomizer::getInstance().get())); - std::sort(resources.begin(), resources.end(), PrefOrder()); + std::sort(resources.begin(), resources.end(), + PriorityHigher()); +} + +void MetalinkEntry::reorderMetaurlsByPriority() +{ + std::sort(metaurls.begin(), metaurls.end(),PriorityHigher()); } class Supported:public std::unary_function, bool> { diff --git a/src/MetalinkEntry.h b/src/MetalinkEntry.h index e18b9158..4b10ec82 100644 --- a/src/MetalinkEntry.h +++ b/src/MetalinkEntry.h @@ -47,6 +47,7 @@ namespace aria2 { class MetalinkResource; +class MetalinkMetaurl; class FileEntry; #ifdef ENABLE_MESSAGE_DIGEST class Checksum; @@ -61,6 +62,7 @@ public: std::vector languages; std::vector oses; std::deque > resources; + std::vector > metaurls; int maxConnections; // Metalink3Spec #ifdef ENABLE_MESSAGE_DIGEST SharedHandle checksum; @@ -87,6 +89,8 @@ public: void dropUnsupportedResource(); void reorderResourcesByPriority(); + + void reorderMetaurlsByPriority(); bool containsLanguage(const std::string& lang) const { diff --git a/src/MetalinkMetaurl.cc b/src/MetalinkMetaurl.cc new file mode 100644 index 00000000..cdd47d08 --- /dev/null +++ b/src/MetalinkMetaurl.cc @@ -0,0 +1,45 @@ +/* */ +#include "MetalinkMetaurl.h" +#include "MetalinkResource.h" + +namespace aria2 { + +const std::string MetalinkMetaurl::MEDIATYPE_TORRENT("torrent"); + +MetalinkMetaurl::MetalinkMetaurl(): + priority(MetalinkResource::getLowestPriority()) {} + +} // namespace aria2 diff --git a/src/MetalinkMetaurl.h b/src/MetalinkMetaurl.h new file mode 100644 index 00000000..6e0dc7b0 --- /dev/null +++ b/src/MetalinkMetaurl.h @@ -0,0 +1,57 @@ +/* */ +#ifndef _D_METALINK_METAURL_H_ +#define _D_METALINK_METAURL_H_ + +#include "common.h" + +#include + +namespace aria2 { + +class MetalinkMetaurl { +public: + std::string url; + std::string mediatype; + int priority; + + MetalinkMetaurl(); + + static const std::string MEDIATYPE_TORRENT; +}; + +} // namespace aria2 + +#endif // _D_METALINK_METAURL_H_ diff --git a/src/MetalinkParserController.cc b/src/MetalinkParserController.cc index 91333b57..c7f2b093 100644 --- a/src/MetalinkParserController.cc +++ b/src/MetalinkParserController.cc @@ -40,6 +40,7 @@ #include "Metalinker.h" #include "MetalinkEntry.h" #include "MetalinkResource.h" +#include "MetalinkMetaurl.h" #include "FileEntry.h" #include "a2functional.h" #include "A2STR.h" @@ -65,6 +66,7 @@ void MetalinkParserController::newEntryTransaction() { _tEntry.reset(new MetalinkEntry()); _tResource.reset(); + _tMetaurl.reset(); #ifdef ENABLE_MESSAGE_DIGEST _tChecksum.reset(); _tChunkChecksumV4.reset(); @@ -229,7 +231,19 @@ void MetalinkParserController::commitResourceTransaction() if(_tResource.isNull()) { return; } +#ifdef ENABLE_BITTORRENT + if(_tResource->type == MetalinkResource::TYPE_BITTORRENT) { + SharedHandle metaurl(new MetalinkMetaurl()); + metaurl->url = _tResource->url; + metaurl->priority = _tResource->priority; + metaurl->mediatype = MetalinkMetaurl::MEDIATYPE_TORRENT; + _tEntry->metaurls.push_back(metaurl); + } else { + _tEntry->resources.push_back(_tResource); + } +#else // !ENABLE_BITTORRENT _tEntry->resources.push_back(_tResource); +#endif // !ENABLE_BITTORRENT _tResource.reset(); } @@ -520,4 +534,55 @@ void MetalinkParserController::cancelSignatureTransaction() _tSignature.reset(); } +void MetalinkParserController::newMetaurlTransaction() +{ + if(_tEntry.isNull()) { + return; + } + _tMetaurl.reset(new MetalinkMetaurl()); +} + +void MetalinkParserController::setURLOfMetaurl(const std::string& url) +{ + if(_tMetaurl.isNull()) { + return; + } + _tMetaurl->url = url; +} + +void MetalinkParserController::setMediatypeOfMetaurl +(const std::string& mediatype) +{ + if(_tMetaurl.isNull()) { + return; + } + _tMetaurl->mediatype = mediatype; +} + +void MetalinkParserController::setPriorityOfMetaurl(int priority) +{ + if(_tMetaurl.isNull()) { + return; + } + _tMetaurl->priority = priority; +} + +void MetalinkParserController::commitMetaurlTransaction() +{ + if(_tMetaurl.isNull()) { + return; + } +#ifdef ENABLE_BITTORRENT + if(_tMetaurl->mediatype == MetalinkMetaurl::MEDIATYPE_TORRENT) { + _tEntry->metaurls.push_back(_tMetaurl); + } +#endif // ENABLE_BITTORRENT + _tMetaurl.reset(); +} + +void MetalinkParserController::cancelMetaurlTransaction() +{ + _tMetaurl.reset(); +} + } // namespace aria2 diff --git a/src/MetalinkParserController.h b/src/MetalinkParserController.h index 2dd94843..337a9708 100644 --- a/src/MetalinkParserController.h +++ b/src/MetalinkParserController.h @@ -48,6 +48,7 @@ namespace aria2 { class Metalinker; class MetalinkEntry; class MetalinkResource; +class MetalinkMetaurl; class Signature; #ifdef ENABLE_MESSAGE_DIGEST @@ -63,6 +64,7 @@ private: SharedHandle _tResource; + SharedHandle _tMetaurl; #ifdef ENABLE_MESSAGE_DIGEST SharedHandle _tChecksum; @@ -176,6 +178,18 @@ public: void commitSignatureTransaction(); void cancelSignatureTransaction(); + + void newMetaurlTransaction(); + + void setURLOfMetaurl(const std::string& url); + + void setMediatypeOfMetaurl(const std::string& mediatype); + + void setPriorityOfMetaurl(int priority); + + void commitMetaurlTransaction(); + + void cancelMetaurlTransaction(); }; } // namespace aria2 diff --git a/src/MetalinkParserStateMachine.cc b/src/MetalinkParserStateMachine.cc index ef67237a..966a02f9 100644 --- a/src/MetalinkParserStateMachine.cc +++ b/src/MetalinkParserStateMachine.cc @@ -97,6 +97,8 @@ MetalinkParserState* MetalinkParserStateMachine::_signatureStateV4 = new SignatureMetalinkParserStateV4(); MetalinkParserState* MetalinkParserStateMachine::_urlStateV4 = new URLMetalinkParserStateV4(); +MetalinkParserState* MetalinkParserStateMachine::_metaurlStateV4 = + new MetaurlMetalinkParserStateV4(); MetalinkParserStateMachine::MetalinkParserStateMachine(): _ctrl(new MetalinkParserController()) @@ -229,6 +231,11 @@ void MetalinkParserStateMachine::setURLStateV4() _stateStack.push(_urlStateV4); } +void MetalinkParserStateMachine::setMetaurlStateV4() +{ + _stateStack.push(_metaurlStateV4); +} + void MetalinkParserStateMachine::setSkipTagState() { _stateStack.push(_skipTagState); @@ -447,6 +454,37 @@ void MetalinkParserStateMachine::cancelSignatureTransaction() _ctrl->cancelSignatureTransaction(); } +void MetalinkParserStateMachine::newMetaurlTransaction() +{ + _ctrl->newMetaurlTransaction(); +} + +void MetalinkParserStateMachine::setURLOfMetaurl(const std::string& url) +{ + _ctrl->setURLOfMetaurl(url); +} + +void MetalinkParserStateMachine::setMediatypeOfMetaurl +(const std::string& mediatype) +{ + _ctrl->setMediatypeOfMetaurl(mediatype); +} + +void MetalinkParserStateMachine::setPriorityOfMetaurl(int priority) +{ + _ctrl->setPriorityOfMetaurl(priority); +} + +void MetalinkParserStateMachine::commitMetaurlTransaction() +{ + _ctrl->commitMetaurlTransaction(); +} + +void MetalinkParserStateMachine::cancelMetaurlTransaction() +{ + _ctrl->cancelMetaurlTransaction(); +} + void MetalinkParserStateMachine::beginElement (const std::string& localname, const std::string& prefix, diff --git a/src/MetalinkParserStateMachine.h b/src/MetalinkParserStateMachine.h index d761bfd4..3da3beae 100644 --- a/src/MetalinkParserStateMachine.h +++ b/src/MetalinkParserStateMachine.h @@ -85,6 +85,7 @@ private: static MetalinkParserState* _pieceHashStateV4; // Metalink4Spec static MetalinkParserState* _signatureStateV4; static MetalinkParserState* _urlStateV4; + static MetalinkParserState* _metaurlStateV4; public: MetalinkParserStateMachine(); @@ -130,6 +131,7 @@ public: void setPieceHashStateV4(); // Metalink4Spec void setSignatureStateV4(); void setURLStateV4(); + void setMetaurlStateV4(); bool finished() const; @@ -227,6 +229,18 @@ public: void cancelSignatureTransaction(); + void newMetaurlTransaction(); + + void setURLOfMetaurl(const std::string& url); + + void setMediatypeOfMetaurl(const std::string& mediatype); + + void setPriorityOfMetaurl(int priority); + + void commitMetaurlTransaction(); + + void cancelMetaurlTransaction(); + bool needsCharactersBuffering() const; const SharedHandle& getResult() const diff --git a/src/MetalinkParserStateV4Impl.cc b/src/MetalinkParserStateV4Impl.cc index 0abdf927..a0a26139 100644 --- a/src/MetalinkParserStateV4Impl.cc +++ b/src/MetalinkParserStateV4Impl.cc @@ -129,7 +129,7 @@ void FileMetalinkParserStateV4::beginElement } else if(localname == OS) { stm->setOSStateV4(); } else if(localname == METAURL) { - stm->setURLStateV4(); + stm->setMetaurlStateV4(); // TODO currently NAME is ignored int priority; { @@ -156,9 +156,9 @@ void FileMetalinkParserStateV4::beginElement mediatype = (*itr).value; } } - stm->newResourceTransaction(); - stm->setPriorityOfResource(priority); - stm->setTypeOfResource(mediatype); + stm->newMetaurlTransaction(); + stm->setPriorityOfMetaurl(priority); + stm->setMediatypeOfMetaurl(mediatype); } else if(localname == URL) { stm->setURLStateV4(); std::string location; @@ -363,4 +363,15 @@ void URLMetalinkParserStateV4::endElement stm->commitResourceTransaction(); } +void MetaurlMetalinkParserStateV4::endElement +(MetalinkParserStateMachine* stm, + const std::string& localname, + const std::string& prefix, + const std::string& nsUri, + const std::string& characters) +{ + stm->setURLOfMetaurl(characters); + stm->commitMetaurlTransaction(); +} + } // namespace aria2 diff --git a/src/MetalinkParserStateV4Impl.h b/src/MetalinkParserStateV4Impl.h index 73627801..12b98fd7 100644 --- a/src/MetalinkParserStateV4Impl.h +++ b/src/MetalinkParserStateV4Impl.h @@ -214,6 +214,21 @@ public: } }; +class MetaurlMetalinkParserStateV4:public SkipTagMetalinkParserState +{ +public: + virtual void endElement(MetalinkParserStateMachine* stm, + const std::string& localname, + const std::string& prefix, + const std::string& nsUri, + const std::string& characters); + + virtual bool needsCharactersBuffering() const + { + return true; + } +}; + } // namespace aria2 #endif // _D_METALINK_PARSER_STATE_IMPL_H_ diff --git a/test/MetalinkProcessorTest.cc b/test/MetalinkProcessorTest.cc index 3d69a26a..4a885f34 100644 --- a/test/MetalinkProcessorTest.cc +++ b/test/MetalinkProcessorTest.cc @@ -11,6 +11,7 @@ #include "Metalinker.h" #include "MetalinkEntry.h" #include "MetalinkResource.h" +#include "MetalinkMetaurl.h" #ifdef ENABLE_MESSAGE_DIGEST # include "ChunkChecksum.h" # include "Checksum.h" @@ -80,6 +81,7 @@ void MetalinkProcessorTest::testParseFileV4() SharedHandle e; SharedHandle r; + SharedHandle mu; CPPUNIT_ASSERT_EQUAL((size_t)1, m->entries.size()); e = m->entries[0]; @@ -108,7 +110,7 @@ void MetalinkProcessorTest::testParseFileV4() CPPUNIT_ASSERT_EQUAL(std::string("a signature"), e->getSignature()->getBody()); - CPPUNIT_ASSERT_EQUAL((size_t)3, e->resources.size()); + CPPUNIT_ASSERT_EQUAL((size_t)2, e->resources.size()); r = e->resources[0]; CPPUNIT_ASSERT_EQUAL(std::string("ftp://ftp.example.com/example.ext"), r->url); @@ -117,14 +119,16 @@ void MetalinkProcessorTest::testParseFileV4() CPPUNIT_ASSERT_EQUAL(std::string("ftp"), MetalinkResource::getTypeString(r->type)); CPPUNIT_ASSERT_EQUAL(-1, r->maxConnections); - - r = e->resources[2]; +#ifdef ENABLE_BITTORRENT + CPPUNIT_ASSERT_EQUAL((size_t)1, e->metaurls.size()); + mu = e->metaurls[0]; CPPUNIT_ASSERT_EQUAL(std::string("http://example.com/example.ext.torrent"), - r->url); - CPPUNIT_ASSERT_EQUAL(2, r->priority); - CPPUNIT_ASSERT_EQUAL(std::string("bittorrent"), - MetalinkResource::getTypeString(r->type)); - CPPUNIT_ASSERT_EQUAL(-1, r->maxConnections); + mu->url); + CPPUNIT_ASSERT_EQUAL(2, mu->priority); + CPPUNIT_ASSERT_EQUAL(std::string("torrent"), mu->mediatype); +#else // !ENABLE_BITTORRENT + CPPUNIT_ASSERT_EQUAL((size_t)0, e->metaurls.size()); +#endif // !ENABLE_BITTORRENT } void MetalinkProcessorTest::testParseFileV4_dirtraversal() @@ -139,15 +143,23 @@ void MetalinkProcessorTest::testParseFileV4_attrs() MetalinkProcessor proc; SharedHandle m = proc.parseFile("metalink4-attrs.xml"); CPPUNIT_ASSERT_EQUAL((size_t)1, m->entries.size()); - CPPUNIT_ASSERT_EQUAL((size_t)6, m->entries[0]->resources.size()); std::deque > resources = m->entries[0]->resources; + CPPUNIT_ASSERT_EQUAL((size_t)3, resources.size()); CPPUNIT_ASSERT_EQUAL(999999, resources[0]->priority); CPPUNIT_ASSERT_EQUAL(999999, resources[1]->priority); CPPUNIT_ASSERT_EQUAL(999999, resources[2]->priority); - CPPUNIT_ASSERT_EQUAL(999999, resources[3]->priority); - CPPUNIT_ASSERT_EQUAL(999999, resources[4]->priority); - CPPUNIT_ASSERT_EQUAL(999999, resources[5]->priority); + + std::vector > metaurls = + m->entries[0]->metaurls; +#ifdef ENABLE_BITTORRENT + CPPUNIT_ASSERT_EQUAL((size_t)3, metaurls.size()); + CPPUNIT_ASSERT_EQUAL(999999, metaurls[0]->priority); + CPPUNIT_ASSERT_EQUAL(999999, metaurls[1]->priority); + CPPUNIT_ASSERT_EQUAL(999999, metaurls[2]->priority); +#else // !ENABLE_BITTORRENT + CPPUNIT_ASSERT_EQUAL((size_t)0, metaurls.size()); +#endif // !ENABLE_BITTORRENT } void MetalinkProcessorTest::testParseFile()