Add ResourceRetriever::getFilePath() (#972)

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ### DART 6.4.0 (201X-XX-XX)
 
+* Common
+
+  * Added ResourceRetriever::getFilePath(): [#972](https://github.com/dartsim/dart/pull/972)
+
 * Kinematics/Dynamics
 
   * Added lazy evaluation for shape's volume and bounding-box computation: [#959](https://github.com/dartsim/dart/pull/959)

dart/common/LocalResourceRetriever.cpp

@@ -43,14 +43,7 @@ namespace common {
 //==============================================================================
 bool LocalResourceRetriever::exists(const Uri& _uri)
 {
-  // Open and close the file to check if it exists. It would be more efficient
-  // to stat() it, but that is not portable.
-  if(_uri.mScheme.get_value_or("file") != "file")
-    return false;
-  else if (!_uri.mPath)
-    return false;
-
-  return std::ifstream(_uri.getFilesystemPath(), std::ios::binary).good();
+  return !getFilePath(_uri).empty();
 }
 
 //==============================================================================
@@ -70,5 +63,23 @@ common::ResourcePtr LocalResourceRetriever::retrieve(const Uri& _uri)
     return nullptr;
 }
 
+//==============================================================================
+std::string LocalResourceRetriever::getFilePath(const Uri& uri)
+{
+  // Open and close the file to check if it exists. It would be more efficient
+  // to stat() it, but that is not portable.
+  if(uri.mScheme.get_value_or("file") != "file")
+    return "";
+  else if (!uri.mPath)
+    return "";
+
+  const auto path = uri.getFilesystemPath();
+
+  if (std::ifstream(path, std::ios::binary).good())
+    return path;
+  else
+    return "";
+}
+
 } // namespace common
 } // namespace dart

dart/common/LocalResourceRetriever.hpp

@@ -50,6 +50,9 @@ class LocalResourceRetriever : public virtual ResourceRetriever
 
   // Documentation inherited.
   ResourcePtr retrieve(const Uri& _uri) override;
+
+  // Documentation inherited.
+  std::string getFilePath(const Uri& uri) override;
 };
 
 using LocalResourceRetrieverPtr = std::shared_ptr<LocalResourceRetriever>;

dart/common/ResourceRetriever.cpp

@@ -53,5 +53,11 @@ std::string ResourceRetriever::readAll(const Uri& uri)
   return resource->readAll();
 }
 
+//==============================================================================
+std::string ResourceRetriever::getFilePath(const Uri& /*uri*/)
+{
+  return "";
+}
+
 } // namespace common
 } // namespace dart

dart/common/ResourceRetriever.hpp

@@ -48,10 +48,10 @@ class ResourceRetriever
 public:
   virtual ~ResourceRetriever() = default;
 
-  /// \brief Return whether the resource specified by a URI exists.
+  /// Returns whether the resource specified by a URI exists.
   virtual bool exists(const Uri& _uri) = 0;
 
-  /// \brief Return the resource specified by a URI or nullptr on failure.
+  /// Returns the resource specified by a URI or nullptr on failure.
   virtual ResourcePtr retrieve(const Uri& _uri) = 0;
 
   /// Reads all data from the resource of uri, and returns it as a string.
@@ -61,11 +61,16 @@ class ResourceRetriever
   /// \throw std::runtime_error when failed to read sucessfully.
   virtual std::string readAll(const Uri& uri);
 
-  // We don't const-qualify for exists, retrieve, and readAll here. Derived
-  // classes of ResourceRetriever will be interacting with external resources
-  // that you don't necessarily have control over so we cannot guarantee that
-  // you get the same result every time with the same input Uri. Indeed,
-  // const-qualification for those functions is pointless.
+  /// Returns absolute file path to \c uri; an empty string if unavailable.
+  ///
+  /// This base class returns an empty string by default.
+  virtual std::string getFilePath(const Uri& uri);
+
+  // We don't const-qualify for exists, retrieve, readAll, and getFilePath here.
+  // Derived classes of ResourceRetriever will be interacting with external
+  // resources that you don't necessarily have control over so we cannot
+  // guarantee that you get the same result every time with the same input Uri.
+  // Indeed, const-qualification for those functions is pointless.
 };
 
 using ResourceRetrieverPtr = std::shared_ptr<ResourceRetriever>;

