dc_processor.MediaLimitsHandler.MediaLimitsHandler Class Reference

Inheritance diagram for dc_processor.MediaLimitsHandler.MediaLimitsHandler:

Collaboration diagram for dc_processor.MediaLimitsHandler.MediaLimitsHandler:

Classes
class	ImageLimits
class	ImageProperty

Public Member Functions
def	__init__ (self, propertyString)
def	isAllowedLimits (self, urlString, binaryType=False)

Public Attributes
	mediaLimits
	MEDIA_LIMITS_TYPE_NAME

Static Public Attributes
string	TEMP_FILE_SUFFIX = '.jpg'
string	BINARY_IMAGE_SEARCH_STR = 'base64,'
string	MEDIA_LIMITS_TYPE_NAME = 'img'

Private Member Functions
def	__getMediaLimits (self, propertyDict)
def	__loadProperty (self, propertyString)
def	__getImageLimits (self, limitsDict)
def	__saveImageToFile (self, content)
def	__loadImage (self, urlString, binaryType=False)
def	__getImageProperty (self, urlString, binaryType=False)
def	__isAllowedImage (self, imageLimits, imageProperty)
def	__dumpObj (self, obj)

Detailed Description

Definition at line 26 of file MediaLimitsHandler.py.

Constructor & Destructor Documentation

__init__()

def dc_processor.MediaLimitsHandler.MediaLimitsHandler.__init__	(		self,
			propertyString
	)

Definition at line 78 of file MediaLimitsHandler.py.

  def __init__(self, propertyString):
    # initialization variable content of limits structure
    self.mediaLimits = self.__getMediaLimits(self.__loadProperty(propertyString))

Member Function Documentation

__dumpObj()

def dc_processor.MediaLimitsHandler.MediaLimitsHandler.__dumpObj (   self,   obj  )

private

Definition at line 315 of file MediaLimitsHandler.py.

  def __dumpObj(self, obj):
    msg = 'Instance %s has:' % (str(type(obj)))
    if obj is not None:
      for name, value in obj.__dict__.items():
        msg += ("\n'%s' = %s") % (str(name), str(value))
    logger.debug(msg)

Here is the caller graph for this function:

__getImageLimits()

def dc_processor.MediaLimitsHandler.MediaLimitsHandler.__getImageLimits (   self,   limitsDict  )

private

Definition at line 134 of file MediaLimitsHandler.py.

  def __getImageLimits(self, limitsDict):
    # variable for result
    imageLimits = MediaLimitsHandler.ImageLimits()

    for key, value in MediaLimitsHandler.ImageLimits.propertyNamesDict.items():
      if value in limitsDict.keys() and hasattr(imageLimits, key):
        setattr(imageLimits, key, limitsDict[value])

    return imageLimits

__getImageProperty()

def dc_processor.MediaLimitsHandler.MediaLimitsHandler.__getImageProperty (   self,   urlString,   binaryType = False  )

private

Definition at line 199 of file MediaLimitsHandler.py.

  def __getImageProperty(self, urlString, binaryType=False):
    # variable for result
    ret = None
    logger.debug("Url string: %s", str(urlString))
    # load image and save to file
    imageFileName = self.__saveImageToFile(self.__loadImage(urlString, binaryType))
    if imageFileName is not None:
      try:
        # open file for extract data
        imageFile = Image.open(imageFileName)
        if imageFile is None:
          raise Exception("Cannot open image file: '%s'", str(imageFileName))

        # create instance
        imageProperty = MediaLimitsHandler.ImageProperty()
        # set format of image
        imageProperty.format = imageFile.format
        # set width
        if len(imageFile.size) > 0:
          imageProperty.width = imageFile.size[0]
        # set height
        if len(imageFile.size) > 1:
          imageProperty.height = imageFile.size[1]

        if imageProperty.width > 0 and imageProperty.height > 0:
          # set ratio
          imageProperty.ratio = float(imageProperty.height) / imageProperty.width
          # set colors count
          size = imageProperty.width * imageProperty.height
          vm = psutil.virtual_memory()
          logger.debug("Image size = %s, available memory = %s", str(size), str(vm.available))
          if vm.available < size:
            logger.debug("!!! Not enough memory for get colors... Skipped")
          else:
            colors = imageFile.getcolors(size)
            if colors is not None:
              imageProperty.colors = len(colors)

        ret = imageProperty
      except Exception, err:
        logger.debug("Error: %s", str(err))
      finally:
        if os.path.isfile(imageFileName):
          os.remove(imageFileName)
          logger.debug('Remove file: %s', str(imageFileName))

    return ret

