24024
af7c11d7f9
- 新增图像生成接口，支持试用、积分和自定义API Key模式 - 实现生成图片结果异步上传至MinIO存储，带重试机制 - 优化积分预扣除和异常退还逻辑，保障用户积分准确 - 添加获取生成历史记录接口，支持时间范围和分页 - 提供本地字典配置接口，支持模型、比例、提示模板和尺寸 - 实现图片批量上传接口，支持S3兼容对象存储 feat(admin): 增加管理员角色管理与权限分配接口 - 实现角色列表查询、角色创建、更新及删除功能 - 增加权限列表查询接口 - 实现用户角色分配接口，便于统一管理用户权限 - 增加系统字典增删查改接口，支持分类过滤和排序 - 权限控制全面覆盖管理接口，保证安全访问 feat(auth): 完善用户登录注册及权限相关接口与页面 - 实现手机号验证码发送及校验功能，保障注册安全 - 支持手机号注册、登录及退出接口，集成日志记录 - 增加修改密码功能，验证原密码后更新 - 提供动态导航菜单接口，基于权限展示不同菜单 - 实现管理界面路由及日志、角色、字典管理页面访问权限控制 - 添加系统日志查询接口，支持关键词和等级筛选 feat(app): 初始化Flask应用并配置蓝图与数据库 - 创建应用程序工厂，加载配置，初始化数据库和Redis客户端 - 注册认证、API及管理员蓝图，整合路由 - 根路由渲染主页模板 - 应用上下文中自动创建数据库表，保证运行环境准备完毕 feat(database): 提供数据库创建与迁移支持脚本 - 新增数据库创建脚本，支持自动检测是否已存在 - 添加数据库表初始化脚本，支持创建和删除所有表 - 实现RBAC权限初始化，包含基础权限和角色创建 - 新增字段手动修复脚本，添加用户API Key和积分字段 - 强制迁移脚本支持清理连接和修复表结构，初始化默认数据及角色分配 feat(config): 新增系统配置参数 - 配置数据库、Redis、Session和MinIO相关参数 - 添加AI接口地址及试用Key配置 - 集成阿里云短信服务配置及开发模式相关参数 feat(extensions): 初始化数据库、Redis和MinIO客户端 - 创建全局SQLAlchemy数据库实例和Redis客户端 - 配置基于boto3的MinIO兼容S3客户端 chore(logs): 添加示例系统日志文件 - 记录用户请求、验证码发送成功与失败的日志信息
673 lines
24 KiB
Python
673 lines
24 KiB
Python
# Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"). You
|
|
# may not use this file except in compliance with the License. A copy of
|
|
# the License is located at
|
|
#
|
|
# http://aws.amazon.com/apache2.0/
|
|
#
|
|
# or in the "license" file accompanying this file. This file 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.
|
|
"""
|
|
NOTE: All classes and functions in this module are considered private and are
|
|
subject to abrupt breaking changes. Please do not use them directly.
|
|
|
|
To modify the User-Agent header sent by botocore, use one of these
|
|
configuration options:
|
|
* The ``AWS_SDK_UA_APP_ID`` environment variable.
|
|
* The ``sdk_ua_app_id`` setting in the shared AWS config file.
|
|
* The ``user_agent_appid`` field in the :py:class:`botocore.config.Config`.
|
|
* The ``user_agent_extra`` field in the :py:class:`botocore.config.Config`.
|
|
|
|
"""
|
|
|
|
import logging
|
|
import os
|
|
import platform
|
|
from copy import copy
|
|
from string import ascii_letters, digits
|
|
from typing import NamedTuple, Optional
|
|
|
|
from botocore import __version__ as botocore_version
|
|
from botocore.compat import HAS_CRT
|
|
from botocore.context import get_context
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
_USERAGENT_ALLOWED_CHARACTERS = ascii_letters + digits + "!$%&'*+-.^_`|~,"
|
|
_USERAGENT_ALLOWED_OS_NAMES = (
|
|
'windows',
|
|
'linux',
|
|
'macos',
|
|
'android',
|
|
'ios',
|
|
'watchos',
|
|
'tvos',
|
|
'other',
|
|
)
|
|
_USERAGENT_PLATFORM_NAME_MAPPINGS = {'darwin': 'macos'}
|
|
# The name by which botocore is identified in the User-Agent header. While most
|
|
# AWS SDKs follow a naming pattern of "aws-sdk-*", botocore and boto3 continue
|
|
# using their existing values. Uses uppercase "B" with all other characters
|
|
# lowercase.
|
|
_USERAGENT_SDK_NAME = 'Botocore'
|
|
_USERAGENT_FEATURE_MAPPINGS = {
|
|
'WAITER': 'B',
|
|
'PAGINATOR': 'C',
|
|
"RETRY_MODE_LEGACY": "D",
|
|
"RETRY_MODE_STANDARD": "E",
|
|
"RETRY_MODE_ADAPTIVE": "F",
|
|
'S3_TRANSFER': 'G',
|
|
'GZIP_REQUEST_COMPRESSION': 'L',
|
|
'PROTOCOL_RPC_V2_CBOR': 'M',
|
|
'ENDPOINT_OVERRIDE': 'N',
|
|
'ACCOUNT_ID_MODE_PREFERRED': 'P',
|
|
'ACCOUNT_ID_MODE_DISABLED': 'Q',
|
|
'ACCOUNT_ID_MODE_REQUIRED': 'R',
|
|
'SIGV4A_SIGNING': 'S',
|
|
'RESOLVED_ACCOUNT_ID': 'T',
|
|
'FLEXIBLE_CHECKSUMS_REQ_CRC32': 'U',
|
|
'FLEXIBLE_CHECKSUMS_REQ_CRC32C': 'V',
|
|
'FLEXIBLE_CHECKSUMS_REQ_CRC64': 'W',
|
|
'FLEXIBLE_CHECKSUMS_REQ_SHA1': 'X',
|
|
'FLEXIBLE_CHECKSUMS_REQ_SHA256': 'Y',
|
|
'FLEXIBLE_CHECKSUMS_REQ_WHEN_SUPPORTED': 'Z',
|
|
'FLEXIBLE_CHECKSUMS_REQ_WHEN_REQUIRED': 'a',
|
|
'FLEXIBLE_CHECKSUMS_RES_WHEN_SUPPORTED': 'b',
|
|
'FLEXIBLE_CHECKSUMS_RES_WHEN_REQUIRED': 'c',
|
|
'CREDENTIALS_CODE': 'e',
|
|
'CREDENTIALS_ENV_VARS': 'g',
|
|
'CREDENTIALS_ENV_VARS_STS_WEB_ID_TOKEN': 'h',
|
|
'CREDENTIALS_STS_ASSUME_ROLE': 'i',
|
|
'CREDENTIALS_STS_ASSUME_ROLE_WEB_ID': 'k',
|
|
'CREDENTIALS_PROFILE': 'n',
|
|
'CREDENTIALS_PROFILE_SOURCE_PROFILE': 'o',
|
|
'CREDENTIALS_PROFILE_NAMED_PROVIDER': 'p',
|
|
'CREDENTIALS_PROFILE_STS_WEB_ID_TOKEN': 'q',
|
|
'CREDENTIALS_PROFILE_SSO': 'r',
|
|
'CREDENTIALS_SSO': 's',
|
|
'CREDENTIALS_PROFILE_SSO_LEGACY': 't',
|
|
'CREDENTIALS_SSO_LEGACY': 'u',
|
|
'CREDENTIALS_PROFILE_PROCESS': 'v',
|
|
'CREDENTIALS_PROCESS': 'w',
|
|
'CREDENTIALS_BOTO2_CONFIG_FILE': 'x',
|
|
'CREDENTIALS_HTTP': 'z',
|
|
'CREDENTIALS_IMDS': '0',
|
|
'BEARER_SERVICE_ENV_VARS': '3',
|
|
'CLI_V1_TO_V2_MIGRATION_DEBUG_MODE': '-',
|
|
'CREDENTIALS_PROFILE_LOGIN': 'AC',
|
|
'CREDENTIALS_LOGIN': 'AD',
|
|
}
|
|
|
|
|
|
def register_feature_id(feature_id):
|
|
"""Adds metric value to the current context object's ``features`` set.
|
|
|
|
:type feature_id: str
|
|
:param feature_id: The name of the feature to register. Value must be a key
|
|
in the ``_USERAGENT_FEATURE_MAPPINGS`` dict.
|
|
"""
|
|
ctx = get_context()
|
|
if ctx is None:
|
|
# Never register features outside the scope of a
|
|
# ``botocore.context.start_as_current_context`` context manager.
|
|
# Otherwise, the context variable won't be reset and features will
|
|
# bleed into all subsequent requests. Return instead of raising an
|
|
# exception since this function could be invoked in a public interface.
|
|
return
|
|
if val := _USERAGENT_FEATURE_MAPPINGS.get(feature_id):
|
|
ctx.features.add(val)
|
|
|
|
|
|
def register_feature_ids(feature_ids):
|
|
"""Adds multiple feature IDs to the current context object's ``features`` set.
|
|
|
|
:type feature_ids: iterable of str
|
|
:param feature_ids: An iterable of feature ID strings to register. Each
|
|
value must be a key in the ``_USERAGENT_FEATURE_MAPPINGS`` dict.
|
|
"""
|
|
for feature_id in feature_ids:
|
|
register_feature_id(feature_id)
|
|
|
|
|
|
def sanitize_user_agent_string_component(raw_str, allow_hash):
|
|
"""Replaces all not allowed characters in the string with a dash ("-").
|
|
|
|
Allowed characters are ASCII alphanumerics and ``!$%&'*+-.^_`|~,``. If
|
|
``allow_hash`` is ``True``, "#"``" is also allowed.
|
|
|
|
:type raw_str: str
|
|
:param raw_str: The input string to be sanitized.
|
|
|
|
:type allow_hash: bool
|
|
:param allow_hash: Whether "#" is considered an allowed character.
|
|
"""
|
|
return ''.join(
|
|
c
|
|
if c in _USERAGENT_ALLOWED_CHARACTERS or (allow_hash and c == '#')
|
|
else '-'
|
|
for c in raw_str
|
|
)
|
|
|
|
|
|
class UserAgentComponentSizeConfig:
|
|
"""
|
|
Configures the max size of a built user agent string component and the
|
|
delimiter used to truncate the string if the size is above the max.
|
|
"""
|
|
|
|
def __init__(self, max_size_in_bytes: int, delimiter: str):
|
|
self.max_size_in_bytes = max_size_in_bytes
|
|
self.delimiter = delimiter
|
|
self._validate_input()
|
|
|
|
def _validate_input(self):
|
|
if self.max_size_in_bytes < 1:
|
|
raise ValueError(
|
|
f'Invalid `max_size_in_bytes`: {self.max_size_in_bytes}. '
|
|
'Value must be a positive integer.'
|
|
)
|
|
|
|
|
|
class UserAgentComponent(NamedTuple):
|
|
"""
|
|
Component of a Botocore User-Agent header string in the standard format.
|
|
|
|
Each component consists of a prefix, a name, a value, and a size_config.
|
|
In the string representation these are combined in the format
|
|
``prefix/name#value``.
|
|
|
|
``size_config`` configures the max size and truncation strategy for the
|
|
built user agent string component.
|
|
|
|
This class is considered private and is subject to abrupt breaking changes.
|
|
"""
|
|
|
|
prefix: str
|
|
name: str
|
|
value: Optional[str] = None
|
|
size_config: Optional[UserAgentComponentSizeConfig] = None
|
|
|
|
def to_string(self):
|
|
"""Create string like 'prefix/name#value' from a UserAgentComponent."""
|
|
clean_prefix = sanitize_user_agent_string_component(
|
|
self.prefix, allow_hash=True
|
|
)
|
|
clean_name = sanitize_user_agent_string_component(
|
|
self.name, allow_hash=False
|
|
)
|
|
if self.value is None or self.value == '':
|
|
clean_string = f'{clean_prefix}/{clean_name}'
|
|
else:
|
|
clean_value = sanitize_user_agent_string_component(
|
|
self.value, allow_hash=True
|
|
)
|
|
clean_string = f'{clean_prefix}/{clean_name}#{clean_value}'
|
|
if self.size_config is not None:
|
|
clean_string = self._truncate_string(
|
|
clean_string,
|
|
self.size_config.max_size_in_bytes,
|
|
self.size_config.delimiter,
|
|
)
|
|
return clean_string
|
|
|
|
def _truncate_string(self, string, max_size, delimiter):
|
|
"""
|
|
Pop ``delimiter``-separated values until encoded string is less than or
|
|
equal to ``max_size``.
|
|
"""
|
|
orig = string
|
|
while len(string.encode('utf-8')) > max_size:
|
|
parts = string.split(delimiter)
|
|
parts.pop()
|
|
string = delimiter.join(parts)
|
|
|
|
if string == '':
|
|
logger.debug(
|
|
"User agent component `%s` could not be truncated to "
|
|
"`%s` bytes with delimiter "
|
|
"`%s` without losing all contents. "
|
|
"Value will be omitted from user agent string.",
|
|
orig,
|
|
max_size,
|
|
delimiter,
|
|
)
|
|
return string
|
|
|
|
|
|
class RawStringUserAgentComponent:
|
|
"""
|
|
UserAgentComponent interface wrapper around ``str``.
|
|
|
|
Use for User-Agent header components that are not constructed from
|
|
prefix+name+value but instead are provided as strings. No sanitization is
|
|
performed.
|
|
"""
|
|
|
|
def __init__(self, value):
|
|
self._value = value
|
|
|
|
def to_string(self):
|
|
return self._value
|
|
|
|
|
|
# This is not a public interface and is subject to abrupt breaking changes.
|
|
# Any usage is not advised or supported in external code bases.
|
|
try:
|
|
from botocore.customizations.useragent import modify_components
|
|
except ImportError:
|
|
# Default implementation that returns unmodified User-Agent components.
|
|
def modify_components(components):
|
|
return components
|
|
|
|
|
|
class UserAgentString:
|
|
"""
|
|
Generator for AWS SDK User-Agent header strings.
|
|
|
|
The User-Agent header format contains information from session, client, and
|
|
request context. ``UserAgentString`` provides methods for collecting the
|
|
information and ``to_string`` for assembling it into the standardized
|
|
string format.
|
|
|
|
Example usage:
|
|
|
|
ua_session = UserAgentString.from_environment()
|
|
ua_session.set_session_config(...)
|
|
ua_client = ua_session.with_client_config(Config(...))
|
|
ua_string = ua_request.to_string()
|
|
|
|
For testing or when information from all sources is available at the same
|
|
time, the methods can be chained:
|
|
|
|
ua_string = (
|
|
UserAgentString
|
|
.from_environment()
|
|
.set_session_config(...)
|
|
.with_client_config(Config(...))
|
|
.to_string()
|
|
)
|
|
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
platform_name,
|
|
platform_version,
|
|
platform_machine,
|
|
python_version,
|
|
python_implementation,
|
|
execution_env,
|
|
crt_version=None,
|
|
):
|
|
"""
|
|
:type platform_name: str
|
|
:param platform_name: Name of the operating system or equivalent
|
|
platform name. Should be sourced from :py:meth:`platform.system`.
|
|
:type platform_version: str
|
|
:param platform_version: Version of the operating system or equivalent
|
|
platform name. Should be sourced from :py:meth:`platform.version`.
|
|
:type platform_machine: str
|
|
:param platform_version: Processor architecture or machine type. For
|
|
example "x86_64". Should be sourced from :py:meth:`platform.machine`.
|
|
:type python_version: str
|
|
:param python_version: Version of the python implementation as str.
|
|
Should be sourced from :py:meth:`platform.python_version`.
|
|
:type python_implementation: str
|
|
:param python_implementation: Name of the python implementation.
|
|
Should be sourced from :py:meth:`platform.python_implementation`.
|
|
:type execution_env: str
|
|
:param execution_env: The value of the AWS execution environment.
|
|
Should be sourced from the ``AWS_EXECUTION_ENV` environment
|
|
variable.
|
|
:type crt_version: str
|
|
:param crt_version: Version string of awscrt package, if installed.
|
|
"""
|
|
self._platform_name = platform_name
|
|
self._platform_version = platform_version
|
|
self._platform_machine = platform_machine
|
|
self._python_version = python_version
|
|
self._python_implementation = python_implementation
|
|
self._execution_env = execution_env
|
|
self._crt_version = crt_version
|
|
|
|
# Components that can be added with ``set_session_config()``
|
|
self._session_user_agent_name = None
|
|
self._session_user_agent_version = None
|
|
self._session_user_agent_extra = None
|
|
|
|
self._client_config = None
|
|
|
|
# Component that can be set with ``set_client_features()``
|
|
self._client_features = None
|
|
|
|
@classmethod
|
|
def from_environment(cls):
|
|
crt_version = None
|
|
if HAS_CRT:
|
|
crt_version = _get_crt_version() or 'Unknown'
|
|
return cls(
|
|
platform_name=platform.system(),
|
|
platform_version=platform.release(),
|
|
platform_machine=platform.machine(),
|
|
python_version=platform.python_version(),
|
|
python_implementation=platform.python_implementation(),
|
|
execution_env=os.environ.get('AWS_EXECUTION_ENV'),
|
|
crt_version=crt_version,
|
|
)
|
|
|
|
def set_session_config(
|
|
self,
|
|
session_user_agent_name,
|
|
session_user_agent_version,
|
|
session_user_agent_extra,
|
|
):
|
|
"""
|
|
Set the user agent configuration values that apply at session level.
|
|
|
|
:param user_agent_name: The user agent name configured in the
|
|
:py:class:`botocore.session.Session` object. For backwards
|
|
compatibility, this will always be at the beginning of the
|
|
User-Agent string, together with ``user_agent_version``.
|
|
:param user_agent_version: The user agent version configured in the
|
|
:py:class:`botocore.session.Session` object.
|
|
:param user_agent_extra: The user agent "extra" configured in the
|
|
:py:class:`botocore.session.Session` object.
|
|
"""
|
|
self._session_user_agent_name = session_user_agent_name
|
|
self._session_user_agent_version = session_user_agent_version
|
|
self._session_user_agent_extra = session_user_agent_extra
|
|
return self
|
|
|
|
def set_client_features(self, features):
|
|
"""
|
|
Persist client-specific features registered before or during client
|
|
creation.
|
|
|
|
:type features: Set[str]
|
|
:param features: A set of client-specific features.
|
|
"""
|
|
self._client_features = features
|
|
|
|
def with_client_config(self, client_config):
|
|
"""
|
|
Create a copy with all original values and client-specific values.
|
|
|
|
:type client_config: botocore.config.Config
|
|
:param client_config: The client configuration object.
|
|
"""
|
|
cp = copy(self)
|
|
cp._client_config = client_config
|
|
return cp
|
|
|
|
def to_string(self):
|
|
"""
|
|
Build User-Agent header string from the object's properties.
|
|
"""
|
|
config_ua_override = None
|
|
if self._client_config:
|
|
if hasattr(self._client_config, '_supplied_user_agent'):
|
|
config_ua_override = self._client_config._supplied_user_agent
|
|
else:
|
|
config_ua_override = self._client_config.user_agent
|
|
|
|
if config_ua_override is not None:
|
|
return self._build_legacy_ua_string(config_ua_override)
|
|
|
|
components = [
|
|
*self._build_sdk_metadata(),
|
|
RawStringUserAgentComponent('ua/2.1'),
|
|
*self._build_os_metadata(),
|
|
*self._build_architecture_metadata(),
|
|
*self._build_language_metadata(),
|
|
*self._build_execution_env_metadata(),
|
|
*self._build_feature_metadata(),
|
|
*self._build_config_metadata(),
|
|
*self._build_app_id(),
|
|
*self._build_extra(),
|
|
]
|
|
|
|
components = modify_components(components)
|
|
|
|
return ' '.join(
|
|
[comp.to_string() for comp in components if comp.to_string()]
|
|
)
|
|
|
|
def _build_sdk_metadata(self):
|
|
"""
|
|
Build the SDK name and version component of the User-Agent header.
|
|
|
|
For backwards-compatibility both session-level and client-level config
|
|
of custom tool names are honored. If this removes the Botocore
|
|
information from the start of the string, Botocore's name and version
|
|
are included as a separate field with "md" prefix.
|
|
"""
|
|
sdk_md = []
|
|
if (
|
|
self._session_user_agent_name
|
|
and self._session_user_agent_version
|
|
and (
|
|
self._session_user_agent_name != _USERAGENT_SDK_NAME
|
|
or self._session_user_agent_version != botocore_version
|
|
)
|
|
):
|
|
sdk_md.extend(
|
|
[
|
|
UserAgentComponent(
|
|
self._session_user_agent_name,
|
|
self._session_user_agent_version,
|
|
),
|
|
UserAgentComponent(
|
|
'md', _USERAGENT_SDK_NAME, botocore_version
|
|
),
|
|
]
|
|
)
|
|
else:
|
|
sdk_md.append(
|
|
UserAgentComponent(_USERAGENT_SDK_NAME, botocore_version)
|
|
)
|
|
|
|
if self._crt_version is not None:
|
|
sdk_md.append(
|
|
UserAgentComponent('md', 'awscrt', self._crt_version)
|
|
)
|
|
|
|
return sdk_md
|
|
|
|
def _build_os_metadata(self):
|
|
"""
|
|
Build the OS/platform components of the User-Agent header string.
|
|
|
|
For recognized platform names that match or map to an entry in the list
|
|
of standardized OS names, a single component with prefix "os" is
|
|
returned. Otherwise, one component "os/other" is returned and a second
|
|
with prefix "md" and the raw platform name.
|
|
|
|
String representations of example return values:
|
|
* ``os/macos#10.13.6``
|
|
* ``os/linux``
|
|
* ``os/other``
|
|
* ``os/other md/foobar#1.2.3``
|
|
"""
|
|
if self._platform_name is None:
|
|
return [UserAgentComponent('os', 'other')]
|
|
|
|
plt_name_lower = self._platform_name.lower()
|
|
if plt_name_lower in _USERAGENT_ALLOWED_OS_NAMES:
|
|
os_family = plt_name_lower
|
|
elif plt_name_lower in _USERAGENT_PLATFORM_NAME_MAPPINGS:
|
|
os_family = _USERAGENT_PLATFORM_NAME_MAPPINGS[plt_name_lower]
|
|
else:
|
|
os_family = None
|
|
|
|
if os_family is not None:
|
|
return [
|
|
UserAgentComponent('os', os_family, self._platform_version)
|
|
]
|
|
else:
|
|
return [
|
|
UserAgentComponent('os', 'other'),
|
|
UserAgentComponent(
|
|
'md', self._platform_name, self._platform_version
|
|
),
|
|
]
|
|
|
|
def _build_architecture_metadata(self):
|
|
"""
|
|
Build architecture component of the User-Agent header string.
|
|
|
|
Returns the machine type with prefix "md" and name "arch", if one is
|
|
available. Common values include "x86_64", "arm64", "i386".
|
|
"""
|
|
if self._platform_machine:
|
|
return [
|
|
UserAgentComponent(
|
|
'md', 'arch', self._platform_machine.lower()
|
|
)
|
|
]
|
|
return []
|
|
|
|
def _build_language_metadata(self):
|
|
"""
|
|
Build the language components of the User-Agent header string.
|
|
|
|
Returns the Python version in a component with prefix "lang" and name
|
|
"python". The Python implementation (e.g. CPython, PyPy) is returned as
|
|
separate metadata component with prefix "md" and name "pyimpl".
|
|
|
|
String representation of an example return value:
|
|
``lang/python#3.10.4 md/pyimpl#CPython``
|
|
"""
|
|
lang_md = [
|
|
UserAgentComponent('lang', 'python', self._python_version),
|
|
]
|
|
if self._python_implementation:
|
|
lang_md.append(
|
|
UserAgentComponent('md', 'pyimpl', self._python_implementation)
|
|
)
|
|
return lang_md
|
|
|
|
def _build_execution_env_metadata(self):
|
|
"""
|
|
Build the execution environment component of the User-Agent header.
|
|
|
|
Returns a single component prefixed with "exec-env", usually sourced
|
|
from the environment variable AWS_EXECUTION_ENV.
|
|
"""
|
|
if self._execution_env:
|
|
return [UserAgentComponent('exec-env', self._execution_env)]
|
|
else:
|
|
return []
|
|
|
|
def _build_feature_metadata(self):
|
|
"""
|
|
Build the features component of the User-Agent header string.
|
|
|
|
Returns a single component with prefix "m" followed by a list of
|
|
comma-separated metric values.
|
|
"""
|
|
ctx = get_context()
|
|
context_features = set() if ctx is None else ctx.features
|
|
client_features = self._client_features or set()
|
|
features = client_features.union(context_features)
|
|
if not features:
|
|
return []
|
|
size_config = UserAgentComponentSizeConfig(1024, ',')
|
|
return [
|
|
UserAgentComponent(
|
|
'm', ','.join(features), size_config=size_config
|
|
)
|
|
]
|
|
|
|
def _build_config_metadata(self):
|
|
"""
|
|
Build the configuration components of the User-Agent header string.
|
|
|
|
Returns a list of components with prefix "cfg" followed by the config
|
|
setting name and its value. Tracked configuration settings may be
|
|
added or removed in future versions.
|
|
"""
|
|
if not self._client_config or not self._client_config.retries:
|
|
return []
|
|
retry_mode = self._client_config.retries.get('mode')
|
|
cfg_md = [UserAgentComponent('cfg', 'retry-mode', retry_mode)]
|
|
if self._client_config.endpoint_discovery_enabled:
|
|
cfg_md.append(UserAgentComponent('cfg', 'endpoint-discovery'))
|
|
return cfg_md
|
|
|
|
def _build_app_id(self):
|
|
"""
|
|
Build app component of the User-Agent header string.
|
|
|
|
Returns a single component with prefix "app" and value sourced from the
|
|
``user_agent_appid`` field in :py:class:`botocore.config.Config` or
|
|
the ``sdk_ua_app_id`` setting in the shared configuration file, or the
|
|
``AWS_SDK_UA_APP_ID`` environment variable. These are the recommended
|
|
ways for apps built with Botocore to insert their identifer into the
|
|
User-Agent header.
|
|
"""
|
|
if self._client_config and self._client_config.user_agent_appid:
|
|
appid = sanitize_user_agent_string_component(
|
|
raw_str=self._client_config.user_agent_appid, allow_hash=True
|
|
)
|
|
return [RawStringUserAgentComponent(f'app/{appid}')]
|
|
else:
|
|
return []
|
|
|
|
def _build_extra(self):
|
|
"""User agent string components based on legacy "extra" settings.
|
|
|
|
Creates components from the session-level and client-level
|
|
``user_agent_extra`` setting, if present. Both are passed through
|
|
verbatim and should be appended at the end of the string.
|
|
|
|
Preferred ways to inject application-specific information into
|
|
botocore's User-Agent header string are the ``user_agent_appid` field
|
|
in :py:class:`botocore.config.Config`. The ``AWS_SDK_UA_APP_ID``
|
|
environment variable and the ``sdk_ua_app_id`` configuration file
|
|
setting are alternative ways to set the ``user_agent_appid`` config.
|
|
"""
|
|
extra = []
|
|
if self._session_user_agent_extra:
|
|
extra.append(
|
|
RawStringUserAgentComponent(self._session_user_agent_extra)
|
|
)
|
|
if self._client_config and self._client_config.user_agent_extra:
|
|
extra.append(
|
|
RawStringUserAgentComponent(
|
|
self._client_config.user_agent_extra
|
|
)
|
|
)
|
|
return extra
|
|
|
|
def _build_legacy_ua_string(self, config_ua_override):
|
|
components = [config_ua_override]
|
|
if self._session_user_agent_extra:
|
|
components.append(self._session_user_agent_extra)
|
|
if self._client_config.user_agent_extra:
|
|
components.append(self._client_config.user_agent_extra)
|
|
return ' '.join(components)
|
|
|
|
def rebuild_and_replace_user_agent_handler(
|
|
self, operation_name, request, **kwargs
|
|
):
|
|
ua_string = self.to_string()
|
|
if request.headers.get('User-Agent'):
|
|
request.headers.replace_header('User-Agent', ua_string)
|
|
|
|
|
|
def _get_crt_version():
|
|
"""
|
|
This function is considered private and is subject to abrupt breaking
|
|
changes.
|
|
"""
|
|
try:
|
|
import awscrt
|
|
|
|
return awscrt.__version__
|
|
except AttributeError:
|
|
return None
|