Add ArcGis key option to InterSpec_app_settings.json.

Author: wcjohns

InterSpec/InterSpecServer.h

@@ -284,6 +284,13 @@ namespace InterSpecServer
     /** If true, will open the WebView inspector console on launch. */
     bool m_open_dev_tools;
 
+#if( USE_LEAFLET_MAP )
+    /** The key to use to access the https://arcgis.com server to get map tiles from.
+     This value overides the default one built into InterSpec, if specified.
+     */
+    std::string m_arcgis_key;
+#endif
+    
     /** Returns application config, as determined from defaults and then 
     InterSpec_app_settings.json files.
 

InterSpec/LeafletRadMap.h

@@ -96,12 +96,13 @@ class LeafletRadMap : public Wt::WContainerWidget
 
 #if( BUILD_AS_ELECTRON_APP || IOS || ANDROID || BUILD_AS_OSX_APP || BUILD_AS_LOCAL_SERVER || BUILD_AS_WX_WIDGETS_APP )
   /** Look in the users data directory for a file named "arcgis\_key.txt", whose contents is the arcgis access key.
+   If that file isnt present, will look in `InterSpec_app_settings.json` file for a "ArcGisKey" value to use.
    
    Newlines, whitespaces, and some other invalid characters are discarded.
    
-   If the file does not exist, an empty string is returned.
-   If the file exists, but after removing invalid characters, it is less than 6 characters, then "empty" is returned.
-   If the file exists, and has a somewhat valid seeming contents, will return those.
+   If the file(s) do not exist, an empty string is returned.
+   If a file exists, but after removing invalid characters, it is less than 6 characters, then "empty" is returned.
+   If a file exists, and has a somewhat valid seeming contents, will return those.
    
    \sa InterSpec::writableDataDirectory
    */

data/config/example_InterSpec_app_settings.json

@@ -1,19 +1,22 @@
 {
-  "Usage": "Rename this file to 'InterSpec_app_settings.json' and placed either in the 'data' folder of the InterSpec distribution, or in the user data store (see 'Help' -> 'About InterSpec...' -> 'Data', for example on Windows: 'C:\\Users\\<username>\\AppData\\Roaming\\InterSpec'", 
-  "Purpose": "This file allows you to change settings for how InterSpec is launched; only intended for debugging or advanced usuage.  You must close all InterSpec windows before settings will take effect.", 
+  "Usage": "Rename this file to 'InterSpec_app_settings.json' and placed either in the 'data' folder of the InterSpec distribution, or in the user data store (see 'Help' -> 'About InterSpec...' -> 'Data', for example on Windows: 'C:\\Users\\<username>\\AppData\\Roaming\\InterSpec'.  All settings in this file are optional, so you can remove any settings you dont want to change/specify, and the default values will be used for that setting.", 
+  "Purpose": "This file allows you to change settings for how InterSpec is launched; only intended for debugging or advanced usage.  You must close all InterSpec windows before settings will take effect.", 
 
   "ProxySetting": "",
-  "ProxySetting_Documentation": "Only applicable to Windows and Linux builds. Valid values are: empty (default), 'direct', 'auto_detect', 'system'; any other string will be interpreted as the 'proxyRules' setting documented at https://www.electronjs.org/docs/latest/api/session#sessetproxyconfig (an value might be 'http=proxy.somecompany.com:80,direct://'). This setting is only applicable if you use the map tool (the only part of InterSpec to use the internet); if map tiles wont load, and you are behind a proxy, you may need to set this setting; usually a value of 'system' will work.  If you set this settting, and you are not behind a proxy, InterSpec startup time may hang for ~30 seconds, usually with a white screen, while a proxy request times out.",
+  "ProxySetting_Documentation": "Only applicable to Windows and Linux builds. Valid values are: empty (default), 'direct', 'auto_detect', 'system'; any other string will be interpreted as the 'proxyRules' setting documented at https://www.electronjs.org/docs/latest/api/session#sessetproxyconfig (an value might be 'http=proxy.somecompany.com:80,direct://'). This setting is only applicable if you use the map tool (the only part of InterSpec to use the internet); if map tiles wont load, and you are behind a proxy, you may need to set this setting; usually a value of 'system' will work.  If you set this setting, and you are not behind a proxy, InterSpec startup time may hang for ~30 seconds, usually with a white screen, while a proxy request times out.",
 
   "HttpPortToServeOn": 0,
-  "HttpPortToServeOn_Documentation": "The HTTP port to serve the application on; if zero (recomended!), will choose random port on startup.  Otherwise choose a port larger than 1024 (e.x., 8080) since ports below this may require admin privledges (never run InterSpec as admin!).",
+  "HttpPortToServeOn_Documentation": "The HTTP port to serve the application on; if zero (recommended!), will choose random high-numbered port on startup.  Otherwise you can choose a port larger than 1024 (e.x., 8080) since ports below this may require admin privileges (never run InterSpec as admin!).  If you specify a non-zero value, then only one session of InterSpec can run on your computer at a time (although that one session may have multiple windows open).",
 
   "RestorePreviousSession": true,
   "RestorePreviousSession_Documentation": "When true (default), InterSpec may attempt to restore your previous session in InterSpec.",
 
   "AllowTokenFreeSessions": false,
-  "AllowTokenFreeSessions_Documentation": "Normally external sessions (i.e. 'View' -> 'Use in external browser') get assigned a one-time-use token that is required to load InterSpec into the browser.  Without a valid token, you cant load a session in the browser.  If you allow external sessions without tokens, then the token wont be needed - and any application that can access your localhost network can create a session and potentually access your data.  It is not recomended to to enable this setting.",
+  "AllowTokenFreeSessions_Documentation": "Normally external sessions (i.e. 'View' -> 'Use in external browser') get assigned a one-time-use token that is required to load InterSpec into the browser.  Without a valid token, you cant load a session in the browser.  If you allow external sessions without tokens, then the token wont be needed - and any application that can access your localhost network (i.e., your computers internal network that is only accessible on your computer) can create a session and potentially access your data.  It is not recommended to to enable this setting.",
 
   "OpenDevTools": false,
-  "OpenDevTools_Documentation": "Enables right-clicking on an element to open the WebView Dev Tools to allow debugging JavaScript errors you may run into (please report to InterSpec@sandia.gov if you find any).  On macOS you will still need to select 'Edit' -> 'Enable Web Inspector'." 
+  "OpenDevTools_Documentation": "Enables right-clicking on an element to open the WebView Dev Tools to allow debugging JavaScript errors you may run into (please report to InterSpec@sandia.gov if you find any).  On macOS you will still need to select 'Edit' -> 'Enable Web Inspector'.",
+
+  "ArcGisKey": "",
+  "ArcGisKey_Documentation": "If specified (i.e., non-empty string), this key will be used to use to access the https://arcgis.com server to get map tiles from, when you invoke invoke the map tool."
 }