Here is the call graph for this function:

Here is the caller graph for this function:

__getMediaLimits()

def dc_processor.MediaLimitsHandler.MediaLimitsHandler.__getMediaLimits (   self,   propertyDict  )

private

Definition at line 87 of file MediaLimitsHandler.py.

  def __getMediaLimits(self, propertyDict):
    # variable for result
    ret = None
    try:
      if not isinstance(propertyDict, dict):
        raise Exception("Wrong type of property: %s" % str(type(property)))

      for key, value in propertyDict.items():
        logger.debug("Enter to read property '%s'", str(key))
        if self.MEDIA_LIMITS_TYPE_NAME == key:
          if isinstance(value, dict):
            ret = self.__getImageLimits(value)
          else:
            logger.debug("Wrong type of limits: '%s'. Skipped", str(type(value)))
        else:
          logger.error("Unsupported name of limits: '%s'. Skipped", str(key))

        logger.debug("Leave to read property '%s'", str(key))

    except Exception, err:
      logger.error("Error: %s", str(err))

    return ret

__isAllowedImage()

def dc_processor.MediaLimitsHandler.MediaLimitsHandler.__isAllowedImage (   self,   imageLimits,   imageProperty  )

private

Definition at line 253 of file MediaLimitsHandler.py.

  def __isAllowedImage(self, imageLimits, imageProperty):
    # variable for result
    ret = True
    try:
      if isinstance(imageLimits, MediaLimitsHandler.ImageLimits) and \
      isinstance(imageProperty, MediaLimitsHandler.ImageProperty):

        if imageProperty.width is not None and imageLimits.maxWidth is not None and \
        int(imageProperty.width) > int(imageLimits.maxWidth):
          raise Exception("Parameter 'width' has not allowed value: %s > %s" % \
                          (str(imageProperty.width), str(imageLimits.maxWidth)))

        if imageProperty.width is not None and imageLimits.minWidth is not None and \
        int(imageProperty.width) < int(imageLimits.minWidth):
          raise Exception("Parameter 'width' has not allowed value: %s < %s" % \
                          (str(imageProperty.width), str(imageLimits.minWidth)))

        if imageProperty.height is not None and imageLimits.maxHeight is not None and \
        int(imageProperty.height) > int(imageLimits.maxHeight):
          raise Exception("Parameter 'height' has not allowed value: %s > %s" % \
                          (str(imageProperty.height), str(imageLimits.maxHeight)))

        if imageProperty.height is not None and imageLimits.minHeight is not None and \
        int(imageProperty.height) < int(imageLimits.minHeight):
          raise Exception("Parameter 'height' has not allowed value: %s < %s" % \
                          (str(imageProperty.height), str(imageLimits.minHeight)))

        if imageProperty.ratio is not None and imageLimits.maxRatio is not None and \
        float(imageProperty.ratio) > float(imageLimits.maxRatio):
          raise Exception("Parameter 'ratio' has not allowed value: %s > %s" % \
                          (str(imageProperty.ratio), str(imageLimits.maxRatio)))

        if imageProperty.ratio is not None and imageLimits.minRatio is not None and \
        float(imageProperty.ratio) < float(imageLimits.minRatio):
          raise Exception("Parameter 'ratio' has not allowed value: %s < %s" % \
                          (str(imageProperty.ratio), str(imageLimits.minRatio)))

        if imageProperty.colors is not None and imageLimits.minColors is not None and \
        int(imageProperty.colors) < int(imageLimits.minColors):
          raise Exception("Parameter 'colors' has not allowed value: %s < %s" % \
                          (str(imageProperty.colors), str(imageLimits.minColors)))

        if imageProperty.format is not None and imageLimits.contentType is not None and \
        isinstance(imageProperty.format, basestring) and isinstance(imageLimits.contentType, list):
          if not imageProperty.format.lower() in \
            [contentTypeName.lower() for contentTypeName in imageLimits.contentType]:
            raise Exception("Parameter 'format' = '%s' has not allowed value by '%s' =  %s" % \
                            (str(imageProperty.format),
                             str(MediaLimitsHandler.ImageLimits.propertyNamesDict['contentType']),
                             str(imageLimits.contentType)))

    except Exception, err:
      logger.debug("%s", str(err))
      ret = False

    return ret

