diff Core/RestApi/RestApiHierarchy.cpp @ 969:3dce528b0cc2

RestApiHierarchy
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 30 Jun 2014 13:17:49 +0200
parents
children 1a3817d84f39
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Core/RestApi/RestApiHierarchy.cpp	Mon Jun 30 13:17:49 2014 +0200
@@ -0,0 +1,408 @@
+/**
+ * Orthanc - A Lightweight, RESTful DICOM Store
+ * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege,
+ * Belgium
+ *
+ * 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 3 of the
+ * License, or (at your option) any later version.
+ *
+ * In addition, as a special exception, the copyright holders of this
+ * program give permission to link the code of its release with the
+ * OpenSSL project's "OpenSSL" library (or with modified versions of it
+ * that use the same license as the "OpenSSL" library), and distribute
+ * the linked executables. 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.
+ * 
+ * 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, see <http://www.gnu.org/licenses/>.
+ **/
+
+
+#include "RestApiHierarchy.h"
+
+#include <cassert>
+
+namespace Orthanc
+{
+  bool RestApiHierarchy::Handlers::IsEmpty() const
+  {
+    return (getHandlers_.empty() &&
+            postHandlers_.empty() &&
+            putHandlers_.empty() &&
+            deleteHandlers_.empty());
+  }
+
+
+  RestApiHierarchy& RestApiHierarchy::AddChild(Children& children,
+                                               const std::string& name)
+  {
+    Children::iterator it = children.find(name);
+
+    if (it == children.end())
+    {
+      // Create new child
+      RestApiHierarchy *child = new RestApiHierarchy;
+      children[name] = child;
+      return *child;
+    }
+    else
+    {
+      return *it->second;
+    }
+  }
+
+
+  void RestApiHierarchy::DeleteChildren(Children& children)
+  {
+    for (Children::iterator it = children.begin();
+         it != children.end(); it++)
+    {
+      delete it->second;
+    }
+  }
+
+
+  template <typename Handler>
+  void RestApiHierarchy::RegisterInternal(const RestApiPath& path,
+                                          Handler handler,
+                                          size_t level)
+  {
+    if (path.GetLevelCount() == level)
+    {
+      if (path.IsUniversalTrailing())
+      {
+        universalHandlers_.Register(handler);
+      }
+      else
+      {
+        handlers_.Register(handler);
+      }
+    }
+    else
+    {
+      RestApiHierarchy* child;
+      if (path.IsWildcardLevel(level))
+      {
+        child = &AddChild(wildcardChildren_, path.GetWildcardName(level));
+      }
+      else
+      {
+        child = &AddChild(children_, path.GetLevelName(level));
+      }
+
+      child->RegisterInternal(path, handler, level + 1);
+    }
+  }
+
+
+  bool RestApiHierarchy::LookupHandler(RestApiPath::Components& components,
+                                       const UriComponents& uri,
+                                       ResourceCallback callback,
+                                       size_t level,
+                                       void* call)
+  {
+    assert(uri.size() >= level);
+    UriComponents trailing;
+
+    // Look for an exact match on the resource of interest
+    if (uri.size() == level)
+    {
+      if (!handlers_.IsEmpty() &&
+          callback(handlers_, uri, components, trailing, call))
+      {
+        return true;
+      }
+    }
+
+
+    // Try and go down in the hierarchy, using an exact match for the child
+    Children::const_iterator child = children_.find(uri[level]);
+    if (child != children_.end())
+    {
+      if (child->second->LookupHandler(components, uri, callback, level + 1, call))
+      {
+        return true;
+      }
+    }
+
+
+    // Try and go down in the hierarchy, using wildcard rules for children
+    for (child = wildcardChildren_.begin();
+         child != wildcardChildren_.end(); child++)
+    {
+      RestApiPath::Components subComponents = components;
+      subComponents[child->first] = uri[level];
+
+      if (child->second->LookupHandler(components, uri, callback, level + 1, call))
+      {
+        return true;
+      }        
+    }
+
+
+    // As a last resort, call the universal handlers, if any
+    if (!universalHandlers_.IsEmpty())
+    {
+      trailing.resize(uri.size() - level);
+      size_t pos = 0;
+      for (size_t i = level; i < uri.size(); i++, pos++)
+      {
+        trailing[pos] = uri[i];
+      }
+
+      assert(pos == trailing.size());
+
+      if (callback(universalHandlers_, uri, components, trailing, call))
+      {
+        return true;
+      }
+    }
+
+    return false;
+  }
+
+
+  bool RestApiHierarchy::GetDirectory(Json::Value& result,
+                                      const UriComponents& uri,
+                                      size_t level)
+  {
+    if (uri.size() == level)
+    {
+      if (!handlers_.HasGet() && 
+          universalHandlers_.IsEmpty() &&
+          wildcardChildren_.size() == 0)
+      {
+        result = Json::arrayValue;
+
+        for (Children::const_iterator it = children_.begin();
+             it != children_.end(); it++)
+        {
+          result.append(it->first);
+        }
+
+        return true;
+      }
+      else
+      {
+        return false;
+      }
+    }
+
+    Children::const_iterator child = children_.find(uri[level]);
+    if (child != children_.end())
+    {
+      if (child->second->GetDirectory(result, uri, level + 1))
+      {
+        return true;
+      }
+    }
+
+    for (child = wildcardChildren_.begin(); 
+         child != wildcardChildren_.end(); child++)
+    {
+      if (child->second->GetDirectory(result, uri, level + 1))
+      {
+        return true;
+      }
+    }
+
+    return false;
+  }
+                       
+
+  bool RestApiHierarchy::GetCallback(Handlers& handlers,
+                                     const UriComponents& uri,
+                                     const RestApiPath::Components& components,
+                                     const UriComponents& trailing,
+                                     void* call)
+  {
+    for (Handlers::GetHandlers::iterator
+           it = handlers.getHandlers_.begin(); 
+         it != handlers.getHandlers_.end(); it++)
+    {
+      // TODO RETURN BOOL
+
+      (*it) (*reinterpret_cast<RestApi::GetCall*>(call));
+      return true;
+    }
+
+    return false;
+  }
+
+
+  bool RestApiHierarchy::PostCallback(Handlers& handlers,
+                                      const UriComponents& uri,
+                                      const RestApiPath::Components& components,
+                                      const UriComponents& trailing,
+                                      void* call)
+  {
+    for (Handlers::PostHandlers::iterator
+           it = handlers.postHandlers_.begin(); 
+         it != handlers.postHandlers_.end(); it++)
+    {
+      // TODO RETURN BOOL
+
+      (*it) (*reinterpret_cast<RestApi::PostCall*>(call));
+      return true;
+    }
+
+    return false;
+  }
+
+
+  bool RestApiHierarchy::PutCallback(Handlers& handlers,
+                                     const UriComponents& uri,
+                                     const RestApiPath::Components& components,
+                                     const UriComponents& trailing,
+                                     void* call)
+  {
+    for (Handlers::PutHandlers::iterator
+           it = handlers.putHandlers_.begin(); 
+         it != handlers.putHandlers_.end(); it++)
+    {
+      // TODO RETURN BOOL
+
+      (*it) (*reinterpret_cast<RestApi::PutCall*>(call));
+      return true;
+    }
+
+    return false;
+  }
+
+
+  bool RestApiHierarchy::DeleteCallback(Handlers& handlers,
+                                        const UriComponents& uri,
+                                        const RestApiPath::Components& components,
+                                        const UriComponents& trailing,
+                                        void* call)
+  {
+    for (Handlers::DeleteHandlers::iterator
+           it = handlers.deleteHandlers_.begin(); 
+         it != handlers.deleteHandlers_.end(); it++)
+    {
+      // TODO RETURN BOOL
+
+      (*it) (*reinterpret_cast<RestApi::DeleteCall*>(call));
+      return true;
+    }
+
+    return false;
+  }
+
+
+  RestApiHierarchy::~RestApiHierarchy()
+  {
+    DeleteChildren(children_);
+    DeleteChildren(wildcardChildren_);
+  }
+
+  void RestApiHierarchy::Register(const RestApiPath& path,
+                                  RestApi::GetHandler handler)
+  {
+    RegisterInternal(path, handler, 0);
+  }
+
+  void RestApiHierarchy::Register(const RestApiPath& path,
+                                  RestApi::PutHandler handler)
+  {
+    RegisterInternal(path, handler, 0);
+  }
+
+  void RestApiHierarchy::Register(const RestApiPath& path,
+                                  RestApi::PostHandler handler)
+  {
+    RegisterInternal(path, handler, 0);
+  }
+
+  void RestApiHierarchy::Register(const RestApiPath& path,
+                                  RestApi::DeleteHandler handler)
+  {
+    RegisterInternal(path, handler, 0);
+  }
+
+  void RestApiHierarchy::CreateSiteMap(Json::Value& target) const
+  {
+    if (children_.size() == 0)
+    {
+      std::string s = " ";
+      if (handlers_.getHandlers_.size() != 0)
+      {
+        s += "GET ";
+      }
+
+      if (handlers_.postHandlers_.size() != 0)
+      {
+        s += "POST ";
+      }
+
+      if (handlers_.putHandlers_.size() != 0)
+      {
+        s += "PUT ";
+      }
+
+      if (handlers_.deleteHandlers_.size() != 0)
+      {
+        s += "DELETE ";
+      }
+
+      target = s;
+    }
+    else
+    {
+      target = Json::objectValue;
+      
+      for (Children::const_iterator it = children_.begin();
+           it != children_.end(); it++)
+      {
+        it->second->CreateSiteMap(target[it->first]);
+      }
+    }
+      
+    /*for (Children::const_iterator it = wildcardChildren_.begin();
+      it != wildcardChildren_.end(); it++)
+      {
+      it->second->CreateSiteMap(target["* (" + it->first + ")"]);
+      }*/
+  }
+
+  bool RestApiHierarchy::Handle(RestApi::GetCall& call,
+                                const UriComponents& uri)
+  {
+    RestApiPath::Components components;
+    return LookupHandler(components, uri, GetCallback, 0, &call);
+  }    
+
+  bool RestApiHierarchy::Handle(RestApi::PutCall& call,
+                                const UriComponents& uri)
+  {
+    RestApiPath::Components components;
+    return LookupHandler(components, uri, PutCallback, 0, &call);
+  }    
+
+  bool RestApiHierarchy::Handle(RestApi::PostCall& call,
+                                const UriComponents& uri)
+  {
+    RestApiPath::Components components;
+    return LookupHandler(components, uri, PostCallback, 0, &call);
+  }    
+
+  bool RestApiHierarchy::Handle(RestApi::DeleteCall& call,
+                                const UriComponents& uri)
+  {
+    RestApiPath::Components components;
+    return LookupHandler(components, uri, DeleteCallback, 0, &call);
+  }    
+
+}