src/InterSpecServer.cpp

@@ -920,6 +920,9 @@ std::string file_to_open_on_load( const std::string &session_token )
     m_require_token( true ),
     m_allow_restore( true ),
     m_open_dev_tools( true )
+#if( USE_LEAFLET_MAP )
+    , m_arcgis_key("")
+#endif
   {
   }
 
@@ -1003,6 +1006,18 @@ std::string file_to_open_on_load( const std::string &session_token )
 
         config.m_open_dev_tools = val.toBool();
       }
+      
+#if( USE_LEAFLET_MAP )
+      if( base.contains( "ArcGisKey" ) )
+      {
+        const Wt::Json::Value &val = base.get( "ArcGisKey" );
+        if( val.type() != Wt::Json::Type::StringType )
+          throw runtime_error( "ArcGisKey must be string" );
+
+        config.m_arcgis_key = val.orIfNull("");
+      }
+#endif //USE_LEAFLET_MAP
+      
     };// update_config_from_json_file lamda
 
 

src/LeafletRadMap.cpp

@@ -55,6 +55,7 @@
 #if( BUILD_AS_ELECTRON_APP || IOS || ANDROID || BUILD_AS_OSX_APP || BUILD_AS_LOCAL_SERVER || BUILD_AS_WX_WIDGETS_APP )
 #include <Wt/Utils>
 #include "SpecUtils/Filesystem.h"
+#include "InterSpec/InterSpecServer.h"
 #endif
 
 
@@ -260,15 +261,37 @@ std::string LeafletRadMap::get_user_arcgis_key()
 {
   try
   {
+    // A user specified arcgis 
     const string user_data_dir = InterSpec::writableDataDirectory();
     const string user_key_file = SpecUtils::append_path(user_data_dir, "arcgis_key.txt" );
 
+    string user_key;
+    
+    
     if( !SpecUtils::is_file( user_key_file ) )
-      return "";
-      
-    std::vector<char> data;
-    SpecUtils::load_file_data( user_key_file.c_str(), data );
-    string user_key( begin(data), end(data) );
+    {
+      try
+      {
+        const string app_data_dir = InterSpec::staticDataDirectory();
+        
+        const InterSpecServer::DesktopAppConfig app_config
+                      = InterSpecServer::DesktopAppConfig::init( app_data_dir, user_data_dir );
+        
+        if( app_config.m_arcgis_key.empty() )
+          return "";
+        
+        user_key = app_config.m_arcgis_key;
+      }catch( std::exception & )
+      {
+        // This error would have already been reported to the user on application startup.
+        return "";
+      }
+    }else
+    {
+      std::vector<char> data;
+      SpecUtils::load_file_data( user_key_file.c_str(), data );
+      user_key = string( begin(data), end(data) );
+    }//if( "arcgis_key.txt" not present ) / else ( "arcgis_key.txt" is present )
 
     // Remove characters we dont expect
     while( !user_key.empty() )