c0b3d73189
Adding a constraints middleware that allows different constraints for a Swift-on-File storage policy. Currently, Swift allows only one set of object naming and metadata rules per cluster. As new storage policies are implemented, it is possible that different storage back-ends have different set of rules on how objects should be created for that specific storage system. Swift-on-File has different rules as objects name are mapped to a POSIX filesystem directory structure. For example: no names with double slashes or ending with slashes are allowed. At first a solution was proposed to include a generic patch in the upstream swift code, but after discussing with the Swift community it became clear that it would be better to have a global set of constraints that covers the whole cluster and if a specific storage policy has specific constraints than it should have its own middleware. Link to patch for reference: https://review.openstack.org/#/c/113325/ Change-Id: I323ead5d98bf5c087930ccf446d3e8d83075e584 Signed-off-by: Thiago da Silva <thiago@redhat.com>
67 lines
2.5 KiB
Python
67 lines
2.5 KiB
Python
# Copyright (c) 2012-2013 Red Hat, Inc.
|
|
#
|
|
# 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.
|
|
|
|
import os
|
|
from swift.common.swob import HTTPBadRequest
|
|
|
|
SOF_MAX_CONTAINER_NAME_LENGTH = 255
|
|
SOF_MAX_OBJECT_NAME_LENGTH = 221
|
|
# Why 221 ?
|
|
# The longest filename supported by XFS in 255.
|
|
# http://lxr.free-electrons.com/source/fs/xfs/xfs_types.h#L125
|
|
# SoF creates a temp file with following naming convention:
|
|
# .OBJECT_NAME.<random-string>
|
|
# The random string is 32 character long and and file name has two dots.
|
|
# Hence 255 - 32 - 2 = 221
|
|
# NOTE: This limitation can be sefely raised by having slashes in really long
|
|
# object name. Each segment between slashes ('/') should not exceed 221.
|
|
|
|
|
|
def validate_obj_name_component(obj):
|
|
if not obj:
|
|
return 'cannot begin, end, or have contiguous %s\'s' % os.path.sep
|
|
if len(obj) > SOF_MAX_OBJECT_NAME_LENGTH:
|
|
return 'too long (%d)' % len(obj)
|
|
if obj == '.' or obj == '..':
|
|
return 'cannot be . or ..'
|
|
return ''
|
|
|
|
|
|
def check_object_creation(req, object_name):
|
|
"""
|
|
Check to ensure that everything is alright about an object to be created.
|
|
Swift-on-File has extra constraints on object names regarding the
|
|
length of directories and the actual file name created on the Filesystem.
|
|
|
|
:param req: HTTP request object
|
|
:param object_name: name of object to be created
|
|
:raises HTTPRequestEntityTooLarge: the object is too large
|
|
:raises HTTPLengthRequered: missing content-length header and not
|
|
a chunked request
|
|
:raises HTTPBadRequest: missing or bad content-type header, or
|
|
bad metadata
|
|
"""
|
|
# SoF's additional checks
|
|
ret = None
|
|
for obj in object_name.split(os.path.sep):
|
|
reason = validate_obj_name_component(obj)
|
|
if reason:
|
|
bdy = 'Invalid object name "%s", component "%s" %s' \
|
|
% (object_name, obj, reason)
|
|
ret = HTTPBadRequest(body=bdy,
|
|
request=req,
|
|
content_type='text/plain')
|
|
return ret
|