visor-image 0.0.1

data/lib/image/routes/get_images_detail.rb

@@ -0,0 +1,54 @@
+require 'goliath'
+
+module Visor
+  module Image
+
+    # Get detailed information about all public images.
+    #
+    class GetImagesDetail < Goliath::API
+      include Visor::Common::Exception
+      include Visor::Common::Util
+      use Goliath::Rack::Render, ['json', 'xml']
+
+      # Pre-process headers as they arrive and load them into a environment variable.
+      #
+      # @param [Object] env The Goliath environment variables.
+      # @param [Object] headers The incoming request HTTP headers.
+      #
+      def on_headers(env, headers)
+        logger.debug "Received headers: #{headers.inspect}"
+        env['headers'] = headers
+      end
+
+      # Query database to retrieve the public images detailed meta and return it in request body.
+      #
+      # @param [Object] env The Goliath environment variables.
+      #
+      # @return [Array] The HTTP response containing the images
+      #   metadata or an error code and its messages if anything was raised.
+      #
+      def response(env)
+        access_key = authorize(env, vas)
+        meta = vms.get_images_detail(params, access_key)
+        [200, {}, {images: meta}]
+      rescue Forbidden => e
+        exit_error(403, e.message)
+      rescue NotFound => e
+        exit_error(404, e.message)
+      end
+
+      # Produce an HTTP response with an error code and message.
+      #
+      # @param [Fixnum] code The error code.
+      # @param [String] message The error message.
+      #
+      # @return [Array] The HTTP response containing an error code and its message.
+      #
+      def exit_error(code, message)
+        logger.error message
+        [code, {}, {code: code, message: message}]
+      end
+    end
+
+  end
+end

data/lib/image/routes/head_image.rb

@@ -0,0 +1,51 @@
+require 'goliath'
+
+module Visor
+  module Image
+
+    # Head metadata about the image with the given id.
+    #
+    class HeadImage < Goliath::API
+      include Visor::Common::Exception
+      include Visor::Common::Util
+
+      # Pre-process headers as they arrive and load them into a environment variable.
+      #
+      # @param [Object] env The Goliath environment variables.
+      # @param [Object] headers The incoming request HTTP headers.
+      #
+      def on_headers(env, headers)
+        logger.debug "Received headers: #{headers.inspect}"
+        env['headers'] = headers
+      end
+
+      # Query database to retrieve the wanted image meta and return it as HTTP headers.
+      #
+      # @param [Object] env The Goliath environment variables.
+      #
+      def response(env)
+        authorize(env, vas)
+        meta   = vms.get_image(params[:id])
+        header = push_meta_into_headers(meta)
+        [200, header, nil]
+      rescue Forbidden => e
+        exit_error(403, e.message)
+      rescue NotFound => e
+        exit_error(404, e.message)
+      end
+
+      # Produce an HTTP response with an error code and message.
+      #
+      # @param [Fixnum] code The error code.
+      # @param [String] message The error message.
+      #
+      # @return [Array] The HTTP response containing an error code and its message.
+      #
+      def exit_error(code, message)
+        logger.error message
+        [code, {'x-error-code' => code.to_s, 'x-error-message' => message}, nil]
+      end
+    end
+
+  end
+end

data/lib/image/routes/post_image.rb

