terom@57: """
terom@57:     Per-image gallery state
terom@57: """
terom@57: 
terom@57: from __future__ import with_statement
terom@57: 
terom@85: import filesystem, format, thumbnail
terom@76: from utils import lazy_load
terom@12: 
terom@12: import PIL.Image
terom@57: from lib import EXIF
terom@33: 
terom@57: class Image (filesystem.File) :
terom@57:     """
terom@57:         An Image is a filesystem File that represents an image that can be thumbnailed, and handled.
terom@57:     """
terom@44: 
terom@76:     def __init__ (self, *args, **kwargs) :
terom@57:         """
terom@57:             Initialize as an Image based on the given Node, linked with the given previous node
terom@57:         """
terom@57: 
terom@77:         super(Image, self).__init__(*args, **kwargs)
terom@57: 
terom@57:         # links
terom@76:         self.prev = None
terom@57:         self.next = None
terom@57: 
terom@57:         # the .html file for this image
terom@57:         self.html = self.parent.subfile(self.basename + '.html')
terom@57: 
terom@85:         # our preview/thumbnail
terom@85:         self.preview = thumbnail.Thumbnail(self, self.parent.preview_dir, self.config.preview_size)
terom@85:         self.thumb = thumbnail.Thumbnail(self, self.parent.thumb_dir, self.config.thumb_size)
terom@85: 
terom@57:         # info
terom@57:         self.title = self.name
terom@57:         self.description = None
terom@57: 
terom@77:     @lazy_load
terom@85:     def pil_image (self) :
terom@57:         """
terom@57:             Loads the image as a PIL.Image
terom@57:         """
terom@57:         
terom@77:         # open it up
terom@77:         return PIL.Image.open(self.path)
terom@57: 
terom@77:     @lazy_load
terom@77:     def exif (self) :
terom@57:         """
terom@57:             Loads the EXIF data for the image and returns as a dict of EXIF tag names -> values.
terom@57: 
terom@57:             Returns None if no exif data was found
terom@57:         """
terom@57: 
terom@77:         # load
terom@77:         with self.open('rb') as fh :
terom@77:             # XXX: details=False?
terom@77:             exif = EXIF.process_file(fh)
terom@57:             
terom@57:         # empty dict -> no exif data
terom@77:         if exif :
terom@77:             return exif
terom@57: 
terom@57:         else :
terom@57:             return None
terom@77:     
terom@77:     @lazy_load
terom@77:     def metadata (self) :
terom@57:         """
terom@57:             Load and return the metadata for the image as a dictionary
terom@57:         """
terom@57: 
terom@77:         # load stuff
terom@85:         stat = self.stat()
terom@77:         exif = self.exif
terom@57: 
terom@77:         # XXX: avoid having to open the image?
terom@85:         size = self.pil_image.size
terom@77:         
terom@77:         # build
terom@77:         return dict({
terom@77:             "File name":        self.name,
terom@77:             "Resolution":       "%dx%d" % size,
terom@77:             "File size":        format.filesize(stat.st_size),
terom@77:             "Last modified":    format.filetime(stat.st_mtime),
terom@77:         }, **dict(
terom@77:             (name, exif[tag]) for tag, name in self.config.exif_tags if exif and tag in exif
terom@77:         ))
terom@57:     
terom@85:     def stale (self) :
terom@57:         """
terom@85:             Tests if this Image is stale, based on preview/thumb.
terom@57:         """
terom@57: 
terom@85:         return self.preview.stale() or self.thumb.stale()
terom@70:     
terom@85:     def update (self) :
terom@70:         """
terom@85:             Updates this Image's thumb/preview
terom@70:         """
terom@85:         
terom@91:         self.preview.update()
terom@91:         self.thumb.update()
terom@57: