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

swift/common/middleware/{versioned_writes.py → versioned_writes/legacy.py}

@@ -14,6 +14,11 @@
 # limitations under the License.
 
 """
+.. note::
+    This middleware supports two legacy modes of object versioning that is
+    now replaced by a new mode. It is recommended to use the new
+    :ref:`Object Versioning <object_versioning>` mode for new containers.
+
 Object versioning in swift is implemented by setting a flag on the container
 to tell swift to version all objects in the container. The value of the flag is
 the URL-encoded container name where the versions are stored (commonly referred
@@ -225,7 +230,7 @@ import json
 import time
 
 from swift.common.utils import get_logger, Timestamp, \
-    register_swift_info, config_true_value, close_if_possible, FileLikeIter
+    config_true_value, close_if_possible, FileLikeIter, drain_and_close
 from swift.common.request_helpers import get_sys_meta_prefix, \
     copy_header_subset
 from swift.common.wsgi import WSGIContext, make_pre_authed_request
@@ -336,7 +341,8 @@ class VersionedWritesContext(WSGIContext):
                 lreq.environ['QUERY_STRING'] += '&reverse=on'
             lresp = lreq.get_response(self.app)
             if not is_success(lresp.status_int):
-                close_if_possible(lresp.app_iter)
+                # errors should be short
+                drain_and_close(lresp)
                 if lresp.status_int == HTTP_NOT_FOUND:
                     raise ListingIterNotFound()
                 elif is_client_error(lresp.status_int):
@@ -377,6 +383,8 @@ class VersionedWritesContext(WSGIContext):
 
         if source_resp.content_length is None or \
                 source_resp.content_length > MAX_FILE_SIZE:
+            # Consciously *don't* drain the response before closing;
+            # any logged 499 is actually rather appropriate here
             close_if_possible(source_resp.app_iter)
             return HTTPRequestEntityTooLarge(request=req)
 
@@ -397,6 +405,7 @@ class VersionedWritesContext(WSGIContext):
 
         put_req.environ['wsgi.input'] = FileLikeIter(source_resp.app_iter)
         put_resp = put_req.get_response(self.app)
+        # the PUT was responsible for draining
         close_if_possible(source_resp.app_iter)
         return put_resp
 
@@ -406,7 +415,8 @@ class VersionedWritesContext(WSGIContext):
         """
         if is_success(resp.status_int):
             return
-        close_if_possible(resp.app_iter)
+        # any error should be short
+        drain_and_close(resp)
         if is_client_error(resp.status_int):
             # missing container or bad permissions
             raise HTTPPreconditionFailed(request=req)
@@ -429,7 +439,7 @@ class VersionedWritesContext(WSGIContext):
         # making any backend requests
         if 'swift.authorize' in req.environ:
             container_info = get_container_info(
-                req.environ, self.app)
+                req.environ, self.app, swift_source='VW')
             req.acl = container_info.get('write_acl')
             aresp = req.environ['swift.authorize'](req)
             if aresp:
@@ -439,7 +449,7 @@ class VersionedWritesContext(WSGIContext):
 
         if get_resp.status_int == HTTP_NOT_FOUND:
             # nothing to version, proceed with original request
-            close_if_possible(get_resp.app_iter)
+            drain_and_close(get_resp)
             return
 
         # check for any other errors
@@ -457,10 +467,12 @@ class VersionedWritesContext(WSGIContext):
 
         put_path_info = "/%s/%s/%s/%s" % (
             api_version, account_name, versions_cont, vers_obj_name)
+        req.environ['QUERY_STRING'] = ''
         put_resp = self._put_versioned_obj(req, put_path_info, get_resp)
 
         self._check_response_error(req, put_resp)
-        close_if_possible(put_resp.app_iter)
+        # successful PUT response should be short
+        drain_and_close(put_resp)
 
     def handle_obj_versions_put(self, req, versions_cont, api_version,
                                 account_name, object_name):
@@ -515,7 +527,7 @@ class VersionedWritesContext(WSGIContext):
         marker_req.environ['swift.content_type_overridden'] = True
         marker_resp = marker_req.get_response(self.app)
         self._check_response_error(req, marker_resp)
-        close_if_possible(marker_resp.app_iter)
+        drain_and_close(marker_resp)
 
         # successfully copied and created delete marker; safe to delete
         return self.app
@@ -529,7 +541,7 @@ class VersionedWritesContext(WSGIContext):
 
         # if the version isn't there, keep trying with previous version
         if get_resp.status_int == HTTP_NOT_FOUND:
-            close_if_possible(get_resp.app_iter)
+            drain_and_close(get_resp)
             return False
 
         self._check_response_error(req, get_resp)
@@ -539,7 +551,7 @@ class VersionedWritesContext(WSGIContext):
         put_resp = self._put_versioned_obj(req, put_path_info, get_resp)
 
         self._check_response_error(req, put_resp)
-        close_if_possible(put_resp.app_iter)
+        drain_and_close(put_resp)
         return get_path
 
     def handle_obj_versions_delete_pop(self, req, versions_cont, api_version,
@@ -570,7 +582,7 @@ class VersionedWritesContext(WSGIContext):
                 # making any backend requests
                 if 'swift.authorize' in req.environ:
                     container_info = get_container_info(
-                        req.environ, self.app)
+                        req.environ, self.app, swift_source='VW')
                     req.acl = container_info.get('write_acl')
                     aresp = req.environ['swift.authorize'](req)
                     if aresp:
@@ -585,7 +597,7 @@ class VersionedWritesContext(WSGIContext):
                     req.environ, path=wsgi_quote(req.path_info), method='HEAD',
                     headers=obj_head_headers, swift_source='VW')
                 hresp = head_req.get_response(self.app)
-                close_if_possible(hresp.app_iter)
+                drain_and_close(hresp)
 
                 if hresp.status_int != HTTP_NOT_FOUND:
                     self._check_response_error(req, hresp)
@@ -601,6 +613,7 @@ class VersionedWritesContext(WSGIContext):
                         break
                     obj_to_restore = bytes_to_wsgi(
                         version_to_restore['name'].encode('utf-8'))
+                    req.environ['QUERY_STRING'] = ''
                     restored_path = self._restore_data(
                         req, versions_cont, api_version, account_name,
                         container_name, object_name, obj_to_restore)
@@ -612,7 +625,7 @@ class VersionedWritesContext(WSGIContext):
                         method='DELETE', headers=auth_token_header,
                         swift_source='VW')
                     del_resp = old_del_req.get_response(self.app)
-                    close_if_possible(del_resp.app_iter)
+                    drain_and_close(del_resp)
                     if del_resp.status_int != HTTP_NOT_FOUND:
                         self._check_response_error(req, del_resp)
                         # else, well, it existed long enough to do the
@@ -632,6 +645,7 @@ class VersionedWritesContext(WSGIContext):
                 # current object and delete the previous version
                 prev_obj_name = bytes_to_wsgi(
                     previous_version['name'].encode('utf-8'))
+                req.environ['QUERY_STRING'] = ''
                 restored_path = self._restore_data(
                     req, versions_cont, api_version, account_name,
                     container_name, object_name, prev_obj_name)
@@ -773,7 +787,7 @@ class VersionedWritesMiddleware(object):
         resp = None
         is_enabled = config_true_value(allow_versioned_writes)
         container_info = get_container_info(
-            req.environ, self.app)
+            req.environ, self.app, swift_source='VW')
 
         # To maintain backwards compatibility, container version
         # location could be stored as sysmeta or not, need to check both.
@@ -856,16 +870,3 @@ class VersionedWritesMiddleware(object):
                 return error_response(env, start_response)
         else:
             return self.app(env, start_response)
-
-
-def filter_factory(global_conf, **local_conf):
-    conf = global_conf.copy()
-    conf.update(local_conf)
-    if config_true_value(conf.get('allow_versioned_writes')):
-        register_swift_info('versioned_writes', allowed_flags=(
-            CLIENT_VERSIONS_LOC, CLIENT_HISTORY_LOC))
-
-    def obj_versions_filter(app):
-        return VersionedWritesMiddleware(app, conf)
-
-    return obj_versions_filter