@@ -0,0 +1,189 @@
+require 'goliath'
+require 'digest/md5'
+
+module Visor
+  module Image
+
+    # Post image data and metadata and returns the registered metadata.
+    #
+    class PostImage < Goliath::API
+      include Visor::Common::Exception
+      include Visor::Common::Util
+      use Goliath::Rack::Render, ['json', 'xml']
+
+      # Pre-process headers as they arrive and load them into a environment variable.
+      #
+      # @param [Object] env The Goliath environment variables.
+      # @param [Object] headers The incoming request HTTP headers.
+      #
+      def on_headers(env, headers)
+        logger.debug "Received headers: #{headers.inspect}"
+        env['headers'] = headers
+      end
+
+      # Pre-process body as it arrives in streaming chunks and load them into a tempfile.
+      #
+      # @param [Object] env The Goliath environment variables.
+      # @param [Object] data The incoming request HTTP body chunks.
+      #
+      def on_body(env, data)
+        (env['body'] ||= Tempfile.open('visor-image', encoding: 'ascii-8bit')) << data
+        (env['md5'] ||= Digest::MD5.new) << data
+      end
+
+      # Main response method which processes the received headers and body,
+      # managing image metadata and file data.
+      #
+      # @param [Object] env The Goliath environment variables.
+      #
+      # @return [Array] The HTTP response containing the already inserted image
+      #   metadata or an error code and its message if anything was raised.
+      #
+      def response(env)
+        begin
+          access_key = authorize(env, vas)
+        rescue Forbidden => e
+          return exit_error(403, e.message)
+        end
+
+        meta         = pull_meta_from_headers(env['headers'])
+        meta[:owner] = access_key
+        body         = env['body']
+        location     = meta[:location]
+
+        if location && body
+          msg = 'When the location header is present no file content can be provided'
+          return exit_error(400, msg)
+        end
+
+        if meta[:store] == 'http' || (location && location.split(':').first == 'http')
+          return exit_error(400, 'Cannot post an image file to a HTTP backend') if body
+          store = Visor::Image::Store::HTTP.new(location)
+
+          exist, meta[:size], meta[:checksum] = store.file_exists?(false)
+          return exit_error(404, "No image file found at #{location}") unless exist
+        end
+
+        # first registers the image meta or raises on error
+        begin
+          image = insert_meta(meta)
+        rescue ArgumentError => e
+          body.close if body
+          body.unlink if body
+          return exit_error(400, e.message)
+        rescue InternalError => e
+          body.close if body
+          body.unlink if body
+          return exit_error(500, e.message)
+        end
+
+        # if has body(image file), upload file and update meta or raise on error
+        begin
+          image = upload_and_update(env['id'], body)
+        rescue UnsupportedStore, ArgumentError => e
+          return exit_error(400, e.message, true)
+        rescue NotFound => e
+          return exit_error(404, e.message, true)
+        rescue Duplicated => e
+          return exit_error(409, e.message, true)
+        ensure
+          body.close
+          body.unlink
+        end unless body.nil?
+
+        [200, {}, {image: image}]
+      end
+
+      # On connection close log a message.
+      #
+      # @param [Object] env The Goliath environment variables.
+      #
+      def on_close(env)
+        logger.info 'Connection closed'
+      end
+
+      # Produce an HTTP response with an error code and message.
+      #
+      # @param [Fixnum] code The error code.
+      # @param [String] message The error message.
+      # @param [True, False] set_status (false) If true, update the image status to 'error'.
+      #
+      # @return [Array] The HTTP response containing an error code and its message.
+      #
+      def exit_error(code, message, set_status=false)
+        logger.error message
+        begin
+          vms.put_image(env['id'], status: 'error') if set_status
+        rescue => e
+          logger.error "Unable to set image #{env['id']} status to 'error': #{e.message}"
+        end
+        [code, {}, {code: code, message: message}]
+      end
+
+      # Insert image metadata on database (which set its status to locked).
+      #
+      # @param [Hash] meta The image metadata.
+      #
+      # @return [Hash] The already inserted image metadata.
+      #
+      def insert_meta(meta)
+        image     = vms.post_image(meta)
+        env['id'] = image[:_id]
+
+        if image[:location]
+          logger.debug "Location for image #{env['id']} is #{image[:location]}"
+          logger.debug "Setting image #{env['id']} status to 'available'"
+          vms.put_image(env['id'], status: 'available')
+        else
+          image
+        end
+      end
+
+      # Update image status and launch upload.
+      #
+      # @param [Fixnum] id The image _id.
+      # @param [FIle] body The image body tempfile descriptor.
+      #
+      # @return [Hash] The already updated image metadata.
+      #
+      def upload_and_update(id, body)
+        logger.debug "Setting image #{id} status to 'uploading'"
+        meta           = vms.put_image(id, status: 'uploading')
+        checksum       = env['md5']
+        location, size = do_upload(id, meta, body)
+
+        logger.debug "Updating image #{id} meta:"
+        logger.debug "Setting status to 'available'"
+        logger.debug "Setting location to '#{location}'"
+        logger.debug "Setting size to '#{size}'"
+        logger.debug "Setting checksum to '#{checksum}'"
+        vms.put_image(id, status: 'available', uploaded_at: Time.now, location: location, size: size, checksum: checksum)
+      end
+
+      # Upload image file to wanted store.
+      #
+      # @param [Fixnum] id The image _id.
+      # @param [Hash] meta The image metadata.
+      # @param [FIle] body The image body tempfile descriptor.
+      #
+      # @return [Array] Image file location URI and size.
+      #
+      # @raise [ArgumentError] If request Content-Type isn't 'application/octet-stream'
+      #
+      def do_upload(id, meta, body)
+        content_type = env['headers']['Content-Type'] || ''
+        store_name   = meta[:store] || configs[:default]
+        format       = meta[:format] || 'none'
+
+        unless content_type == 'application/octet-stream'
+          raise ArgumentError, 'Request Content-Type must be application/octet-stream'
+        end
+
+        store = Visor::Image::Store.get_backend(store_name, configs)
+        logger.debug "Uploading image #{id} data to #{store_name} store"
+        store.save(id, body, format)
+      end
+    end
+
+  end
+end