dart/utils/CompositeResourceRetriever.cpp

@@ -100,6 +100,19 @@ common::ResourcePtr CompositeResourceRetriever::retrieve(
   return nullptr;
 }
 
+//==============================================================================
+std::string CompositeResourceRetriever::getFilePath(const common::Uri& uri)
+{
+  for (const auto& resourceRetriever : getRetrievers(uri))
+  {
+    const auto path = resourceRetriever->getFilePath(uri);
+    if (!path.empty())
+      return path;
+  }
+
+  return "";
+}
+
 //==============================================================================
 std::vector<common::ResourceRetrieverPtr>
   CompositeResourceRetriever::getRetrievers(const common::Uri& _uri) const

dart/utils/CompositeResourceRetriever.hpp

@@ -72,6 +72,9 @@ class CompositeResourceRetriever : public virtual common::ResourceRetriever
   // Documentation inherited.
   common::ResourcePtr retrieve(const common::Uri& _uri) override;
 
+  // Documentation inherited.
+  std::string getFilePath(const common::Uri& uri) override;
+
 private:
   std::vector<common::ResourceRetrieverPtr> getRetrievers(
     const common::Uri& _uri) const;

dart/utils/DartResourceRetriever.cpp

@@ -103,6 +103,39 @@ common::ResourcePtr DartResourceRetriever::retrieve(const common::Uri& uri)
   return nullptr;
 }
 
+//==============================================================================
+std::string DartResourceRetriever::getFilePath(const common::Uri& uri)
+{
+  std::string relativePath;
+  if (!resolveDataUri(uri, relativePath))
+    return "";
+
+  if (uri.mAuthority.get() == "sample")
+  {
+    for (const auto& dataPath : mDataDirectories)
+    {
+      common::Uri fileUri;
+      fileUri.fromPath(dataPath + relativePath);
+
+      const auto path = mLocalRetriever->getFilePath(fileUri);
+
+      // path is empty if the file specified by fileUri doesn't exist.
+      if (!path.empty())
+        return path;
+    }
+  }
+  else
+  {
+    const auto path = mLocalRetriever->getFilePath(uri);
+
+    // path is empty if the file specified by fileUri doesn't exist.
+    if (!path.empty())
+      return path;
+  }
+
+  return "";
+}
+
 //==============================================================================
 void DartResourceRetriever::addDataDirectory(
     const std::string& dataDirectory)

dart/utils/DartResourceRetriever.hpp

@@ -84,6 +84,9 @@ class DartResourceRetriever : public common::ResourceRetriever
   // Documentation inherited.
   common::ResourcePtr retrieve(const common::Uri& uri) override;
 
+  // Documentation inherited.
+  std::string getFilePath(const common::Uri& uri) override;
+
 private:
 
   void addDataDirectory(const std::string& packageDirectory);

dart/utils/PackageResourceRetriever.cpp

@@ -73,14 +73,15 @@ bool PackageResourceRetriever::exists(const common::Uri& _uri)
   if (!resolvePackageUri(_uri, packageName, relativePath))
     return false;
 
-  for(const std::string& packagePath : getPackagePaths(packageName))
+  for (const std::string& packagePath : getPackagePaths(packageName))
   {
     common::Uri fileUri;
     fileUri.fromPath(packagePath + relativePath);
 
     if (mLocalRetriever->exists(fileUri))
       return true;
   }
+
   return false;
 }
 
