#!/usr/bin/env python

#

# Copyright 2007 Google 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.

#

"""Image manipulation API.

Classes defined in this module:

  Image: class used to encapsulate image information and transformations for

    that image.

    The current manipulations that are available are resize, rotate,

    horizontal_flip, vertical_flip, crop and im_feeling_lucky.

    It should be noted that each transform can only be called once per image

    per execute_transforms() call.

"""

import struct

from google.appengine.api import apiproxy_stub_map

from google.appengine.api.images import images_service_pb

from google.appengine.runtime import apiproxy_errors

JPEG = images_service_pb.OutputSettings.JPEG

PNG = images_service_pb.OutputSettings.PNG

OUTPUT_ENCODING_TYPES = frozenset([JPEG, PNG])

TOP_LEFT = images_service_pb.CompositeImageOptions.TOP_LEFT

TOP_CENTER = images_service_pb.CompositeImageOptions.TOP

TOP_RIGHT = images_service_pb.CompositeImageOptions.TOP_RIGHT

CENTER_LEFT = images_service_pb.CompositeImageOptions.LEFT

CENTER_CENTER = images_service_pb.CompositeImageOptions.CENTER

CENTER_RIGHT = images_service_pb.CompositeImageOptions.RIGHT

BOTTOM_LEFT = images_service_pb.CompositeImageOptions.BOTTOM_LEFT

BOTTOM_CENTER = images_service_pb.CompositeImageOptions.BOTTOM

BOTTOM_RIGHT = images_service_pb.CompositeImageOptions.BOTTOM_RIGHT

ANCHOR_TYPES = frozenset([TOP_LEFT, TOP_CENTER, TOP_RIGHT, CENTER_LEFT,

                          CENTER_CENTER, CENTER_RIGHT, BOTTOM_LEFT,

                          BOTTOM_CENTER, BOTTOM_RIGHT])

MAX_TRANSFORMS_PER_REQUEST = 10

MAX_COMPOSITES_PER_REQUEST = 16

class Error(Exception):

  """Base error class for this module."""

class TransformationError(Error):

  """Error while attempting to transform the image."""

class BadRequestError(Error):

  """The parameters given had something wrong with them."""

class NotImageError(Error):

  """The image data given is not recognizable as an image."""

class BadImageError(Error):

  """The image data given is corrupt."""

class LargeImageError(Error):

  """The image data given is too large to process."""

class InvalidBlobKeyError(Error):

  """The provided blob key was invalid."""

