swift 2.23.3__py3-none-any.whl → 2.35.0__py3-none-any.whl

swift/common/middleware/x_profile/exceptions.py

@@ -13,16 +13,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from swift import gettext_ as _
-
-
 class ProfileException(Exception):
 
     def __init__(self, msg):
         self.msg = msg
 
     def __str__(self):
-        return _('Profiling Error: %s') % self.msg
+        return 'Profiling Error: %s' % self.msg
 
 
 class NotFoundException(ProfileException):

swift/common/middleware/x_profile/html_viewer.py

@@ -13,14 +13,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import cgi
+import html
 import os
 import random
 import re
 import string
 import tempfile
 
-from swift import gettext_ as _
 from swift.common.middleware.x_profile.exceptions import PLOTLIBNotInstalled
 from swift.common.middleware.x_profile.exceptions import ODFLIBNotInstalled
 from swift.common.middleware.x_profile.exceptions import NotFoundException
@@ -246,7 +245,7 @@ class HTMLViewer(object):
         if multiple:
             return value
         if isinstance(value, list):
-            return eval(value[0]) if isinstance(default, int) else value[0]
+            return int(value[0]) if isinstance(default, int) else value[0]
         else:
             return value
 
@@ -307,7 +306,7 @@ class HTMLViewer(object):
                                                  nfl_filter, download_format)
             headers.append(('Access-Control-Allow-Origin', '*'))
         else:
