266 lines
8.5 KiB
Python
266 lines
8.5 KiB
Python
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
|
|
|
# Copyright 2010 OpenStack, LLC
|
|
# All Rights Reserved.
|
|
#
|
|
# 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.
|
|
|
|
"""
|
|
Client classes for callers of a Glance system
|
|
"""
|
|
|
|
import httplib
|
|
import json
|
|
import logging
|
|
import urlparse
|
|
import socket
|
|
import sys
|
|
|
|
from glance import util
|
|
from glance.common import exception
|
|
|
|
#TODO(jaypipes) Allow a logger param for client classes
|
|
|
|
|
|
class ClientConnectionError(Exception):
|
|
"""Error resulting from a client connecting to a server"""
|
|
pass
|
|
|
|
|
|
class ImageBodyIterator(object):
|
|
|
|
"""
|
|
A class that acts as an iterator over an image file's
|
|
chunks of data. This is returned as part of the result
|
|
tuple from `glance.client.Client.get_image`
|
|
"""
|
|
|
|
CHUNKSIZE = 65536
|
|
|
|
def __init__(self, response):
|
|
"""
|
|
Constructs the object from an HTTPResponse object
|
|
"""
|
|
self.response = response
|
|
|
|
def __iter__(self):
|
|
"""
|
|
Exposes an iterator over the chunks of data in the
|
|
image file.
|
|
"""
|
|
while True:
|
|
chunk = self.response.read(ImageBodyIterator.CHUNKSIZE)
|
|
if chunk:
|
|
yield chunk
|
|
else:
|
|
break
|
|
|
|
|
|
class BaseClient(object):
|
|
|
|
"""A base client class"""
|
|
|
|
DEFAULT_PORT = 9090
|
|
|
|
def __init__(self, host, port=None, use_ssl=False):
|
|
"""
|
|
Creates a new client to some service.
|
|
|
|
:param host: The host where service resides (defaults to 0.0.0.0)
|
|
:param port: The port where service resides (defaults to 9090)
|
|
:param use_ssl: Should we use HTTPS? (defaults to False)
|
|
"""
|
|
self.host = host
|
|
self.port = port or int(self.DEFAULT_PORT)
|
|
self.use_ssl = use_ssl
|
|
self.connection = None
|
|
|
|
def get_connection_type(self):
|
|
"""
|
|
Returns the proper connection type
|
|
"""
|
|
if self.use_ssl:
|
|
return httplib.HTTPSConnection
|
|
else:
|
|
return httplib.HTTPConnection
|
|
|
|
def do_request(self, method, action, body=None, headers=None):
|
|
"""
|
|
Connects to the server and issues a request. Handles converting
|
|
any returned HTTP error status codes to OpenStack/Glance exceptions
|
|
and closing the server connection. Returns the result data, or
|
|
raises an appropriate exception.
|
|
|
|
:param method: HTTP method ("GET", "POST", "PUT", etc...)
|
|
:param action: part of URL after root netloc
|
|
:param body: string of data to send, or None (default)
|
|
:param headers: mapping of key/value pairs to add as headers
|
|
"""
|
|
try:
|
|
connection_type = self.get_connection_type()
|
|
headers = headers or {}
|
|
c = connection_type(self.host, self.port)
|
|
c.request(method, action, body, headers)
|
|
res = c.getresponse()
|
|
status_code = self.get_status_code(res)
|
|
if status_code == httplib.OK:
|
|
return res
|
|
elif status_code == httplib.UNAUTHORIZED:
|
|
raise exception.NotAuthorized
|
|
elif status_code == httplib.FORBIDDEN:
|
|
raise exception.NotAuthorized
|
|
elif status_code == httplib.NOT_FOUND:
|
|
raise exception.NotFound
|
|
elif status_code == httplib.CONFLICT:
|
|
raise exception.Duplicate
|
|
elif status_code == httplib.BAD_REQUEST:
|
|
raise exception.BadInputError
|
|
else:
|
|
raise Exception("Unknown error occurred! %d" % status_code)
|
|
|
|
except (socket.error, IOError), e:
|
|
raise ClientConnectionError("Unable to connect to "
|
|
"server. Got error: %s" % e)
|
|
|
|
def get_status_code(self, response):
|
|
"""
|
|
Returns the integer status code from the response, which
|
|
can be either a Webob.Response (used in testing) or httplib.Response
|
|
"""
|
|
if hasattr(response, 'status_int'):
|
|
return response.status_int
|
|
else:
|
|
return response.status
|
|
|
|
|
|
class Client(BaseClient):
|
|
|
|
"""Main client class for accessing Glance resources"""
|
|
|
|
DEFAULT_HOST = '0.0.0.0'
|
|
DEFAULT_PORT = 9292
|
|
|
|
def __init__(self, host, port=None, use_ssl=False):
|
|
"""
|
|
Creates a new client to a Glance API service.
|
|
|
|
:param host: The host where Glance resides (defaults to 0.0.0.0)
|
|
:param port: The port where Glance resides (defaults to 9292)
|
|
:param use_ssl: Should we use HTTPS? (defaults to False)
|
|
"""
|
|
|
|
port = port or self.DEFAULT_PORT
|
|
super(Client, self).__init__(host, port, use_ssl)
|
|
|
|
def get_images(self):
|
|
"""
|
|
Returns a list of image id/name mappings from Registry
|
|
"""
|
|
res = self.do_request("GET", "/images")
|
|
data = json.loads(res.read())['images']
|
|
return data
|
|
|
|
def get_images_detailed(self):
|
|
"""
|
|
Returns a list of detailed image data mappings from Registry
|
|
"""
|
|
res = self.do_request("GET", "/images/detail")
|
|
data = json.loads(res.read())['images']
|
|
return data
|
|
|
|
def get_image(self, image_id):
|
|
"""
|
|
Returns a tuple with the image's metadata and the raw disk image as
|
|
a mime-encoded blob stream for the supplied opaque image identifier.
|
|
|
|
:param image_id: The opaque image identifier
|
|
|
|
:retval Tuple containing (image_meta, image_blob)
|
|
:raises exception.NotFound if image is not found
|
|
"""
|
|
# TODO(jaypipes): Handle other registries than Registry...
|
|
|
|
res = self.do_request("GET", "/images/%s" % image_id)
|
|
|
|
image = util.get_image_meta_from_headers(res)
|
|
return image, ImageBodyIterator(res)
|
|
|
|
def get_image_meta(self, image_id):
|
|
"""
|
|
Returns a mapping of image metadata from Registry
|
|
|
|
:raises exception.NotFound if image is not in registry
|
|
"""
|
|
res = self.do_request("HEAD", "/images/%s" % image_id)
|
|
|
|
image = util.get_image_meta_from_headers(res)
|
|
return image
|
|
|
|
def add_image(self, image_meta, image_data=None):
|
|
"""
|
|
Tells Glance about an image's metadata as well
|
|
as optionally the image_data itself
|
|
|
|
:param image_meta: Mapping of information about the
|
|
image
|
|
:param image_data: Optional string of raw image data
|
|
or file-like object that can be
|
|
used to read the image data
|
|
|
|
:retval The newly-stored image's metadata.
|
|
"""
|
|
if not image_data and 'location' not in image_meta.keys():
|
|
raise exception.Invalid("You must either specify a location "
|
|
"for the image or supply the actual "
|
|
"image data when adding an image to "
|
|
"Glance")
|
|
if image_data:
|
|
if hasattr(image_data, 'read'):
|
|
# TODO(jaypipes): This is far from efficient. Implement
|
|
# chunked transfer encoding if size is not in image_meta
|
|
body = image_data.read()
|
|
else:
|
|
body = image_data
|
|
else:
|
|
body = None
|
|
|
|
if not 'size' in image_meta.keys():
|
|
if body:
|
|
image_meta['size'] = len(body)
|
|
|
|
headers = util.image_meta_to_http_headers(image_meta)
|
|
|
|
if image_data:
|
|
headers['content-type'] = 'application/octet-stream'
|
|
|
|
res = self.do_request("POST", "/images", body, headers)
|
|
data = json.loads(res.read())
|
|
return data['image']['id']
|
|
|
|
def update_image(self, image_id, image_metadata):
|
|
"""
|
|
Updates Glance's information about an image
|
|
"""
|
|
if 'image' not in image_metadata.keys():
|
|
image_metadata = dict(image=image_metadata)
|
|
body = json.dumps(image_metadata)
|
|
self.do_request("PUT", "/images/%s" % image_id, body)
|
|
return True
|
|
|
|
def delete_image(self, image_id):
|
|
"""
|
|
Deletes Glance's information about an image
|
|
"""
|
|
self.do_request("DELETE", "/images/%s" % image_id)
|
|
return True
|