**** CubicPower OpenStack Study ****
# Copyright (c) 2011 Citrix Systems, Inc.
# Copyright 2011 OpenStack Foundation
#
# 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.
"""Classes to handle image files
Collection of classes to handle image upload/download to/from Image service
(like Glance image storage and retrieval service) from/to ESX/ESXi server.
"""
import httplib
import urllib
import urllib2
import six.moves.urllib.parse as urlparse
from nova.openstack.common.gettextutils import _
from nova.openstack.common import log as logging
from nova import utils
LOG = logging.getLogger(__name__)
USER_AGENT = "OpenStack-ESX-Adapter"
READ_CHUNKSIZE = 65536
**** CubicPower OpenStack Study ****
class GlanceFileRead(object):
"""Glance file read handler class."""
**** CubicPower OpenStack Study ****
def __init__(self, glance_read_iter):
self.glance_read_iter = glance_read_iter
self.iter = self.get_next()
**** CubicPower OpenStack Study ****
def read(self, chunk_size):
"""Read an item from the queue.
The chunk size is ignored for the Client ImageBodyIterator
uses its own CHUNKSIZE.
"""
try:
return self.iter.next()
except StopIteration:
return ""
**** CubicPower OpenStack Study ****
def get_next(self):
"""Get the next item from the image iterator."""
for data in self.glance_read_iter:
yield data
**** CubicPower OpenStack Study ****
def close(self):
"""A dummy close just to maintain consistency."""
pass
**** CubicPower OpenStack Study ****
class VMwareHTTPFile(object):
"""Base class for HTTP file."""
**** CubicPower OpenStack Study ****
def __init__(self, file_handle):
self.eof = False
self.file_handle = file_handle
**** CubicPower OpenStack Study ****
def set_eof(self, eof):
"""Set the end of file marker."""
self.eof = eof
**** CubicPower OpenStack Study ****
def get_eof(self):
"""Check if the end of file has been reached."""
return self.eof
**** CubicPower OpenStack Study ****
def close(self):
"""Close the file handle."""
try:
self.file_handle.close()
except Exception as exc:
LOG.exception(exc)
**** CubicPower OpenStack Study ****
def _build_vim_cookie_headers(self, vim_cookies):
"""Build ESX host session cookie headers."""
cookie_header = ""
for vim_cookie in vim_cookies:
cookie_header = vim_cookie.name + "=" + vim_cookie.value
break
return cookie_header
**** CubicPower OpenStack Study ****
def write(self, data):
"""Write data to the file."""
raise NotImplementedError()
**** CubicPower OpenStack Study ****
def read(self, chunk_size):
"""Read a chunk of data."""
raise NotImplementedError()
**** CubicPower OpenStack Study ****
def get_size(self):
"""Get size of the file to be read."""
raise NotImplementedError()
**** CubicPower OpenStack Study ****
class VMwareHTTPWriteFile(VMwareHTTPFile):
"""VMware file write handler class."""
**** CubicPower OpenStack Study ****
def __init__(self, host, data_center_name, datastore_name, cookies,
file_path, file_size, scheme="https"):
if utils.is_valid_ipv6(host):
base_url = "%s://[%s]/folder/%s" % (scheme, host, file_path)
else:
base_url = "%s://%s/folder/%s" % (scheme, host, file_path)
param_list = {"dcPath": data_center_name, "dsName": datastore_name}
base_url = base_url + "?" + urllib.urlencode(param_list)
_urlparse = urlparse.urlparse(base_url)
scheme, netloc, path, params, query, fragment = _urlparse
if scheme == "http":
conn = httplib.HTTPConnection(netloc)
elif scheme == "https":
conn = httplib.HTTPSConnection(netloc)
conn.putrequest("PUT", path + "?" + query)
conn.putheader("User-Agent", USER_AGENT)
conn.putheader("Content-Length", file_size)
conn.putheader("Cookie", self._build_vim_cookie_headers(cookies))
conn.endheaders()
self.conn = conn
VMwareHTTPFile.__init__(self, conn)
**** CubicPower OpenStack Study ****
def write(self, data):
"""Write to the file."""
self.file_handle.send(data)
**** CubicPower OpenStack Study ****
def close(self):
"""Get the response and close the connection."""
try:
self.conn.getresponse()
except Exception as excep:
LOG.debug(_("Exception during HTTP connection close in "
"VMwareHTTPWrite. Exception is %s") % excep)
super(VMwareHTTPWriteFile, self).close()
**** CubicPower OpenStack Study ****
class VMwareHTTPReadFile(VMwareHTTPFile):
"""VMware file read handler class."""
**** CubicPower OpenStack Study ****
def __init__(self, host, data_center_name, datastore_name, cookies,
file_path, scheme="https"):
base_url = "%s://%s/folder/%s" % (scheme, host,
urllib.pathname2url(file_path))
param_list = {"dcPath": data_center_name, "dsName": datastore_name}
base_url = base_url + "?" + urllib.urlencode(param_list)
headers = {'User-Agent': USER_AGENT,
'Cookie': self._build_vim_cookie_headers(cookies)}
request = urllib2.Request(base_url, None, headers)
conn = urllib2.urlopen(request)
VMwareHTTPFile.__init__(self, conn)
**** CubicPower OpenStack Study ****
def read(self, chunk_size):
"""Read a chunk of data."""
# We are ignoring the chunk size passed for we want the pipe to hold
# data items of the chunk-size that Glance Client uses for read
# while writing.
return self.file_handle.read(READ_CHUNKSIZE)
**** CubicPower OpenStack Study ****
def get_size(self):
"""Get size of the file to be read."""
return self.file_handle.headers.get("Content-Length", -1)