Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CDPD-49779: [ozone] add ofs client (#3189)
(cherry picked from commit 6cc167a) (cherry picked from commit cca6b8e) Change-Id: I8d6dcce200f0f8b217da7e682f691ba66aa918da
- Loading branch information
Showing
3 changed files
with
293 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
# Licensed to Cloudera, Inc. under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. Cloudera, Inc. licenses this file | ||
# to you 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 re | ||
import posixpath | ||
|
||
from hadoop.fs import normpath as fs_normpath | ||
|
||
|
||
OFS_ROOT = 'ofs://' | ||
OFS_PATH_RE = re.compile('^/*[oO][fF][sS]?://([^/]+)(/(.*?([^/]+)?/?))?$') | ||
|
||
|
||
def is_root(uri): | ||
""" | ||
Check if URI is OFS root (ofs://) | ||
""" | ||
return uri.lower() == OFS_ROOT | ||
|
||
|
||
def normpath(path): | ||
""" | ||
Return normalized path but ignore leading OFS_ROOT prefix if it exists | ||
normpath('ofs://vol1/') == 'ofs://vol1' | ||
""" | ||
if path.lower().startswith(OFS_ROOT): | ||
if is_root(path): | ||
normalized = path | ||
else: | ||
normalized = '%s%s' % (OFS_ROOT, fs_normpath(path[len(OFS_ROOT):])) | ||
else: | ||
normalized = fs_normpath(path) | ||
return normalized | ||
|
||
|
||
def abspath(cd, uri): | ||
""" | ||
Returns absolute URI, examples: | ||
abspath('ofs://volume/bucket/key', key2') == 'ofs://volume/bucket/key/key2' | ||
abspath('ofs://volume/bucket/key', 'ofs://volume/bucket2/key2') == 'ofs://volume/bucket2/key2' | ||
""" | ||
if cd.lower().startswith(OFS_ROOT): | ||
uri = join(cd, uri) | ||
else: | ||
uri = normpath(join(cd, uri)) | ||
return uri | ||
|
||
|
||
def join(*comp_list): | ||
def _prep(uri): | ||
try: | ||
return '/%s/%s' % parse_uri(uri)[:2] | ||
except ValueError: | ||
return '/' if is_root(uri) else uri | ||
joined = posixpath.join(*list(map(_prep, comp_list))) | ||
if joined and joined[0] == '/': | ||
joined = 'ofs:/%s' % joined | ||
return joined | ||
|
||
|
||
def _append_separator(path): | ||
if path and not path.endswith('/'): | ||
path += '/' | ||
return path | ||
|
||
|
||
def parse_uri(uri): | ||
""" | ||
Returns tuple (volume_name, key_name, key_basename). | ||
Raises ValueError if invalid OFS URI is passed. | ||
ofs://volume1/bucket1/key1/key2 -> | ||
group1 -> volume1 | ||
group2 -> /bucket1/key1/key2 | ||
group3 -> bucket1/key1/key2 | ||
group4 -> key2 | ||
""" | ||
match = OFS_PATH_RE.match(uri) | ||
if not match: | ||
raise ValueError("Invalid OFS URI: %s" % uri) | ||
key_name = match.group(3) or '' | ||
key_basename = match.group(4) or '' | ||
return match.group(1), key_name, key_basename | ||
|
||
|
||
def parent_path(path): | ||
parent_dir = _append_separator(path) | ||
if not is_root(parent_dir): | ||
volume_name, key_name, key_basename = parse_uri(path) | ||
if not key_basename: # volume is top-level so return root | ||
parent_dir = OFS_ROOT | ||
else: | ||
volume_path = '%s%s' % (OFS_ROOT, volume_name) | ||
key_path = '/'.join(key_name.split('/')[:-1]) | ||
parent_dir = abspath(volume_path, key_path) | ||
return parent_dir |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
#!/usr/bin/env python | ||
# Licensed to Cloudera, Inc. under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. Cloudera, Inc. licenses this file | ||
# to you 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. | ||
|
||
from desktop import conf | ||
from desktop.lib.fs.ozone.ofs import OzoneFS | ||
|
||
|
||
def _make_ofs_client(identifier, user=None): | ||
config = conf.OZONE[identifier] if identifier in list(conf.OZONE.keys()) else None | ||
|
||
return OzoneFS.from_config(config) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,158 @@ | ||
#!/usr/bin/env python | ||
# Licensed to Cloudera, Inc. under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. Cloudera, Inc. licenses this file | ||
# to you 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. | ||
|
||
""" | ||
Interfaces for Hadoop filesystem access via HttpFs/WebHDFS | ||
""" | ||
import errno | ||
import logging | ||
import sys | ||
import threading | ||
|
||
from desktop.lib.rest import http_client, resource | ||
from desktop.lib.fs.ozone import OFS_ROOT, normpath, is_root, parent_path | ||
from desktop.lib.fs.ozone.ofsstat import OzoneFSStat | ||
from desktop.conf import PERMISSION_ACTION_OFS | ||
|
||
from hadoop.fs.exceptions import WebHdfsException | ||
from hadoop.hdfs_site import get_umask_mode | ||
from hadoop.fs.webhdfs import WebHdfs | ||
|
||
if sys.version_info[0] > 2: | ||
from django.utils.translation import gettext as _ | ||
from urllib.parse import urlparse as lib_urlparse | ||
else: | ||
from django.utils.translation import ugettext as _ | ||
from urlparse import urlparse as lib_urlparse | ||
|
||
|
||
LOG = logging.getLogger(__name__) | ||
|
||
|
||
def get_ofs_home_directory(): | ||
return OFS_ROOT | ||
|
||
|
||
class OzoneFS(WebHdfs): | ||
""" | ||
OzoneFS implements the filesystem interface via the WebHDFS/HttpFS REST protocol. | ||
""" | ||
def __init__(self, url, fs_defaultfs, logical_name=None, security_enabled=False, ssl_cert_ca_verify=True, temp_dir="/tmp", umask=0o1022): | ||
super(OzoneFS, self).__init__( | ||
url, | ||
fs_defaultfs, | ||
logical_name=logical_name, | ||
security_enabled=security_enabled, | ||
ssl_cert_ca_verify=ssl_cert_ca_verify, | ||
temp_dir=temp_dir, | ||
umask=umask | ||
) | ||
|
||
split = lib_urlparse(fs_defaultfs) | ||
self._scheme = split.scheme | ||
self._netloc = split.netloc | ||
|
||
self._filebrowser_action = PERMISSION_ACTION_OFS | ||
self._has_trash_support = False | ||
self._is_remote = True | ||
|
||
LOG.debug("Initializing Ozone client: %s (security: %s, superuser: %s)" % (self._url, self._security_enabled, self._superuser)) | ||
|
||
@classmethod | ||
def from_config(cls, ofs_config): | ||
return cls( | ||
url=ofs_config.WEBHDFS_URL.get(), | ||
fs_defaultfs=ofs_config.FS_DEFAULTFS.get(), | ||
logical_name=ofs_config.LOGICAL_NAME.get(), | ||
security_enabled=ofs_config.SECURITY_ENABLED.get(), | ||
ssl_cert_ca_verify=ofs_config.SSL_CERT_CA_VERIFY.get(), | ||
temp_dir=ofs_config.TEMP_DIR.get(), | ||
umask=get_umask_mode(), | ||
) | ||
|
||
def strip_normpath(self, path): | ||
if path.startswith('ofs://'): | ||
path = path[5:] | ||
elif path.startswith('ofs:/'): | ||
path = path[4:] | ||
return path | ||
|
||
def normpath(self, path): | ||
return normpath(path) | ||
|
||
def netnormpath(self, path): | ||
return normpath(path) | ||
|
||
def isroot(self, path): | ||
return is_root(path) | ||
|
||
def parent_path(self, path): | ||
return parent_path(path) | ||
|
||
def listdir_stats(self, path, glob=None): | ||
""" | ||
listdir_stats(path, glob=None) -> [ OzoneFSStat ] | ||
Get directory listing with stats. | ||
""" | ||
path = self.strip_normpath(path) | ||
params = self._getparams() | ||
if glob is not None: | ||
params['filter'] = glob | ||
params['op'] = 'LISTSTATUS' | ||
headers = self._getheaders() | ||
json = self._root.get(path, params, headers) | ||
filestatus_list = json['FileStatuses']['FileStatus'] | ||
return [OzoneFSStat(st, path) for st in filestatus_list] | ||
|
||
def _stats(self, path): | ||
""" | ||
This stats method returns None if the entry is not found. | ||
""" | ||
path = self.strip_normpath(path) | ||
params = self._getparams() | ||
params['op'] = 'GETFILESTATUS' | ||
headers = self._getheaders() | ||
try: | ||
json = self._root.get(path, params, headers) | ||
return OzoneFSStat(json['FileStatus'], path) | ||
except WebHdfsException as ex: | ||
if ex.server_exc == 'FileNotFoundException' or ex.code == 404: | ||
return None | ||
raise ex | ||
|
||
def stats(self, path): | ||
""" | ||
stats(path) -> OzoneFSStat | ||
""" | ||
res = self._stats(path) | ||
if res is not None: | ||
return res | ||
raise IOError(errno.ENOENT, _("File %s not found") % path) | ||
|
||
def filebrowser_action(self): | ||
return self._filebrowser_action | ||
|
||
def rename(self, old, new): | ||
self.copy(old, new, recursive=True) | ||
self.rmtree(old, skip_trash=True) | ||
|
||
def upload(self, file, path, *args, **kwargs): | ||
""" | ||
Upload is done by the OFSFileUploadHandler | ||
""" | ||
pass |