add user agent adhereing to RFC format

Author: sudo87

api/src/main/java/org/apache/cloudstack/api/ApiConstants.java

@@ -1364,8 +1364,6 @@ public class ApiConstants {
 
     public static final String RECURSIVE_DOMAINS = "recursivedomains";
 
-    public static final String CLOUDSTACK_USER_AGENT = "CloudStack-Agent";
-
     /**
      * This enum specifies IO Drivers, each option controls specific policies on I/O.
      * Qemu guests support "threads" and "native" options Since 0.8.8 ; "io_uring" is supported Since 6.3.0 (QEMU 5.0).

core/src/main/java/com/cloud/storage/template/HttpTemplateDownloader.java

@@ -20,7 +20,6 @@
 package com.cloud.storage.template;
 
 import static com.cloud.utils.NumbersUtil.toHumanReadableSize;
-import static org.apache.cloudstack.api.ApiConstants.CLOUDSTACK_USER_AGENT;
 
 import java.io.File;
 import java.io.IOException;
@@ -53,6 +52,7 @@
 import com.cloud.utils.Pair;
 import com.cloud.utils.UriUtils;
 import com.cloud.utils.exception.CloudRuntimeException;
+import com.cloud.utils.net.HttpClientCloudStackUserAgent;
 import com.cloud.utils.net.Proxy;
 
 /**
@@ -126,7 +126,7 @@ private GetMethod createRequest(String downloadUrl) {
         GetMethod request = new GetMethod(downloadUrl);
         request.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, myretryhandler);
         request.setFollowRedirects(followRedirects);
-        request.getParams().setParameter(HttpMethodParams.USER_AGENT,  CLOUDSTACK_USER_AGENT);
+        request.getParams().setParameter(HttpMethodParams.USER_AGENT, HttpClientCloudStackUserAgent.CLOUDSTACK_USER_AGENT);
         return request;
     }
 

core/src/main/java/com/cloud/storage/template/MetalinkTemplateDownloader.java

@@ -18,10 +18,11 @@
 //
 package com.cloud.storage.template;
 
-import static org.apache.cloudstack.api.ApiConstants.CLOUDSTACK_USER_AGENT;
 
 import com.cloud.storage.StorageLayer;
 import com.cloud.utils.UriUtils;
+import com.cloud.utils.net.HttpClientCloudStackUserAgent;
+
 import org.apache.commons.httpclient.HttpClient;
 import org.apache.commons.httpclient.HttpMethod;
 import org.apache.commons.httpclient.HttpMethodRetryHandler;
@@ -61,7 +62,7 @@ protected GetMethod createRequest(String downloadUrl) {
         GetMethod request = new GetMethod(downloadUrl);
         request.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, myretryhandler);
         request.setFollowRedirects(followRedirects);
-        request.getParams().setParameter(HttpMethodParams.USER_AGENT, CLOUDSTACK_USER_AGENT);
+        request.getParams().setParameter(HttpMethodParams.USER_AGENT, HttpClientCloudStackUserAgent.CLOUDSTACK_USER_AGENT);
         if (!toFileSet) {
             String[] parts = downloadUrl.split("/");
             String filename = parts[parts.length - 1];

core/src/main/java/com/cloud/storage/template/SimpleHttpMultiFileDownloader.java

@@ -18,7 +18,6 @@
 package com.cloud.storage.template;
 
 import static com.cloud.utils.NumbersUtil.toHumanReadableSize;
-import static org.apache.cloudstack.api.ApiConstants.CLOUDSTACK_USER_AGENT;
 
 import java.io.File;
 import java.io.IOException;
@@ -45,6 +44,7 @@
 import org.apache.commons.lang3.StringUtils;
 
 import com.cloud.storage.StorageLayer;
+import com.cloud.utils.net.HttpClientCloudStackUserAgent;
 
 public class SimpleHttpMultiFileDownloader extends ManagedContextRunnable implements TemplateDownloader {
     private static final MultiThreadedHttpConnectionManager s_httpClientManager = new MultiThreadedHttpConnectionManager();
@@ -96,7 +96,7 @@ private GetMethod createRequest(String downloadUrl) {
         GetMethod request = new GetMethod(downloadUrl);
         request.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, retryHandler);
         request.setFollowRedirects(followRedirects);
-        request.getParams().setParameter(HttpMethodParams.USER_AGENT,  CLOUDSTACK_USER_AGENT);
+        request.getParams().setParameter(HttpMethodParams.USER_AGENT, HttpClientCloudStackUserAgent.CLOUDSTACK_USER_AGENT);
         return request;
     }
 

core/src/main/java/org/apache/cloudstack/direct/download/HttpDirectTemplateDownloader.java

@@ -19,7 +19,6 @@
 
 package org.apache.cloudstack.direct.download;
 
-import static org.apache.cloudstack.api.ApiConstants.CLOUDSTACK_USER_AGENT;
 
 import java.io.File;
 import java.io.FileOutputStream;
@@ -34,6 +33,7 @@
 import com.cloud.utils.Pair;
 import com.cloud.utils.UriUtils;
 import com.cloud.utils.exception.CloudRuntimeException;
+import com.cloud.utils.net.HttpClientCloudStackUserAgent;
 import com.cloud.utils.storage.QCOW2Utils;
 import org.apache.commons.collections.MapUtils;
 import org.apache.commons.httpclient.HttpClient;
@@ -71,7 +71,7 @@ public HttpDirectTemplateDownloader(String url, Long templateId, String destPool
     protected GetMethod createRequest(String downloadUrl, Map<String, String> headers) {
         GetMethod request = new GetMethod(downloadUrl);
         request.setFollowRedirects(this.isFollowRedirects());
-        request.getParams().setParameter(HttpMethodParams.USER_AGENT,  CLOUDSTACK_USER_AGENT);
+        request.getParams().setParameter(HttpMethodParams.USER_AGENT, HttpClientCloudStackUserAgent.CLOUDSTACK_USER_AGENT);
         if (MapUtils.isNotEmpty(headers)) {
             for (String key : headers.keySet()) {
                 request.setRequestHeader(key, headers.get(key));

utils/src/main/java/com/cloud/utils/net/HttpClientCloudStackUserAgent.java

@@ -0,0 +1,39 @@
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+
+package com.cloud.utils.net;
+
+import org.apache.logging.log4j.util.Strings;
+
+public class HttpClientCloudStackUserAgent {
+    public static final String CLOUDSTACK_USER_AGENT = buildUserAgent();
+
+    private static String buildUserAgent() {
+        String version = HttpClientCloudStackUserAgent.class
+                .getPackage()
+                .getImplementationVersion();
+
+        if (Strings.isBlank(version)) {
+            version = "unknown";
+        }
+        return "CloudStack-Agent/" + version + " (Apache CloudStack)";
+    }
+
+    private HttpClientCloudStackUserAgent() {}
+}