class Image(object):

  """Image object to manipulate."""

  def __init__(self, image_data=None, blob_key=None):

    """Constructor.

    Args:

      image_data: str, image data in string form.

      blob_key: str, image data as a blobstore blob key.

    Raises:

      NotImageError if the given data is empty.

    """

    if not image_data and not blob_key:

      raise NotImageError("Empty image data.")

    if image_data and blob_key:

      raise NotImageError("Can only take one image or blob key.")

    self._image_data = image_data

    self._blob_key = blob_key

    self._transforms = []

    self._width = None

    self._height = None

  def _check_transform_limits(self):

    """Ensure some simple limits on the number of transforms allowed.

    Raises:

      BadRequestError if MAX_TRANSFORMS_PER_REQUEST transforms have already been

      requested for this image

    """

    if len(self._transforms) >= MAX_TRANSFORMS_PER_REQUEST:

      raise BadRequestError("%d transforms have already been requested on this "

                            "image." % MAX_TRANSFORMS_PER_REQUEST)

  def _update_dimensions(self):

    """Updates the width and height fields of the image.

    Raises:

      NotImageError if the image data is not an image.

      BadImageError if the image data is corrupt.

    """

    if not self._image_data:

      raise NotImageError("Dimensions unavailable for blob key input")

    size = len(self._image_data)

    if size >= 6 and self._image_data.startswith("GIF"):

      self._update_gif_dimensions()

    elif size >= 8 and self._image_data.startswith("\x89PNG\x0D\x0A\x1A\x0A"):

      self._update_png_dimensions()

    elif size >= 2 and self._image_data.startswith("\xff\xD8"):

      self._update_jpeg_dimensions()

    elif (size >= 8 and (self._image_data.startswith("II\x2a\x00") or

                         self._image_data.startswith("MM\x00\x2a"))):

      self._update_tiff_dimensions()

    elif size >= 2 and self._image_data.startswith("BM"):

      self._update_bmp_dimensions()

    elif size >= 4 and self._image_data.startswith("\x00\x00\x01\x00"):

      self._update_ico_dimensions()

    else:

      raise NotImageError("Unrecognized image format")

  def _update_gif_dimensions(self):

    """Updates the width and height fields of the gif image.

    Raises:

      BadImageError if the image string is not a valid gif image.

    """

    size = len(self._image_data)

    if size >= 10:

      self._width, self._height = struct.unpack("<HH", self._image_data[6:10])

    else:

      raise BadImageError("Corrupt GIF format")

  def _update_png_dimensions(self):

    """Updates the width and height fields of the png image.

    Raises:

      BadImageError if the image string is not a valid png image.

    """

    size = len(self._image_data)

    if size >= 24 and self._image_data[12:16] == "IHDR":

      self._width, self._height = struct.unpack(">II", self._image_data[16:24])

    else:

      raise BadImageError("Corrupt PNG format")

  def _update_jpeg_dimensions(self):

    """Updates the width and height fields of the jpeg image.

    Raises:

      BadImageError if the image string is not a valid jpeg image.

    """

    size = len(self._image_data)

    offset = 2

    while offset < size:

      while offset < size and ord(self._image_data[offset]) != 0xFF:

        offset += 1

      while offset < size and ord(self._image_data[offset]) == 0xFF:

        offset += 1

      if (offset < size and ord(self._image_data[offset]) & 0xF0 == 0xC0 and

          ord(self._image_data[offset]) != 0xC4):

        offset += 4

        if offset + 4 <= size:

          self._height, self._width = struct.unpack(

              ">HH",

              self._image_data[offset:offset + 4])

          break

        else:

          raise BadImageError("Corrupt JPEG format")

      elif offset + 3 <= size:

        offset += 1

        offset += struct.unpack(">H", self._image_data[offset:offset + 2])[0]

      else:

        raise BadImageError("Corrupt JPEG format")

    if self._height is None or self._width is None:

      raise BadImageError("Corrupt JPEG format")

  def _update_tiff_dimensions(self):

    """Updates the width and height fields of the tiff image.

    Raises:

      BadImageError if the image string is not a valid tiff image.

    """

    size = len(self._image_data)

    if self._image_data.startswith("II"):

      endianness = "<"

    else:

      endianness = ">"

    ifd_offset = struct.unpack(endianness + "I", self._image_data[4:8])[0]

    if ifd_offset + 14 <= size:

      ifd_size = struct.unpack(

          endianness + "H",

          self._image_data[ifd_offset:ifd_offset + 2])[0]

      ifd_offset += 2

      for unused_i in range(0, ifd_size):

        if ifd_offset + 12 <= size:

          tag = struct.unpack(

              endianness + "H",

              self._image_data[ifd_offset:ifd_offset + 2])[0]

          if tag == 0x100 or tag == 0x101:

            value_type = struct.unpack(

                endianness + "H",

                self._image_data[ifd_offset + 2:ifd_offset + 4])[0]

            if value_type == 3:

              format = endianness + "H"

              end_offset = ifd_offset + 10

            elif value_type == 4:

              format = endianness + "I"

              end_offset = ifd_offset + 12

            else:

              format = endianness + "B"

              end_offset = ifd_offset + 9

            if tag == 0x100:

              self._width = struct.unpack(

                  format,

                  self._image_data[ifd_offset + 8:end_offset])[0]

              if self._height is not None:

                break

            else:

              self._height = struct.unpack(

                  format,

                  self._image_data[ifd_offset + 8:end_offset])[0]

              if self._width is not None:

                break

          ifd_offset += 12

        else:

          raise BadImageError("Corrupt TIFF format")

    if self._width is None or self._height is None:

      raise BadImageError("Corrupt TIFF format")

  def _update_bmp_dimensions(self):

    """Updates the width and height fields of the bmp image.

    Raises:

      BadImageError if the image string is not a valid bmp image.

    """

    size = len(self._image_data)

    if size >= 18:

      header_length = struct.unpack("<I", self._image_data[14:18])[0]

      if ((header_length == 40 or header_length == 108 or

           header_length == 124 or header_length == 64) and size >= 26):

        self._width, self._height = struct.unpack("<II",

                                                  self._image_data[18:26])

      elif header_length == 12 and size >= 22:

        self._width, self._height = struct.unpack("<HH",

                                                  self._image_data[18:22])

      else:

        raise BadImageError("Corrupt BMP format")

    else:

      raise BadImageError("Corrupt BMP format")

  def _update_ico_dimensions(self):

    """Updates the width and height fields of the ico image.

    Raises:

      BadImageError if the image string is not a valid ico image.

    """

    size = len(self._image_data)

    if size >= 8:

      self._width, self._height = struct.unpack("<BB", self._image_data[6:8])

      if not self._width:

        self._width = 256

      if not self._height:

        self._height = 256

    else:

      raise BadImageError("Corrupt ICO format")

  def resize(self, width=0, height=0):

    """Resize the image maintaining the aspect ratio.

    If both width and height are specified, the more restricting of the two

    values will be used when resizing the photo.  The maximum dimension allowed

    for both width and height is 4000 pixels.

    Args:

      width: int, width (in pixels) to change the image width to.

      height: int, height (in pixels) to change the image height to.

    Raises:

      TypeError when width or height is not either 'int' or 'long' types.

      BadRequestError when there is something wrong with the given height or

        width or if MAX_TRANSFORMS_PER_REQUEST transforms have already been

        requested on this image.

    """

    if (not isinstance(width, (int, long)) or

        not isinstance(height, (int, long))):

      raise TypeError("Width and height must be integers.")

    if width < 0 or height < 0:

      raise BadRequestError("Width and height must be >= 0.")

    if not width and not height:

      raise BadRequestError("At least one of width or height must be > 0.")

    if width > 4000 or height > 4000:

      raise BadRequestError("Both width and height must be <= 4000.")

    self._check_transform_limits()

    transform = images_service_pb.Transform()

    transform.set_width(width)

    transform.set_height(height)

    self._transforms.append(transform)

  def rotate(self, degrees):

    """Rotate an image a given number of degrees clockwise.

    Args:

      degrees: int, must be a multiple of 90.

    Raises:

      TypeError when degrees is not either 'int' or 'long' types.

      BadRequestError when there is something wrong with the given degrees or

      if MAX_TRANSFORMS_PER_REQUEST transforms have already been requested.

    """

    if not isinstance(degrees, (int, long)):

      raise TypeError("Degrees must be integers.")

    if degrees % 90 != 0:

      raise BadRequestError("degrees argument must be multiple of 90.")

    degrees = degrees % 360

    self._check_transform_limits()

    transform = images_service_pb.Transform()

    transform.set_rotate(degrees)

    self._transforms.append(transform)

  def horizontal_flip(self):

    """Flip the image horizontally.

    Raises:

      BadRequestError if MAX_TRANSFORMS_PER_REQUEST transforms have already been

      requested on the image.

    """

    self._check_transform_limits()

    transform = images_service_pb.Transform()

    transform.set_horizontal_flip(True)

    self._transforms.append(transform)

  def vertical_flip(self):

    """Flip the image vertically.

    Raises:

      BadRequestError if MAX_TRANSFORMS_PER_REQUEST transforms have already been

      requested on the image.

    """

    self._check_transform_limits()

    transform = images_service_pb.Transform()

    transform.set_vertical_flip(True)

    self._transforms.append(transform)

  def _validate_crop_arg(self, val, val_name):

    """Validate the given value of a Crop() method argument.

    Args:

      val: float, value of the argument.

      val_name: str, name of the argument.

    Raises:

      TypeError if the args are not of type 'float'.

      BadRequestError when there is something wrong with the given bounding box.

    """

    if type(val) != float:

      raise TypeError("arg '%s' must be of type 'float'." % val_name)

    if not (0 <= val <= 1.0):

      raise BadRequestError("arg '%s' must be between 0.0 and 1.0 "

                            "(inclusive)" % val_name)

  def crop(self, left_x, top_y, right_x, bottom_y):

    """Crop the image.

    The four arguments are the scaling numbers to describe the bounding box

    which will crop the image.  The upper left point of the bounding box will

    be at (left_x*image_width, top_y*image_height) the lower right point will

    be at (right_x*image_width, bottom_y*image_height).

    Args:

      left_x: float value between 0.0 and 1.0 (inclusive).

      top_y: float value between 0.0 and 1.0 (inclusive).

      right_x: float value between 0.0 and 1.0 (inclusive).

      bottom_y: float value between 0.0 and 1.0 (inclusive).

    Raises:

      TypeError if the args are not of type 'float'.

      BadRequestError when there is something wrong with the given bounding box

        or if MAX_TRANSFORMS_PER_REQUEST transforms have already been requested

        for this image.

    """

    self._validate_crop_arg(left_x, "left_x")

    self._validate_crop_arg(top_y, "top_y")

    self._validate_crop_arg(right_x, "right_x")

    self._validate_crop_arg(bottom_y, "bottom_y")

    if left_x >= right_x:

      raise BadRequestError("left_x must be less than right_x")

    if top_y >= bottom_y:

      raise BadRequestError("top_y must be less than bottom_y")

    self._check_transform_limits()

    transform = images_service_pb.Transform()

    transform.set_crop_left_x(left_x)

    transform.set_crop_top_y(top_y)

    transform.set_crop_right_x(right_x)

    transform.set_crop_bottom_y(bottom_y)

    self._transforms.append(transform)

  def im_feeling_lucky(self):

    """Automatically adjust image contrast and color levels.

    This is similar to the "I'm Feeling Lucky" button in Picasa.

    Raises:

      BadRequestError if MAX_TRANSFORMS_PER_REQUEST transforms have already

        been requested for this image.

    """

    self._check_transform_limits()

    transform = images_service_pb.Transform()

    transform.set_autolevels(True)

    self._transforms.append(transform)

  def _set_imagedata(self, imagedata):

    """Fills in an ImageData PB from this Image instance.

    Args:

      imagedata: An ImageData PB instance

    """

    if self._blob_key:

      imagedata.set_content("")

      imagedata.set_blob_key(self._blob_key)

    else:

      imagedata.set_content(self._image_data)

  def execute_transforms(self, output_encoding=PNG):

    """Perform transformations on given image.

    Args:

      output_encoding: A value from OUTPUT_ENCODING_TYPES.

    Returns:

      str, image data after the transformations have been performed on it.

    Raises:

      BadRequestError when there is something wrong with the request

        specifications.

      NotImageError when the image data given is not an image.

      BadImageError when the image data given is corrupt.

      LargeImageError when the image data given is too large to process.

      InvalidBlobKeyError when the blob key provided is invalid.

      TransformtionError when something errors during image manipulation.

      Error when something unknown, but bad, happens.

    """

    if output_encoding not in OUTPUT_ENCODING_TYPES:

      raise BadRequestError("Output encoding type not in recognized set "

                            "%s" % OUTPUT_ENCODING_TYPES)

    if not self._transforms:

      raise BadRequestError("Must specify at least one transformation.")

    request = images_service_pb.ImagesTransformRequest()

    response = images_service_pb.ImagesTransformResponse()

    self._set_imagedata(request.mutable_image())

    for transform in self._transforms:

      request.add_transform().CopyFrom(transform)

    request.mutable_output().set_mime_type(output_encoding)