サーバーのURLとBearer認証トークンを設定できるようにしました。サーバー仕様変更に対応。 (Synesthesias#144)

* APIのエンドポイントを変更

* 同上

* サーバーから受け取るmaxLodの値を文字列型から数値型にした。

* sdk/datasetsのmaxLod削除

* GmlFile::FetchでClientを指定できるように対応(C++サイド)

* GmlFile::Fetchでclientを指定できるように対応(C#サイド)

* デフォルトトークン取得

* トークン指定

* コード整理

* サーバートークン

* サーバーに関するコメント変更

* 同上

* デフォルトURLはC#からアクセスしないようにした。

* デフォルトURL・トークンの取得を無名関数に

Author: linoal

examples/https_mock_test/https_mock_test.cpp

@@ -1,9 +1,7 @@
 #include <plateau/network/client.h>
 
 int main(void) {
-    plateau::network::Client client;
-
-    client.setApiServerUrl(plateau::network::Client::getDefaultServerUrl());
+    const auto client = plateau::network::Client::createClientForMockServer();
 
     // check Client::getMetadata
     auto meta_data_ptr = client.getMetadata();
@@ -17,14 +15,13 @@ int main(void) {
             std::cout << "  id : " << meta_data[i].datasets[j].id << std::endl;
             std::cout << "  title : " << meta_data[i].datasets[j].title << std::endl;
             std::cout << "  description : " << meta_data[i].datasets[j].description << std::endl;
-            std::cout << "  max_lod : " << meta_data[i].datasets[j].max_lod << std::endl;
             std::cout << "  feature_types : ";
             for(int k = 0; k < meta_data[i].datasets[j].feature_types.size(); k++) std::cout << meta_data[i].datasets[j].feature_types[k] << " ,";
             std::cout << std::endl;
         }
     }
 
     // check Client::download
-    auto fpath = client.download(".", plateau::network::Client::getDefaultServerUrl() + "/13100_tokyo23-ku_2020_citygml_3_2_op/udx/bldg/53392642_bldg_6697_2_op.gml");
+    auto fpath = client.download(".", plateau::network::Client::getMockServerUrl() + "/13100_tokyo23-ku_2020_citygml_3_2_op/udx/bldg/53392642_bldg_6697_2_op.gml");
     std::cout << "gml @ " << fpath << std::endl;
 }

include/plateau/dataset/dataset_source.h

@@ -10,10 +10,13 @@ namespace plateau::network {
 namespace plateau::dataset {
     /**
      * PLATEAUデータ一式を表現したクラスです。
-     * 保持している IDatasetAccessor によってGMLファイルの検索ができます。
+     * 保持している IDatasetAccessor によってGMLファイルの検索・取得ができます。
      * データの場所が ローカルPCか APIサーバーかは DatasetSource の作成時にはっきりさせたいので、
      * デフォルトコンストラクタの代わりに createLocal または createServer を利用してください。
      * 表記例: new DatasetSource(DatasetSource::createServer("23ku"));
+     *
+     * 他クラスとの関係:
+     * DatasetSource -> (保持) -> IDatasetAccessor (すなわち ServerDatasetAccessor または LocalDatasetAccessor)
      */
     class LIBPLATEAU_EXPORT DatasetSource {
     public:

include/plateau/dataset/gml_file.h

@@ -3,6 +3,7 @@
 #include <libplateau_api.h>
 #include <plateau/dataset/mesh_code.h>
 #include <set>
+#include <optional>
 #include "plateau/network/client.h"
 
 namespace plateau::dataset {
@@ -13,7 +14,7 @@ namespace plateau::dataset {
     class LIBPLATEAU_EXPORT GmlFile {
     public:
         explicit GmlFile(const std::string& path);
-        explicit GmlFile(const std::string& path, const int max_lod);
+        GmlFile(const std::string& path, const network::Client& client, int max_lod = -1);
 
 
         const std::string& getPath() const;
@@ -64,6 +65,9 @@ namespace plateau::dataset {
         bool is_local_;
         int max_lod_;
 
+        /// サーバーモード(is_local_ が falseのとき)のみ利用します。ダウンロードに使用するクライアントです。
+        std::optional<network::Client> client_;
+
         void applyPath();
     };
 }

include/plateau/network/client.h

@@ -12,7 +12,6 @@ namespace plateau::network {
         std::string id;
         std::string title;
         std::string description;
-        int max_lod = 0;
         std::vector<std::string> feature_types;
     };
 
@@ -46,18 +45,35 @@ namespace plateau::network {
      */
     class LIBPLATEAU_EXPORT Client {
     public:
-        explicit Client(const std::string& server_url = "");
+        /**
+         * @param server_url 接続先のURLです。空文字の場合、デフォルトのものを利用します。
+         * @param api_token 接続時のBearer認証トークンです。空文字の場合、デフォルトのものを利用します。
+         */
+        Client(const std::string& server_url, const std::string& api_token);
+
+        static Client createClientForMockServer();
 
         std::string getApiServerUrl() const;
         void setApiServerUrl(const std::string& url);
+        void setApiToken(const std::string& api_token);
         std::shared_ptr<std::vector<DatasetMetadataGroup>> getMetadata() const;
         void getMetadata(std::vector<DatasetMetadataGroup>& out_metadata_groups) const;
+
+        /**
+         * @brief サーバーから json を受け取り、それをパースしてデータファイルに関する情報を得ます。
+         * 受け取る json の例 : https://plateau-api-mock-v2.deta.dev/sdk/datasets/23ku/files
+         */
         DatasetFiles getFiles(const std::string& id) const;
         std::string download(const std::string& destination_directory_path, const std::string& url) const;
 
-        static const std::string& getDefaultServerUrl();
+        /// 開発用に用意したモックサーバーのURLです。
+        static const std::string& getMockServerUrl();
 
     private:
         std::string server_url_;
+        std::string api_token_;
+
+        static std::string endPointUrlForMetadataGroups() { return "/sdk/datasets"; }
+        static std::string endPointUrlForFiles(const std::string& id) { return "/sdk/datasets/" + id + "/files"; }
     };
 }

src/c_wrapper/client_c.cpp

@@ -5,8 +5,15 @@ extern "C" {
 using namespace plateau::network;
 using namespace libplateau;
 
-DLL_CREATE_FUNC(plateau_create_client,
-                Client)
+DLL_3_ARG_FUNC(plateau_create_client,
+                const Client** const out_client_ptr,
+                const char* const server_url,
+                const char* const api_token,
+                *out_client_ptr = new Client(server_url, api_token))
+
+DLL_1_ARG_FUNC(plateau_create_client_for_mock_server,
+               const Client** const out_client_ptr,
+               *out_client_ptr = new Client(Client::createClientForMockServer()))
 
 DLL_DELETE_FUNC(plateau_delete_client,
                 Client)
@@ -32,7 +39,8 @@ DLL_4_ARG_FUNC(plateau_client_download,
                std::string* const out_downloaded_path,
                *out_downloaded_path = client->download(destination_directory, url) )
 
-DLL_1_ARG_FUNC(plateau_client_get_default_url,
-               std::string* out_default_url,
-               *out_default_url = Client::getDefaultServerUrl())
+
+DLL_1_ARG_FUNC(plateau_client_get_mock_server_url,
+               std::string* out_mock_server_url,
+               *out_mock_server_url = Client::getMockServerUrl())
 }

src/c_wrapper/dataset_metadata_c.cpp

@@ -23,11 +23,6 @@ DLL_STRING_PTR_FUNC(plateau_dataset_metadata_get_description,
                     DatasetMetadata,
                     handle->description)
 
-DLL_VALUE_FUNC(plateau_dataset_metadata_get_max_lod,
-               DatasetMetadata,
-               int,
-               handle->max_lod)
-
 DLL_2_ARG_FUNC(plateau_dataset_metadata_get_feature_types,
                const DatasetMetadata* const meta_data,
                std::vector<std::string>* const feature_types,

src/dataset/gml_file.cpp

@@ -27,12 +27,15 @@ namespace plateau::dataset {
 
     GmlFile::GmlFile(const std::string& path) // NOLINT
             : path_(path), is_valid_(false), is_local_(true), max_lod_(-1) {
+        // 上の行の is_valid_ と is_local_ の設定は一時的なもので、すぐ applyPath() によって書き換えられます。
         applyPath();
     }
 
-    GmlFile::GmlFile(const std::string& path, const int max_lod) // NOLINT
-            : path_(path), is_valid_(false), is_local_(true), max_lod_(max_lod) {
-        applyPath();
+    /// サーバーモードで使うコンストラクタです。GMLファイルのダウンロードに使う Client を指定します。
+    GmlFile::GmlFile(const std::string& path, const network::Client& client, int max_lod)
+    : GmlFile(path){
+        client_ = client;
+        max_lod_ = max_lod;
     }
 
     const std::string& GmlFile::getPath() const {
@@ -281,10 +284,9 @@ namespace plateau::dataset {
         }
 
         void fetchServer(const fs::path& gml_file_path, const fs::path& gml_relative_path_from_udx, const fs::path& destination_udx_path,
-                         const fs::path& gml_destination_path, GmlFile& copied_gml_file) {
+                         const fs::path& gml_destination_path, GmlFile& copied_gml_file, const network::Client& client) {
             auto destination_dir = gml_destination_path.parent_path();
             // gmlファイルをダウンロードします。
-            auto client = Client();
             client.download(destination_dir.u8string(), gml_file_path.u8string());
             auto downloaded_path = destination_dir;
             downloaded_path /= gml_file_path.filename();
@@ -330,11 +332,16 @@ namespace plateau::dataset {
         prepareFetch(fs::u8path(getPath()), fs::u8path(destination_root_path), gml_relative_path_from_udx, destination_udx_path,
                      gml_destination_path);
         if (is_local_) {
+            // ローカルモード
             fetchLocal(fs::u8path(path_), gml_relative_path_from_udx, destination_udx_path, gml_destination_path,
                        copied_gml_file);
         } else {
+            // サーバーモード
+            if (!client_.has_value()) {
+                throw std::runtime_error("Client is nullopt.");
+            }
             fetchServer(fs::u8path(path_), gml_relative_path_from_udx, destination_udx_path, gml_destination_path,
-                        copied_gml_file);
+                        copied_gml_file, client_.value());
         }
     }
 

src/dataset/local_dataset_accessor.h

@@ -6,6 +6,7 @@
 namespace plateau::dataset {
     /**
      * \brief ローカルPCに存在するPLATEAUの3D都市モデルデータ製品へのアクセスを提供します。
+     * 他クラスとの関係については、 DatasetSource のコメントを参照してください。
      */
     class LIBPLATEAU_EXPORT LocalDatasetAccessor : public IDatasetAccessor {
     public:

src/dataset/server_dataset_accessor.cpp

@@ -44,7 +44,7 @@ namespace plateau::dataset {
         for (const auto& [sub_folder, gml_files] : dataset_files_) {
             if (UdxSubFolder::getPackage(sub_folder) == package) {
                 for (const auto& dataset_file : gml_files) {
-                    out_gml_files.emplace_back(dataset_file.url, dataset_file.max_lod);
+                    out_gml_files.emplace_back(dataset_file.url, client_, dataset_file.max_lod);
                 }
             }
         }

src/dataset/server_dataset_accessor.h

@@ -6,6 +6,7 @@
 namespace plateau::dataset {
     /**
      * \brief サーバー上のPLATEAUデータセットに対して、データの検索等を行います。
+     * 他クラスとの関係 については DatasetSource のコメントを参照してください。
      */
     class LIBPLATEAU_EXPORT ServerDatasetAccessor : public IDatasetAccessor {
     public: