swiftonhpss/swiftonfile/swift/common/constraints.py
Prashanth Pai c6aae2b0cc Allow marker dir objects ending with slash
Allow a slash at the end of object file name but ONLY if the PUT
request also has a "Content-type: application/directory" header.

Change-Id: Ic775de052ee3635e95f5e32ca6e2038909fe1005
Signed-off-by: Prashanth Pai <ppai@redhat.com>
2015-02-26 12:04:09 +05:30

106 lines
4.2 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_DIR_NAME_LENGTH = 255
# A container is also a directory on the fileystem with the same name. Hence:
SOF_MAX_CONTAINER_NAME_LENGTH = SOF_MAX_DIR_NAME_LENGTH
SOF_MAX_OBJECT_FILENAME_LENGTH = 221
# SOF_MAX_OBJECT_FILENAME_LENGTH is the length of the last segment of object
# name. Each 'segment/component' is separated by a '/'.
# For example: If object name is "abc/def/ghi/jkl", then abc,def,ghi are all
# directories and "jkl" would be the file. This file name cannot exceed
# SOF_MAX_OBJECT_FILENAME_LENGTH.
# 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: Each segment between slashes ('/') should not exceed 255 and the last
# segment should not exceed 221.
def validate_obj_name_component(obj, req, last_component=False):
marker_dir = False
if req.headers.get('content-type', None):
marker_dir = req.headers.get('content-type', '').lower()\
== 'application/directory'
if not obj:
# Encountered extra slash somewhere, so obj component is empty
if last_component:
if marker_dir:
# Allow directory marker objects if it ends with slash
pass # Check further for length, don't return yet
else:
return 'can end with a slash only if it is a directory marker'\
' object with "Content-Type: application/directory" header'
else:
return 'cannot begin, end, or have contiguous %s\'s' % os.path.sep
if not last_component or (last_component and marker_dir):
# Will result in directory creation
if len(obj) > SOF_MAX_DIR_NAME_LENGTH:
return 'has component %s too long (%d)' % (obj, len(obj))
else:
# Last component: will result in file creation
if len(obj) > SOF_MAX_OBJECT_FILENAME_LENGTH:
return 'has component %s too long (%d)' % (obj, len(obj))
if obj == '.' or obj == '..':
return 'cannot have . 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
object_name_components = object_name.split(os.path.sep)
last_component = False
for i, obj in enumerate(object_name_components):
if i == (len(object_name_components) - 1):
last_component = True
reason = validate_obj_name_component(obj, req, last_component)
if reason:
bdy = 'Invalid object name "%s", object path %s' \
% (object_name, reason)
ret = HTTPBadRequest(body=bdy,
request=req,
content_type='text/plain')
# Return on first invalid component, does not check rest of
# the object path
break
return ret