@@ -102,6 +103,28 @@ common::ResourcePtr PackageResourceRetriever::retrieve(const common::Uri& _uri)
   return nullptr;
 }
 
+//==============================================================================
+std::string PackageResourceRetriever::getFilePath(const common::Uri& uri)
+{
+  std::string packageName, relativePath;
+  if (!resolvePackageUri(uri, packageName, relativePath))
+    return "";
+
+  for(const std::string& packagePath : getPackagePaths(packageName))
+  {
+    common::Uri fileUri;
+    fileUri.fromPath(packagePath + relativePath);
+
+    const auto path = mLocalRetriever->getFilePath(fileUri);
+
+    // path is empty if the file specified by fileUri doesn't exist.
+    if (!path.empty())
+      return path;
+  }
+
+  return "";
+}
+
 //==============================================================================
 const std::vector<std::string>& PackageResourceRetriever::getPackagePaths(
   const std::string& _packageName) const

dart/utils/PackageResourceRetriever.hpp

@@ -91,6 +91,9 @@ class PackageResourceRetriever : public virtual common::ResourceRetriever
   // Documentation inherited.
   common::ResourcePtr retrieve(const common::Uri& _uri) override;
 
+  // Documentation inherited.
+  std::string getFilePath(const common::Uri& uri) override;
+
 private:
   common::ResourceRetrieverPtr mLocalRetriever;
   std::unordered_map<std::string, std::vector<std::string> > mPackageMap;

unittests/TestHelpers.hpp

@@ -505,13 +505,20 @@ struct PresentResourceRetriever : public dart::common::ResourceRetriever
     return true;
   }
 
+  std::string getFilePath(const dart::common::Uri& _uri) override
+  {
+    mGetFilePath.push_back(_uri.toString());
+    return _uri.toString();
+  }
+
   dart::common::ResourcePtr retrieve(const dart::common::Uri& _uri) override
   {
     mRetrieve.push_back(_uri.toString());
     return std::make_shared<TestResource>();
   }
 
   std::vector<std::string> mExists;
+  std::vector<std::string> mGetFilePath;
   std::vector<std::string> mRetrieve;
 };
 
@@ -524,13 +531,20 @@ struct AbsentResourceRetriever : public dart::common::ResourceRetriever
     return false;
   }
 
+  std::string getFilePath(const dart::common::Uri& _uri) override
+  {
+    mGetFilePath.push_back(_uri.toString());
+    return "";
+  }
+
   dart::common::ResourcePtr retrieve(const dart::common::Uri& _uri) override
   {
     mRetrieve.push_back(_uri.toString());
     return nullptr;
   }
 
   std::vector<std::string> mExists;
+  std::vector<std::string> mGetFilePath;
   std::vector<std::string> mRetrieve;
 };
 

unittests/unit/test_CompositeResourceRetriever.cpp

@@ -113,6 +113,88 @@ TEST(CompositeResourceRetriever, exists_DefaultResourceRetrieverSucceeds_Returns
   EXPECT_TRUE(retriever3->mRetrieve.empty());
 }
 