Here is the caller graph for this function:

__loadImage()

def dc_processor.MediaLimitsHandler.MediaLimitsHandler.__loadImage (   self,   urlString,   binaryType = False  )

private

Definition at line 174 of file MediaLimitsHandler.py.

  def __loadImage(self, urlString, binaryType=False):
    # variable for result
    ret = None
    try:
      if binaryType:
        # extract binary image
        pos = urlString.find(self.BINARY_IMAGE_SEARCH_STR)
        if pos > -1:
          s = urlString[pos + len(self.BINARY_IMAGE_SEARCH_STR):]
          ret = base64.b64decode(s)
      else:
        # send get request
        res = requests.get(urlString)
        ret = res.content
    except Exception, err:
      logger.debug("Error: %s", str(err))

    return ret

Here is the caller graph for this function:

__loadProperty()

def dc_processor.MediaLimitsHandler.MediaLimitsHandler.__loadProperty (   self,   propertyString  )

private

Definition at line 116 of file MediaLimitsHandler.py.

  def __loadProperty(self, propertyString):
    # variable for result
    ret = None
    try:
      if propertyString is None or not isinstance(propertyString, basestring):
        raise Exception('Wrong type %s of property' % str(type(propertyString)))

      ret = json.loads(propertyString)
    except Exception, err:
      logger.error("Initialisation class '%s' was failed. Error: '%s'", self.__class__.__name__, str(err))

    return ret

__saveImageToFile()

def dc_processor.MediaLimitsHandler.MediaLimitsHandler.__saveImageToFile (   self,   content  )

private

Definition at line 149 of file MediaLimitsHandler.py.

  def __saveImageToFile(self, content):
    # variable for result
    ret = None
    try:
      if content is None:
        raise Exception("Image content wasn't get for save on disk.")

      # save to file
      tmpf = tempfile.NamedTemporaryFile(suffix=self.TEMP_FILE_SUFFIX, delete=False)
      tmpf.file.write(content)
      tmpf.close()
      logger.debug('Image saved to file: ' + tmpf.name)
      # save name
      ret = tmpf.name
    except Exception, err:
      logger.debug("Error: %s", str(err))

    return ret

Here is the caller graph for this function:

isAllowedLimits()

def dc_processor.MediaLimitsHandler.MediaLimitsHandler.isAllowedLimits	(		self,
			urlString,
			binaryType = False
	)

Definition at line 328 of file MediaLimitsHandler.py.

  def isAllowedLimits(self, urlString, binaryType=False):
    # variable for result
    ret = True

    if self.mediaLimits is not None:
      if isinstance(self.mediaLimits, MediaLimitsHandler.ImageLimits):
        # Get image property
        imageProperty = self.__getImageProperty(urlString, binaryType)
        if imageProperty is None:
          ret = False
        else:
          # Dump objects
          self.__dumpObj(self.mediaLimits)
          self.__dumpObj(imageProperty)

          # Check image limits
          ret = self.__isAllowedImage(self.mediaLimits, imageProperty)
      else:
        pass  # reserved for other types

    return ret

Member Data Documentation

BINARY_IMAGE_SEARCH_STR

string dc_processor.MediaLimitsHandler.MediaLimitsHandler.BINARY_IMAGE_SEARCH_STR = 'base64,'

static

Definition at line 29 of file MediaLimitsHandler.py.

MEDIA_LIMITS_TYPE_NAME [1/2]

string dc_processor.MediaLimitsHandler.MediaLimitsHandler.MEDIA_LIMITS_TYPE_NAME = 'img'

static

Definition at line 31 of file MediaLimitsHandler.py.

MEDIA_LIMITS_TYPE_NAME [2/2]

dc_processor.MediaLimitsHandler.MediaLimitsHandler.MEDIA_LIMITS_TYPE_NAME

Definition at line 96 of file MediaLimitsHandler.py.

mediaLimits

dc_processor.MediaLimitsHandler.MediaLimitsHandler.mediaLimits

Definition at line 80 of file MediaLimitsHandler.py.

TEMP_FILE_SUFFIX

string dc_processor.MediaLimitsHandler.MediaLimitsHandler.TEMP_FILE_SUFFIX = '.jpg'

static

Definition at line 28 of file MediaLimitsHandler.py.

---

The documentation for this class was generated from the following file:

• sources/hce/dc_processor/MediaLimitsHandler.py