data/lib/image/routes/put_image.rb

@@ -0,0 +1,205 @@
+require 'goliath'
+require 'digest/md5'
+
+module Visor
+  module Image
+
+    # Put image metadata and/or data for the image with the given id.
+    #
+    class PutImage < Goliath::API
+      include Visor::Common::Exception
+      include Visor::Common::Util
+      use Goliath::Rack::Render, ['json', 'xml']
+
+      # Pre-process headers as they arrive and load them into a environment variable.
+      #
+      # @param [Object] env The Goliath environment variables.
+      # @param [Object] headers The incoming request HTTP headers.
+      #
+      def on_headers(env, headers)
+        logger.debug "Received headers: #{headers.inspect}"
+        env['headers'] = headers
+      end
+
+      # Pre-process body as it arrives in streaming chunks and load them into a tempfile.
+      #
+      # @param [Object] env The Goliath environment variables.
+      # @param [Object] data The incoming request HTTP body chunks.
+      #
+      def on_body(env, data)
+        (env['body'] ||= Tempfile.open('visor-image', encoding: 'ascii-8bit')) << data
+        (env['md5'] ||= Digest::MD5.new) << data
+      end
+
+      # Main response method which processes the received headers and body,
+      # managing image metadata and file data.
+      #
+      # @param [Object] env The Goliath environment variables.
+      #
+      # @return [Array] The HTTP response containing the already inserted image
+      #   metadata or an error code and its message if anything was raised.
+      #
+      def response(env)
+        begin
+          authorize(env, vas)
+        rescue Forbidden => e
+          return exit_error(403, e.message)
+        end
+
+        meta     = pull_meta_from_headers(env['headers'])
+        body     = env['body']
+        id       = params[:id]
+        location = meta[:location]
+
+        # a valid update requires the presence of headers and/or body
+        if meta.empty? && body.nil?
+          msg = 'No headers or body found for update'
+          return exit_error(400, msg)
+        end
+        # only the x-image-meta-location header or the body content should be provided
+        if location && body
+          msg = 'When the location header is present no file content can be provided'
+          return exit_error(400, msg)
+        end
+
+        if meta[:store] == 'http' || (location && location.split(':').first == 'http')
+          return exit_error(400, 'Cannot post an image file to a HTTP backend') if body
+          store = Visor::Image::Store::HTTP.new(location)
+
+          exist, meta[:size], meta[:checksum] = store.file_exists?(false)
+          return exit_error(404, "No image file found at #{location}") unless exist
+        end
+
+        # first update the image meta or raises on error
+        begin
+          image = update_meta(id, meta)
+        rescue NotFound => e
+          return exit_error(404, e.message)
+        rescue ArgumentError => e
+          body.close if body
+          body.unlink if body
+          return exit_error(400, e.message)
+        rescue InternalError => e
+          body.close if body
+          body.unlink if body
+          return exit_error(500, e.message)
+        end unless meta.empty?
+
+        # if has body(image file), upload file and update meta or raise on error
+        begin
+          image = upload_and_update(id, body)
+        rescue UnsupportedStore, ArgumentError => e
+          return exit_error(400, e.message, true)
+        rescue NotFound => e
+          return exit_error(404, e.message, true)
+        rescue ConflictError => e
+          return exit_error(409, e.message)
+        rescue Duplicated => e
+          return exit_error(409, e.message, true)
+        ensure
+          body.close
+          body.unlink
+        end unless body.nil?
+
+        [200, {}, {image: image}]
+      end
+
+      # On connection close log a message.
+      #
+      # @param [Object] env The Goliath environment variables.
+      #
+      def on_close(env)
+        logger.info 'Connection closed'
+      end
+
+      # Produce an HTTP response with an error code and message.
+      #
+      # @param [Fixnum] code The error code.
+      # @param [String] message The error message.
+      # @param [True, False] set_status (false) If true, update the image status to 'error'.
+      #
+      # @return [Array] The HTTP response containing an error code and its message.
+      #
+      def exit_error(code, message, set_status=false)
+        logger.error message
+        begin
+          vms.put_image(params[:id], status: 'error') if set_status
+        rescue => e
+          logger.error "Unable to set image #{env['id']} status to 'error': #{e.message}"
+        end
+        [code, {}, {code: code, message: message}]
+      end
+
+      # Update image metadata and set status if needed.
+      #
+      # @param [Hash] meta The image metadata.
+      #
+      # @return [Hash] The already inserted image metadata.
+      #
+      def update_meta(id, meta)
+        logger.debug "Updating image #{id} meta:"
+        logger.debug "#{id} #{meta}"
+        image = vms.put_image(id, meta)
+        image.each { |k, v| logger.debug "#{k.to_s.capitalize} setted to '#{v}'" if v }
+
+        if image[:location]
+          logger.debug "Location for image #{env['id']} is #{image[:location]}"
+          logger.debug "Setting image #{env['id']} status to 'available'"
+          vms.put_image(id, status: 'available')
+        else
+          image
+        end
+      end
+
+      # Update image status and launch upload.
+      #
+      # @param [Fixnum] id The image _id.
+      # @param [FIle] body The image body tempfile descriptor.
+      #
+      # @return [Hash] The already updated image metadata.
+      #
+      def upload_and_update(id, body)
+        meta     = vms.get_image(id)
+        checksum = env['md5']
+        valid    = (meta[:status] == 'locked' || meta[:status] == 'error')
+        raise ConflictError, 'Can only assign image file to a locked or error image' unless valid
+
+        logger.debug "Setting image #{id} status to 'uploading'"
+        meta           = vms.put_image(id, status: 'uploading')
+        location, size = do_upload(id, meta, body)
+
+        logger.debug "Updating image #{id} meta:"
+        logger.debug "Setting status to 'available'"
+        logger.debug "Setting location to '#{location}'"
+        logger.debug "Setting size to '#{size}'"
+        logger.debug "Setting checksum to '#{checksum}'"
+        vms.put_image(id, status: 'available', location: location, size: size, checksum: checksum)
+      end
+
+      # Upload image file to wanted store.
+      #
+      # @param [Fixnum] id The image _id.
+      # @param [Hash] meta The image metadata.
+      # @param [FIle] body The image body tempfile descriptor.
+      #
+      # @return [Array] Image file location URI and size.
+      #
+      # @raise [ArgumentError] If request Content-Type isn't 'application/octet-stream'
+      #
+      def do_upload(id, meta, body)
+        content_type = env['headers']['Content-Type'] || ''
+        store_name   = meta[:store] || configs[:default]
+        format       = meta[:format] || 'none'
+
+        unless content_type == 'application/octet-stream'
+          raise ArgumentError, 'Request Content-Type must be application/octet-stream'
+        end
+
+        store = Visor::Image::Store.get_backend(store_name, configs)
+        logger.debug "Uploading image #{id} data to #{store_name} store"
+        store.save(id, body, format)
+      end
+    end
+
+  end
+end