-            raise MethodNotAllowed(_('method %s is not allowed.') % method)
+            raise MethodNotAllowed('method %s is not allowed.' % method)
         return content, headers
 
     def index_page(self, log_files=None, sort='time', limit=-1,
@@ -318,12 +317,12 @@ class HTMLViewer(object):
         try:
             stats = Stats2(*log_files)
         except (IOError, ValueError):
-            raise DataLoadFailure(_('Can not load profile data from %s.')
+            raise DataLoadFailure('Can not load profile data from %s.'
                                   % log_files)
         if not fulldirs:
             stats.strip_dirs()
         stats.sort_stats(sort)
-        nfl_filter_esc = nfl_filter.replace('(', '\(').replace(')', '\)')
+        nfl_filter_esc = nfl_filter.replace(r'(', r'\(').replace(r')', r'\)')
         amount = [nfl_filter_esc, limit] if nfl_filter_esc else [limit]
         profile_html = self.generate_stats_html(stats, self.app_path,
                                                 profile_id, *amount)
@@ -369,9 +368,9 @@ class HTMLViewer(object):
     def download(self, log_files, sort='time', limit=-1, nfl_filter='',
                  output_format='default'):
         if len(log_files) == 0:
-            raise NotFoundException(_('no log file found'))
+            raise NotFoundException('no log file found')
         try:
-            nfl_esc = nfl_filter.replace('(', '\(').replace(')', '\)')
+            nfl_esc = nfl_filter.replace(r'(', r'\(').replace(r')', r'\)')
             # remove the slash that is intentionally added in the URL
             # to avoid failure of filtering stats data.
             if nfl_esc.startswith('/'):
@@ -392,14 +391,14 @@ class HTMLViewer(object):
         except ODFLIBNotInstalled:
             raise
         except Exception as ex:
-            raise ProfileException(_('Data download error: %s') % ex)
+            raise ProfileException('Data download error: %s' % ex)
 
     def plot(self, log_files, sort='time', limit=10, nfl_filter='',
              metric_selected='cc', plot_type='bar'):
         if not PLOTLIB_INSTALLED:
-            raise PLOTLIBNotInstalled(_('python-matplotlib not installed.'))
+            raise PLOTLIBNotInstalled('python-matplotlib not installed.')
         if len(log_files) == 0:
-            raise NotFoundException(_('no log file found'))
+            raise NotFoundException('no log file found')
         try:
             stats = Stats2(*log_files)
             stats.sort_stats(sort)
@@ -433,7 +432,7 @@ class HTMLViewer(object):
                 data = profile_img.read()
                 return data, [('content-type', 'image/jpg')]
         except Exception as ex:
-            raise ProfileException(_('plotting results failed due to %s') % ex)
+            raise ProfileException('plotting results failed due to %s' % ex)
 
     def format_source_code(self, nfl):
         nfls = re.split('[:()]', nfl)
@@ -444,7 +443,7 @@ class HTMLViewer(object):
             lineno = 0
         # for security reason, this need to be fixed.
         if not file_path.endswith('.py'):
-            return _('The file type are forbidden to access!')
+            return 'The file type are forbidden to access!'
         try:
             data = []
             i = 0
@@ -454,18 +453,18 @@ class HTMLViewer(object):
                 fmt = '<span id="L%d" rel="#L%d">%' + max_width\
                     + 'd|<code>%s</code></span>'
                 for line in lines:
-                    l = cgi.escape(line, quote=None)
+                    el = html.escape(line)
                     i = i + 1
                     if i == lineno:
                         fmt2 = '<span id="L%d" style="background-color: \
                             rgb(127,255,127)">%' + max_width +\
                             'd|<code>%s</code></span>'
-                        data.append(fmt2 % (i, i, l))
+                        data.append(fmt2 % (i, i, el))
                     else:
-                        data.append(fmt % (i, i, i, l))
+                        data.append(fmt % (i, i, i, el))
             data = ''.join(data)
         except Exception:
-            return _('Can not access the file %s.') % file_path
+            return 'Can not access the file %s.' % file_path
         return '<pre>%s</pre>' % data
 
     def generate_stats_html(self, stats, app_path, profile_id, *selection):
@@ -518,7 +517,7 @@ class HTMLViewer(object):
                         html.append('<td>-</td>')
                     else:
                         html.append('<td>%f</td>' % (float(ct) / cc))
-                    nfls = cgi.escape(stats.func_std_string(func))
+                    nfls = html.escape(stats.func_std_string(func))
                     if nfls.split(':')[0] not in ['', 'profile'] and\
                             os.path.isfile(nfls.split(':')[0]):
                         html.append('<td><a href="%s/%s%s?format=python#L%d">\
@@ -532,5 +531,5 @@ class HTMLViewer(object):
                                 --></a></td></tr>' % (app_path,
                                                       profile_id, nfls))
         except Exception as ex:
-            html.append("Exception:" % str(ex))
+            html.append("Exception:" + str(ex))
         return ''.join(html)

swift/common/middleware/x_profile/profile_model.py

@@ -20,7 +20,6 @@ import pstats
 import tempfile
 import time
 
-from swift import gettext_ as _
 from swift.common.middleware.x_profile.exceptions import ODFLIBNotInstalled
 
 
@@ -125,7 +124,7 @@ class Stats2(pstats.Stats):
 
     def to_ods(self, *selection):
         if not ODFLIB_INSTALLED:
-            raise ODFLIBNotInstalled(_('odfpy not installed.'))
+            raise ODFLIBNotInstalled('odfpy not installed.')
         if self.fcn_list:
             stat_list = self.fcn_list[:]
             order_text = "   Ordered by: " + self.sort_type + '\n'

swift/common/middleware/xprofile.py

@@ -16,6 +16,11 @@
 """
 Profiling middleware for Swift Servers.
 
+.. note::
+    This middleware is intended for development and testing environments only,
+    not production. No authentication is expected or required for the web UI,
+    and profiling may incur noticeable performance penalties.
+
 The current implementation is based on eventlet aware profiler.(For the
 future, more profilers could be added in to collect more data for analysis.)
 Profiling all incoming requests and accumulating cpu timing statistics
@@ -80,10 +85,8 @@ import time
 
 from eventlet import greenthread, GreenPool, patcher
 import eventlet.green.profile as eprofile
-import six
-from six.moves import urllib
+import urllib
 
-from swift import gettext_ as _
 from swift.common.utils import get_logger, config_true_value
 from swift.common.swob import Request
 from swift.common.middleware.x_profile.exceptions import MethodNotAllowed
@@ -93,7 +96,7 @@ from swift.common.middleware.x_profile.html_viewer import HTMLViewer
 from swift.common.middleware.x_profile.profile_model import ProfileLog
 
 
-DEFAULT_PROFILE_PREFIX = '/tmp/log/swift/profile/default.profile'
+DEFAULT_PROFILE_PREFIX = '/tmp/log/swift/profile/default.profile'  # nosec B108
 
 # unwind the iterator; it may call start_response, do lots of work, etc
 PROFILE_EXEC_EAGER = """
@@ -108,10 +111,7 @@ PROFILE_EXEC_LAZY = """
 app_iter_ = self.app(environ, start_response)
 """
 
-if six.PY3:
-    thread = patcher.original('_thread')  # non-monkeypatched module needed
-else:
-    thread = patcher.original('thread')  # non-monkeypatched module needed
+thread = patcher.original('_thread')  # non-monkeypatched module needed
 
 
 # This monkey patch code fix the problem of eventlet profile tool
@@ -213,7 +213,7 @@ class ProfileMiddleware(object):
                                                       query_dict,
                                                       self.renew_profile)
                 start_response('200 OK', headers)
-                if isinstance(content, six.text_type):
+                if isinstance(content, str):
                     content = content.encode('utf-8')
                 return [content]
             except MethodNotAllowed as mx:
@@ -227,7 +227,7 @@ class ProfileMiddleware(object):
                 return '%s' % pf
             except Exception as ex:
                 start_response('500 Internal Server Error', [])
-                return _('Error on render profiling results: %s') % ex
+                return 'Error on render profiling results: %s' % ex
         else:
             _locals = locals()
             code = self.unwind and PROFILE_EXEC_EAGER or\

swift-2.23.3.data/scripts/swift-container-server → swift/common/recon.py

@@ -1,5 +1,4 @@
-#!python
-# Copyright (c) 2010-2012 OpenStack Foundation
+# Copyright (c) 2010-2021 OpenStack Foundation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,10 +13,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import sys
-from swift.common.utils import parse_options
-from swift.common.wsgi import run_wsgi
+RECON_RELINKER_FILE = 'relinker.recon'
+RECON_OBJECT_FILE = 'object.recon'
+RECON_CONTAINER_FILE = 'container.recon'
+RECON_ACCOUNT_FILE = 'account.recon'
+RECON_DRIVE_FILE = 'drive.recon'
+DEFAULT_RECON_CACHE_PATH = '/var/cache/swift'
 
-if __name__ == '__main__':
-    conf_file, options = parse_options()
-    sys.exit(run_wsgi(conf_file, 'container-server', **options))
+
+def server_type_to_recon_file(server_type):
+    if not isinstance(server_type, str) or \
+            server_type.lower() not in ('account', 'container', 'object'):
+        raise ValueError('Invalid server_type')
+    return "%s.recon" % server_type.lower()

swift/common/registry.py

