Merge pull request #202 from thecodefactory/web-default-page

thecodefactory · web-flow · commit 3af4105d8228 · 2019-05-27T21:09:54.000-04:00
Allow a built-in default page to be set and used.
diff --git a/Makefile.am b/Makefile.am
@@ -37,6 +37,7 @@ src_libbitcoin_protocol_la_LIBADD = ${zmq_LIBS} ${mbedtls_LIBS} ${bitcoin_system
 src_libbitcoin_protocol_la_SOURCES = \
     src/settings.cpp \
     src/web/connection.cpp \
+    src/web/default_page_data.cpp \
     src/web/json_string.cpp \
     src/web/manager.cpp \
     src/web/socket.cpp \
@@ -95,6 +96,7 @@ include_bitcoin_protocol_web_HEADERS = \
     include/bitcoin/protocol/web/bind_options.hpp \
     include/bitcoin/protocol/web/connection.hpp \
     include/bitcoin/protocol/web/connection_state.hpp \
+    include/bitcoin/protocol/web/default_page_data.hpp \
     include/bitcoin/protocol/web/event.hpp \
     include/bitcoin/protocol/web/file_transfer.hpp \
     include/bitcoin/protocol/web/http.hpp \
diff --git a/builds/cmake/CMakeLists.txt b/builds/cmake/CMakeLists.txt
@@ -179,6 +179,7 @@ add_definitions(
 add_library( ${CANONICAL_LIB_NAME}
     "../../src/settings.cpp"
     "../../src/web/connection.cpp"
+    "../../src/web/default_page_data.cpp"
     "../../src/web/json_string.cpp"
     "../../src/web/manager.cpp"
     "../../src/web/socket.cpp"
diff --git a/builds/msvc/vs2013/libbitcoin-protocol/libbitcoin-protocol.vcxproj b/builds/msvc/vs2013/libbitcoin-protocol/libbitcoin-protocol.vcxproj
@@ -75,6 +75,7 @@
   <ItemGroup>
     <ClCompile Include="..\..\..\..\src\settings.cpp" />
     <ClCompile Include="..\..\..\..\src\web\connection.cpp" />
+    <ClCompile Include="..\..\..\..\src\web\default_page_data.cpp" />
     <ClCompile Include="..\..\..\..\src\web\json_string.cpp" />
     <ClCompile Include="..\..\..\..\src\web\manager.cpp" />
     <ClCompile Include="..\..\..\..\src\web\socket.cpp">
@@ -103,6 +104,7 @@
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\bind_options.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\connection.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\connection_state.hpp" />
+    <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\default_page_data.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\event.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\file_transfer.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\http.hpp" />
diff --git a/builds/msvc/vs2013/libbitcoin-protocol/libbitcoin-protocol.vcxproj.filters b/builds/msvc/vs2013/libbitcoin-protocol/libbitcoin-protocol.vcxproj.filters
@@ -42,6 +42,9 @@
     <ClCompile Include="..\..\..\..\src\web\connection.cpp">
       <Filter>src\web</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\..\..\src\web\default_page_data.cpp">
+      <Filter>src\web</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\..\..\src\web\json_string.cpp">
       <Filter>src\web</Filter>
     </ClCompile>
@@ -110,6 +113,9 @@
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\connection_state.hpp">
       <Filter>include\bitcoin\protocol\web</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\default_page_data.hpp">
+      <Filter>include\bitcoin\protocol\web</Filter>
+    </ClInclude>
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\event.hpp">
       <Filter>include\bitcoin\protocol\web</Filter>
     </ClInclude>
diff --git a/builds/msvc/vs2015/libbitcoin-protocol/libbitcoin-protocol.vcxproj b/builds/msvc/vs2015/libbitcoin-protocol/libbitcoin-protocol.vcxproj
@@ -75,6 +75,7 @@
   <ItemGroup>
     <ClCompile Include="..\..\..\..\src\settings.cpp" />
     <ClCompile Include="..\..\..\..\src\web\connection.cpp" />
+    <ClCompile Include="..\..\..\..\src\web\default_page_data.cpp" />
     <ClCompile Include="..\..\..\..\src\web\json_string.cpp" />
     <ClCompile Include="..\..\..\..\src\web\manager.cpp" />
     <ClCompile Include="..\..\..\..\src\web\socket.cpp">
@@ -103,6 +104,7 @@
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\bind_options.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\connection.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\connection_state.hpp" />
+    <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\default_page_data.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\event.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\file_transfer.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\http.hpp" />
diff --git a/builds/msvc/vs2015/libbitcoin-protocol/libbitcoin-protocol.vcxproj.filters b/builds/msvc/vs2015/libbitcoin-protocol/libbitcoin-protocol.vcxproj.filters
@@ -42,6 +42,9 @@
     <ClCompile Include="..\..\..\..\src\web\connection.cpp">
       <Filter>src\web</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\..\..\src\web\default_page_data.cpp">
+      <Filter>src\web</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\..\..\src\web\json_string.cpp">
       <Filter>src\web</Filter>
     </ClCompile>
@@ -110,6 +113,9 @@
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\connection_state.hpp">
       <Filter>include\bitcoin\protocol\web</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\default_page_data.hpp">
+      <Filter>include\bitcoin\protocol\web</Filter>
+    </ClInclude>
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\event.hpp">
       <Filter>include\bitcoin\protocol\web</Filter>
     </ClInclude>
diff --git a/builds/msvc/vs2017/libbitcoin-protocol/libbitcoin-protocol.vcxproj b/builds/msvc/vs2017/libbitcoin-protocol/libbitcoin-protocol.vcxproj
@@ -75,6 +75,7 @@
   <ItemGroup>
     <ClCompile Include="..\..\..\..\src\settings.cpp" />
     <ClCompile Include="..\..\..\..\src\web\connection.cpp" />
+    <ClCompile Include="..\..\..\..\src\web\default_page_data.cpp" />
     <ClCompile Include="..\..\..\..\src\web\json_string.cpp" />
     <ClCompile Include="..\..\..\..\src\web\manager.cpp" />
     <ClCompile Include="..\..\..\..\src\web\socket.cpp">
@@ -103,6 +104,7 @@
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\bind_options.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\connection.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\connection_state.hpp" />
+    <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\default_page_data.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\event.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\file_transfer.hpp" />
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\http.hpp" />
diff --git a/builds/msvc/vs2017/libbitcoin-protocol/libbitcoin-protocol.vcxproj.filters b/builds/msvc/vs2017/libbitcoin-protocol/libbitcoin-protocol.vcxproj.filters
@@ -42,6 +42,9 @@
     <ClCompile Include="..\..\..\..\src\web\connection.cpp">
       <Filter>src\web</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\..\..\src\web\default_page_data.cpp">
+      <Filter>src\web</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\..\..\src\web\json_string.cpp">
       <Filter>src\web</Filter>
     </ClCompile>
@@ -110,6 +113,9 @@
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\connection_state.hpp">
       <Filter>include\bitcoin\protocol\web</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\default_page_data.hpp">
+      <Filter>include\bitcoin\protocol\web</Filter>
+    </ClInclude>
     <ClInclude Include="..\..\..\..\include\bitcoin\protocol\web\event.hpp">
       <Filter>include\bitcoin\protocol\web</Filter>
     </ClInclude>
diff --git a/include/bitcoin/protocol.hpp b/include/bitcoin/protocol.hpp
@@ -21,6 +21,7 @@
 #include <bitcoin/protocol/web/bind_options.hpp>
 #include <bitcoin/protocol/web/connection.hpp>
 #include <bitcoin/protocol/web/connection_state.hpp>
+#include <bitcoin/protocol/web/default_page_data.hpp>
 #include <bitcoin/protocol/web/event.hpp>
 #include <bitcoin/protocol/web/file_transfer.hpp>
 #include <bitcoin/protocol/web/http.hpp>
diff --git a/include/bitcoin/protocol/web/default_page_data.hpp b/include/bitcoin/protocol/web/default_page_data.hpp
@@ -0,0 +1,40 @@
+/**
+ * Copyright (c) 2011-2019 libbitcoin developers (see AUTHORS)
+ *
+ * This file is part of libbitcoin.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#ifndef LIBBITCOIN_PROTOCOL_WEB_DEFAULT_PAGE_DATA_HPP
+#define LIBBITCOIN_PROTOCOL_WEB_DEFAULT_PAGE_DATA_HPP
+
+#include <bitcoin/protocol/define.hpp>
+#include <bitcoin/protocol/settings.hpp>
+
+namespace libbitcoin {
+namespace protocol {
+namespace http {
+
+/// Given endpoints for each web service based on user configuration,
+/// we can generate default page data.
+std::string get_default_page_data(const bc::system::config::endpoint& query,
+    const bc::system::config::endpoint& heartbeat,
+    const bc::system::config::endpoint& block,
+    const bc::system::config::endpoint& transaction);
+
+} // namespace http
+} // namespace protocol
+} // namespace libbitcoin
+
+#endif
diff --git a/include/bitcoin/protocol/web/manager.hpp b/include/bitcoin/protocol/web/manager.hpp
@@ -72,6 +72,10 @@ class BCP_API manager
         const origin_list origins);
     ~manager();
 
+    // If the endpoint is reached and no default page can be found,
+    // send a response that includes this data.
+    void set_default_page_data(const std::string& data);
+
     bool initialize();
     bool bind(const system::config::endpoint& address,
         const bind_options& options);
@@ -141,6 +145,7 @@ class BCP_API manager
     system::shared_mutex task_mutex_;
 
     const origin_list origins_;
+    std::string page_data_;
 };
 
 } // namespace http
diff --git a/include/bitcoin/protocol/web/socket.hpp b/include/bitcoin/protocol/web/socket.hpp
@@ -129,6 +129,10 @@ class BCP_API socket
     // Send a message to every connected websocket client.
     void broadcast(const std::string& json);
 
+    // Optionally set a fixed reply instead of returning a 404 not found if
+    // the web root cannot be found.
+    void set_default_page_data(const std::string& data);
+
     // The zmq socket operates on only this one thread.
     bc::protocol::zmq::context& context_;
     const bool secure_;
diff --git a/src/settings.cpp b/src/settings.cpp
@@ -37,11 +37,10 @@ settings::settings()
     send_milliseconds(0),
     web_priority(false),
     web_origins({}),
-    web_root("web"),
+    web_root(""),
     web_ca_certificate(""),
-    web_server_private_key("key.pem"),
-    web_server_certificate("server.pem"),
-    web_client_certificates("clients")
+    web_server_private_key(""),
+    web_server_certificate("")
 {
 }
 
@@ -56,11 +55,10 @@ settings::settings(uint32_t send_high_water, uint32_t receive_high_water)
     send_milliseconds(0),
     web_priority(false),
     web_origins({}),
-    web_root("web"),
+    web_root(""),
     web_ca_certificate(""),
-    web_server_private_key("key.pem"),
-    web_server_certificate("server.pem"),
-    web_client_certificates("clients")
+    web_server_private_key(""),
+    web_server_certificate("")
 {
 }
 
diff --git a/src/web/default_page_data.cpp b/src/web/default_page_data.cpp
diff --git a/src/web/manager.cpp b/src/web/manager.cpp
diff --git a/src/web/socket.cpp b/src/web/socket.cpp
