aliyun-net-sdk-core/Http/UserAgent.cs

/*
 * 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.
 */

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Text;
using System.Text.RegularExpressions;

using Aliyun.Acs.Core.Utils;

namespace Aliyun.Acs.Core.Http
{
    public class UserAgent
    {
        private static string DEFAULT_MESSAGE;

        private readonly List<string> excludedList = new List<string>();
        private readonly Dictionary<string, string> userAgent = new Dictionary<string, string>();

        static UserAgent()
        {
            DEFAULT_MESSAGE = "Alibaba Cloud (" + GetOsVersion() + ") " + GetClientVersion(RuntimeEnvironment.GetRuntimeDirectory()) + " Core/" + Assembly.GetExecutingAssembly().GetName().Version.ToString();
        }

        public UserAgent()
        {
            SetTheValue();
        }

        public void SetTheValue()
        {
            excludedList.Add("core");
            excludedList.Add("microsoft.netcore.app");
        }

        private static string GetOsVersion()
        {
#if NETSTANDARD2_0
            return RuntimeInformation.OSDescription;
#else
            return Environment.OSVersion.ToString();
#endif
        }

        [Obsolete]
        public string GetRuntimeRegexValue(string value)
        {
            return GetClientVersion(value);
        }

        private static string GetClientVersion(string value)
        {
            var rx = new Regex(@"(\.NET).*(\\|\/).*(\d)", RegexOptions.Compiled | RegexOptions.IgnoreCase);
            var matches = rx.Match(value);
            char[] separator = { '\\', '/' };

            if (matches.Success)
            {
                var clientValueArray = matches.Value.Split(separator);
                return BuildClientVersion(clientValueArray);
            }

            return "RuntimeNotFound";
        }

        private static string BuildClientVersion(string[] value)
        {
            var finalValue = "";
            for (var i = 0; i < value.Length - 1; ++i)
            {
                finalValue += value[i].Replace(".", "").ToLower();
            }

            finalValue += "/" + value[value.Length - 1];

            return finalValue;
        }

        public static string GetDefaultMessage()
        {
            return DEFAULT_MESSAGE;
        }

        public void AppendUserAgent(string key, string value)
        {
            if (string.IsNullOrEmpty(key) || string.IsNullOrEmpty(value))
            {
                return;
            }

            if (excludedList.Contains(key.ToLowerInvariant()))
            {
                return;
            }

            DictionaryUtil.Add(userAgent, key, value);
        }

        public ReadOnlyDictionary<string, string> GetSysUserAgentDict()
        {
            return new ReadOnlyDictionary<string, string>(userAgent);
        }

        public static string Resolve(UserAgent requestConfig, UserAgent clientConfig)
        {
            var finalDict = new Dictionary<string, string>();
            if (clientConfig != null && clientConfig.GetSysUserAgentDict().Count > 0)
            {
                finalDict = new Dictionary<string, string>(clientConfig.GetSysUserAgentDict());
            }

            if (requestConfig != null && requestConfig.GetSysUserAgentDict().Count > 0)
            {
                finalDict = new Dictionary<string, string>(requestConfig.GetSysUserAgentDict());
            }

            var agent = new StringBuilder(DEFAULT_MESSAGE);

            foreach (var item in finalDict)
            {
                agent.Append(" " + item.Key + "/" + item.Value);
            }

            return agent.ToString();
        }
    }
}