@@ -0,0 +1,147 @@
+# Copyright (c) 2022 NVIDIA
+#
+# Licensed 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.
+
+# Used by get_swift_info and register_swift_info to store information about
+# the swift cluster.
+from copy import deepcopy
+
+_swift_info = {}
+_swift_admin_info = {}
+
+
+def get_swift_info(admin=False, disallowed_sections=None):
+    """
+    Returns information about the swift cluster that has been previously
+    registered with the register_swift_info call.
+
+    :param admin: boolean value, if True will additionally return an 'admin'
+                  section with information previously registered as admin
+                  info.
+    :param disallowed_sections: list of section names to be withheld from the
+                                information returned.
+    :returns: dictionary of information about the swift cluster.
+    """
+    disallowed_sections = disallowed_sections or []
+    info = deepcopy(_swift_info)
+    for section in disallowed_sections:
+        key_to_pop = None
+        sub_section_dict = info
+        for sub_section in section.split('.'):
+            if key_to_pop:
+                sub_section_dict = sub_section_dict.get(key_to_pop, {})
+                if not isinstance(sub_section_dict, dict):
+                    sub_section_dict = {}
+                    break
+            key_to_pop = sub_section
+        sub_section_dict.pop(key_to_pop, None)
+
+    if admin:
+        info['admin'] = dict(_swift_admin_info)
+        info['admin']['disallowed_sections'] = list(disallowed_sections)
+    return info
+
+
+def register_swift_info(name='swift', admin=False, **kwargs):
+    """
+    Registers information about the swift cluster to be retrieved with calls
+    to get_swift_info.
+
+    NOTE: Do not use "." in the param: name or any keys in kwargs. "." is used
+          in the disallowed_sections to remove unwanted keys from /info.
+
+    :param name: string, the section name to place the information under.
+    :param admin: boolean, if True, information will be registered to an
+                  admin section which can optionally be withheld when
+                  requesting the information.
+    :param kwargs: key value arguments representing the information to be
+                   added.
+    :raises ValueError: if name or any of the keys in kwargs has "." in it
+    """
+    if name == 'admin' or name == 'disallowed_sections':
+        raise ValueError('\'{0}\' is reserved name.'.format(name))
+
+    if admin:
+        dict_to_use = _swift_admin_info
+    else:
+        dict_to_use = _swift_info
+    if name not in dict_to_use:
+        if "." in name:
+            raise ValueError('Cannot use "." in a swift_info key: %s' % name)
+        dict_to_use[name] = {}
+    for key, val in kwargs.items():
+        if "." in key:
+            raise ValueError('Cannot use "." in a swift_info key: %s' % key)
+        dict_to_use[name][key] = val
+
+
+_sensitive_headers = set()
+_sensitive_params = set()
+
+
+def get_sensitive_headers():
+    """
+    Returns the set of registered sensitive headers.
+
+    Used by :mod:`swift.common.middleware.proxy_logging` to perform redactions
+    prior to logging.
+    """
+    return frozenset(_sensitive_headers)
+
+
+def register_sensitive_header(header):
+    """
+    Register a header as being "sensitive".
+
+    Sensitive headers are automatically redacted when logging. See the
+    ``reveal_sensitive_prefix`` option in the proxy-server sample config
+    for more information.
+
+    :param header: The (case-insensitive) header name which, if present, may
+        contain sensitive information. Examples include ``X-Auth-Token`` and
+        (if s3api is enabled) ``Authorization``. Limited to ASCII characters.
+    """
+    if not isinstance(header, str):
+        raise TypeError
+    header.encode('ascii')
+    _sensitive_headers.add(header.lower())
+
+
+def get_sensitive_params():
+    """
+    Returns the set of registered sensitive query parameters.
+
+    Used by :mod:`swift.common.middleware.proxy_logging` to perform redactions
+    prior to logging.
+    """
+    return frozenset(_sensitive_params)
+
+
+def register_sensitive_param(query_param):
+    """
+    Register a query parameter as being "sensitive".
+
+    Sensitive query parameters are automatically redacted when logging. See
+    the ``reveal_sensitive_prefix`` option in the proxy-server sample config
+    for more information.
+
+    :param query_param: The (case-sensitive) query parameter name which, if
+        present, may contain sensitive information. Examples include
+        ``temp_url_signature`` and (if s3api is enabled) ``X-Amz-Signature``.
+        Limited to ASCII characters.
+    """
+    if not isinstance(query_param, str):
+        raise TypeError
+    query_param.encode('ascii')
+    _sensitive_params.add(query_param)