# Copyright 2013 Nebula 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. # """Object v1 action implementations""" import logging import six from cliff import command from cliff import lister from cliff import show from openstackclient.common import utils from openstackclient.object.v1.lib import object as lib_object class CreateObject(lister.Lister): """Upload an object to a container""" log = logging.getLogger(__name__ + '.CreateObject') def get_parser(self, prog_name): parser = super(CreateObject, self).get_parser(prog_name) parser.add_argument( 'container', metavar='<container>', help='Container to store new object', ) parser.add_argument( 'objects', metavar='<object-name>', nargs="+", help='Local path of object(s) to upload', ) return parser def take_action(self, parsed_args): self.log.debug('take_action(%s)', parsed_args) results = [] for obj in parsed_args.objects: data = lib_object.create_object( self.app.client_manager.session, self.app.client_manager.object_store.endpoint, parsed_args.container, obj, ) results.append(data) columns = ("object", "container", "etag") return (columns, (utils.get_dict_properties( s, columns, formatters={}, ) for s in results)) class DeleteObject(command.Command): """Delete an object within a container""" log = logging.getLogger(__name__ + '.DeleteObject') def get_parser(self, prog_name): parser = super(DeleteObject, self).get_parser(prog_name) parser.add_argument( 'container', metavar='<container>', help='Container that stores the object to delete', ) parser.add_argument( 'objects', metavar='<object-name>', nargs="+", help='Object(s) to delete', ) return parser def take_action(self, parsed_args): self.log.debug('take_action(%s)', parsed_args) for obj in parsed_args.objects: lib_object.delete_object( self.app.restapi, self.app.client_manager.session, self.app.client_manager.object_store.endpoint, parsed_args.container, obj, ) class ListObject(lister.Lister): """List objects""" log = logging.getLogger(__name__ + '.ListObject') def get_parser(self, prog_name): parser = super(ListObject, self).get_parser(prog_name) parser.add_argument( "container", metavar="<container-name>", help="List contents of container-name", ) parser.add_argument( "--prefix", metavar="<prefix>", help="Filter list using <prefix>", ) parser.add_argument( "--delimiter", metavar="<delimiter>", help="Roll up items with <delimiter>", ) parser.add_argument( "--marker", metavar="<marker>", help="Anchor for paging", ) parser.add_argument( "--end-marker", metavar="<end-marker>", help="End anchor for paging", ) parser.add_argument( "--limit", metavar="<limit>", type=int, help="Limit the number of objects returned", ) parser.add_argument( '--long', action='store_true', default=False, help='List additional fields in output', ) parser.add_argument( '--all', action='store_true', default=False, help='List all objects in container (default is 10000)', ) return parser def take_action(self, parsed_args): self.log.debug('take_action(%s)', parsed_args) if parsed_args.long: columns = ( 'Name', 'Bytes', 'Hash', 'Content Type', 'Last Modified', ) else: columns = ('Name',) kwargs = {} if parsed_args.prefix: kwargs['prefix'] = parsed_args.prefix if parsed_args.delimiter: kwargs['delimiter'] = parsed_args.delimiter if parsed_args.marker: kwargs['marker'] = parsed_args.marker if parsed_args.end_marker: kwargs['end_marker'] = parsed_args.end_marker if parsed_args.limit: kwargs['limit'] = parsed_args.limit if parsed_args.all: kwargs['full_listing'] = True data = lib_object.list_objects( self.app.client_manager.session, self.app.client_manager.object_store.endpoint, parsed_args.container, **kwargs ) return (columns, (utils.get_dict_properties( s, columns, formatters={}, ) for s in data)) class SaveObject(command.Command): """Save an object locally""" log = logging.getLogger(__name__ + ".SaveObject") def get_parser(self, prog_name): parser = super(SaveObject, self).get_parser(prog_name) parser.add_argument( "--file", metavar="<filename>", help="Downloaded object filename [defaults to object name]", ) parser.add_argument( 'container', metavar='<container>', help='Container name that has the object', ) parser.add_argument( "object", metavar="<object>", help="Name of the object to save", ) return parser def take_action(self, parsed_args): self.log.debug("take_action(%s)", parsed_args) lib_object.save_object( self.app.client_manager.session, self.app.client_manager.object_store.endpoint, parsed_args.container, parsed_args.object, parsed_args.file, ) class ShowObject(show.ShowOne): """Show object information""" log = logging.getLogger(__name__ + '.ShowObject') def get_parser(self, prog_name): parser = super(ShowObject, self).get_parser(prog_name) parser.add_argument( 'container', metavar='<container>', help='Container name for object to display', ) parser.add_argument( 'object', metavar='<object>', help='Object name to display', ) return parser def take_action(self, parsed_args): self.log.debug('take_action(%s)', parsed_args) data = lib_object.show_object( self.app.client_manager.session, self.app.client_manager.object_store.endpoint, parsed_args.container, parsed_args.object, ) return zip(*sorted(six.iteritems(data)))