+TEST(CompositeResourceRetriever, getFilePath_NothingRegistered_ReturnsEmptyString)
+{
+  CompositeResourceRetriever retriever;
+  EXPECT_EQ(retriever.getFilePath(Uri::createFromString("package://test/foo")), "");
+}
+
+TEST(CompositeResourceRetriever, getFilePath_AllRetrieversFail_ReturnsFalse)
+{
+  auto retriever1 = std::make_shared<AbsentResourceRetriever>();
+  auto retriever2 = std::make_shared<AbsentResourceRetriever>();
+  CompositeResourceRetriever retriever;
+
+  EXPECT_TRUE(retriever.addSchemaRetriever("package", retriever1));
+  retriever.addDefaultRetriever(retriever2);
+
+  EXPECT_EQ(retriever.getFilePath(Uri::createFromString("package://test/foo")), "");
+
+  EXPECT_TRUE(retriever1->mExists.empty());
+  ASSERT_EQ(1u, retriever1->mGetFilePath.size());
+  EXPECT_EQ("package://test/foo", retriever1->mGetFilePath.front());
+  EXPECT_TRUE(retriever1->mRetrieve.empty());
+
+  EXPECT_TRUE(retriever2->mExists.empty());
+  ASSERT_EQ(1u, retriever2->mGetFilePath.size());
+  EXPECT_EQ("package://test/foo", retriever2->mGetFilePath.front());
+  EXPECT_TRUE(retriever2->mRetrieve.empty());
+}
+
+TEST(CompositeResourceRetriever, getFilePath_CompositeResourceRetrieverSucceeds_ReturnsFilePath)
+{
+  auto retriever1 = std::make_shared<PresentResourceRetriever>();
+  auto retriever2 = std::make_shared<AbsentResourceRetriever>();
+  auto retriever3 = std::make_shared<AbsentResourceRetriever>();
+  CompositeResourceRetriever retriever;
+
+  EXPECT_TRUE(retriever.addSchemaRetriever("package", retriever1));
+  EXPECT_TRUE(retriever.addSchemaRetriever("package", retriever2));
+  retriever.addDefaultRetriever(retriever3);
+
+  EXPECT_EQ(retriever.getFilePath(Uri::createFromString("package://test/foo")), "package://test/foo");
+
+  EXPECT_TRUE(retriever2->mExists.empty());
+  ASSERT_EQ(1u, retriever1->mGetFilePath.size());
+  EXPECT_EQ("package://test/foo", retriever1->mGetFilePath.front());
+  EXPECT_TRUE(retriever1->mRetrieve.empty());
+
+  EXPECT_TRUE(retriever2->mExists.empty());
+  EXPECT_TRUE(retriever2->mGetFilePath.empty());
+  EXPECT_TRUE(retriever2->mRetrieve.empty());
+  EXPECT_TRUE(retriever3->mExists.empty());
+  EXPECT_TRUE(retriever3->mGetFilePath.empty());
+  EXPECT_TRUE(retriever3->mRetrieve.empty());
+}
+
+TEST(CompositeResourceRetriever, getFilePath_DefaultResourceRetrieverSucceeds_ReturnsFilePath)
+{
+  auto retriever1 = std::make_shared<AbsentResourceRetriever>();
+  auto retriever2 = std::make_shared<PresentResourceRetriever>();
+  auto retriever3 = std::make_shared<AbsentResourceRetriever>();
+  CompositeResourceRetriever retriever;
+
+  EXPECT_TRUE(retriever.addSchemaRetriever("package", retriever1));
+  retriever.addDefaultRetriever(retriever2);
+  retriever.addDefaultRetriever(retriever3);
+
+  EXPECT_EQ(retriever.getFilePath(Uri::createFromString("package://test/foo")), "package://test/foo");
+
+  EXPECT_TRUE(retriever1->mExists.empty());
+  ASSERT_EQ(1u, retriever1->mGetFilePath.size());
+  EXPECT_EQ("package://test/foo", retriever1->mGetFilePath.front());
+  EXPECT_TRUE(retriever1->mRetrieve.empty());
+
+  EXPECT_TRUE(retriever2->mExists.empty());
+  ASSERT_EQ(1u, retriever2->mGetFilePath.size());
+  EXPECT_EQ("package://test/foo", retriever2->mGetFilePath.front());
+  EXPECT_TRUE(retriever2->mRetrieve.empty());
+
+  EXPECT_TRUE(retriever3->mExists.empty());
+  EXPECT_TRUE(retriever3->mGetFilePath.empty());
+  EXPECT_TRUE(retriever3->mRetrieve.empty());
+}
+
 TEST(CompositeResourceRetriever, retrieve_NothingRegistered_ReturnsNull)
 {
   CompositeResourceRetriever retriever;