Merge pull request #10 from AtlasSystems/feature/addUserAgent

Send UserAgent in API calls

Author: amorgan-atlas-sys

Aeon-ArchivesSpace-Addon/Aeon-ArchivesSpace.lua

@@ -25,10 +25,13 @@ settings.AutoGroupResults = GetSetting("AutoGroupResults");
 local types = {};
 
 luanet.load_assembly("System.Net");
+luanet.load_assembly("System.Windows.Forms");
+
 types["System.Net.WebClient"] = luanet.import_type("System.Net.WebClient");
 types["System.IO.StreamReader"] = luanet.import_type("System.IO.StreamReader");
 types["System.Text.Encoding"] = luanet.import_type("System.Text.Encoding");
 types["System.DBNull"] = luanet.import_type("System.DBNull");
+types["System.Windows.Forms.Application"] = luanet.import_type("System.Windows.Forms.Application");
 
 luanet.load_assembly("System");
 types["System.Collections.Specialized.NameValueCollection"] = luanet.import_type("System.Collections.Specialized.NameValueCollection");
@@ -80,10 +83,20 @@ local archiveSpaceAddonScript = [[
                 var objectUrl = buildObjectUrl(objectId);
                 atlasAddonAsync.executeAddonFunction('NodeChanged', currentRepositoryPath, objectUrl);
 
+                //Try to get the app_prefix to remove any additional web paths from the URL
+                var appPrefix = "/";
+                if (AS) {
+                    appPrefix = AS.app_prefix("");
+                }
+
                 // This Injects the NodeChanged function into the Ajax callback that changes the record pages
                 var originalAjaxThePane = AjaxTree.prototype._ajax_the_pane;
                 AjaxTree.prototype._ajax_the_pane = function(url, params, callback) {
-                    atlasAddonAsync.executeAddonFunction('NodeChanged', currentRepositoryPath, url);
+                    //If the appPrefix is anything other than "/", replace it with just "/"
+                    var updateUrl = url.replace(appPrefix, "/");
+                    updateUrl.startsWith(updateUrl) ? updateUrl : "/" + updateUrl;
+                    atlasAddonAsync.executeAddonFunction('NodeChanged', currentRepositoryPath, updateUrl);
+                    //Preserve the original call using the original ASpace URL parameter
                     originalAjaxThePane.call(this, url, params, callback);
                 };
             }
@@ -164,6 +177,10 @@ function Init()
     catalogSearchForm.Browser:Navigate(settings.BaseURL);
 end
 
+function Version()
+	return types["System.Windows.Forms.Application"].ProductVersion;
+end
+
 function WebView2Enabled()
     return AddonInfo.Browsers ~= nil and AddonInfo.Browsers.WebView2 ~= nil and AddonInfo.Browsers.WebView2 == true;
 end
@@ -745,8 +762,10 @@ function SendApiRequest(apiPath, method, parameters, authToken)
     LogDebug('apiPath: ' .. apiPath);
 
     local webClient = types["System.Net.WebClient"]();
-
+    webClient.Encoding = types["System.Text.Encoding"].UTF8;
     webClient.Headers:Clear();
+    -- Add a user-agent for the API request to support ArchivesSpace API hosted by Lyrasis
+    webClient.Headers:Add("user-agent", "AtlasAeon/" .. Version());
     if (authToken ~= nil and authToken ~= "") then
         webClient.Headers:Add("X-ArchivesSpace-Session", authToken);
     end

Aeon-ArchivesSpace-Addon/Config.xml

@@ -2,7 +2,7 @@
 <Configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <Name>ArchivesSpace Interface</Name>
   <Author>Atlas Systems, Inc.</Author>
-  <Version>3.0.2</Version>
+  <Version>3.0.3</Version>
   <Active>True</Active>
   <Type>Addon</Type>
   <Description>This addon performs searches in ArchivesSpace using the staff interface. This addon supports ArchivesSpace versions v2.8.0 and later.</Description>

Readme.md

@@ -1,6 +1,11 @@
 # Aeon ArchivesSpace Client Addon
 
 ## Version
+
+- 3.0.3:
+    - A UserAgent HTTP Header is sent in API calls to better support ArchivesSapces hosted by Lyrasis.
+    - Better support for ArchivesSpace LibraryHost instances where the AppPrefix is not standard.
+    - Set API to use UTF8 for ArchivesSpace API requests
 - 3.0:
     - Added support for embedded WebView2 browser. The addon will use this browser if it is available (Aeon 5.2+), and will use the embedded Chromium browser otherwise.
 - 2.1: