empty{{ im }}
{% endthumbnail %} {% endspaceless %} sorl-thumbnail-11.12/tests/thumbnail_tests/templates/thumbnail7a.html 0000644 0001750 0001750 00000000252 11677073446 025150 0 ustar mikko mikko {% load thumbnail %}{% spaceless %} {% thumbnail item.image "100x100" quality=70 crop="center" upscale="True" as th %} {{ th.url }} {% endthumbnail %} {% endspaceless %} sorl-thumbnail-11.12/tests/thumbnail_tests/templates/thumbnaild3.html 0000644 0001750 0001750 00000000252 11677073446 025147 0 ustar mikko mikko {% load thumbnail %}{% spaceless %} {% thumbnail "" "x400" as im %}empty{{ im }}
{% endthumbnail %} {% endspaceless %} sorl-thumbnail-11.12/tests/thumbnail_tests/templates/thumbnail20.html 0000644 0001750 0001750 00000000223 11677073446 025060 0 ustar mikko mikko {% load thumbnail %} {% thumbnail image "32x32" crop="center" as im %}fail
{% endthumbnail %} sorl-thumbnail-11.12/tests/thumbnail_tests/templates/thumbnaild2.html 0000644 0001750 0001750 00000000340 11677073446 025144 0 ustar mikko mikko {% load thumbnail %}{% spaceless %} {% thumbnail anything "300" as im %}NOT
{% endif %} {% endspaceless %} sorl-thumbnail-11.12/tests/thumbnail_tests/kvstore.py 0000644 0001750 0001750 00000001574 11677073446 022130 0 ustar mikko mikko from sorl.thumbnail.kvstores.cached_db_kvstore import KVStore class KVlogHandler(object): _log = [] _active = False def start_log(self): self._active = True def stop_log(self): self._active = False log = self._log[:] self._log = [] return log def log(self, s): if self._active: self._log.append(s) kvlog = KVlogHandler() class TestKvStoreMixin(object): def get(self, *args, **kwargs): kvlog.log('get') return super(TestKvStoreMixin, self).get(*args, **kwargs) def set(self, *args, **kwargs): kvlog.log('set') return super(TestKvStoreMixin, self).set(*args, **kwargs) def delete(self, *args, **kwargs): kvlog.log('delete') return super(TestKvStoreMixin, self).delete(*args, **kwargs) class TestKVStore(TestKvStoreMixin, KVStore): pass sorl-thumbnail-11.12/tests/thumbnail_tests/tests.py 0000644 0001750 0001750 00000053634 11677073446 021601 0 ustar mikko mikko #coding=utf-8 import logging import operator import os import re import shutil from PIL import Image from django.core.files.storage import default_storage from django.template.loader import render_to_string from django.test.client import Client from django.utils import unittest from os.path import join as pjoin from sorl.thumbnail import default, get_thumbnail, delete from sorl.thumbnail.conf import settings from sorl.thumbnail.engines.pil_engine import Engine as PILEngine from sorl.thumbnail.helpers import get_module_class, ThumbnailError from sorl.thumbnail.images import ImageFile from sorl.thumbnail.log import ThumbnailLogHandler from sorl.thumbnail.parsers import parse_crop, parse_geometry from sorl.thumbnail.templatetags.thumbnail import margin from subprocess import Popen, PIPE from thumbnail_tests.models import Item from thumbnail_tests.storage import slog handler = ThumbnailLogHandler() handler.setLevel(logging.ERROR) logging.getLogger('sorl.thumbnail').addHandler(handler) class StorageTestCase(unittest.TestCase): def setUp(self): name = 'org.jpg' os.makedirs(settings.MEDIA_ROOT) fn = pjoin(settings.MEDIA_ROOT, name) Image.new('L', (100, 100)).save(fn) self.im = ImageFile(name) def test_a_new(self): slog.start_log() get_thumbnail(self.im, '50x50') log = slog.stop_log() actions = [ 'exists: test/cache/20/c7/20c7ceda51cd4d26f8f4f375cf9dddf3.jpg', # first see if the file exists 'open: org.jpg', # open the original for thumbnailing 'save: test/cache/20/c7/20c7ceda51cd4d26f8f4f375cf9dddf3.jpg', # save the file 'get_available_name: test/cache/20/c7/20c7ceda51cd4d26f8f4f375cf9dddf3.jpg', # cehck for filename 'exists: test/cache/20/c7/20c7ceda51cd4d26f8f4f375cf9dddf3.jpg', # called by get_available_name ] self.assertEqual(log, actions) def test_b_cached(self): slog.start_log() get_thumbnail(self.im, '50x50') log = slog.stop_log() self.assertEqual(log, []) # now this should all be in cache def test_c_safe_methods(self): slog.start_log() im = default.kvstore.get(self.im) im.url, im.x, im.y log = slog.stop_log() self.assertEqual(log, []) def tearDown(self): shutil.rmtree(settings.MEDIA_ROOT) class ParsersTestCase(unittest.TestCase): def testAliasCrop(self): crop = parse_crop('center', (500, 500), (400, 400)) self.assertEqual(crop, (50, 50)) crop = parse_crop('right', (500, 500), (400, 400)) self.assertEqual(crop, (100, 50)) def testPercentCrop(self): crop = parse_crop('50% 0%', (500, 500), (400, 400)) self.assertEqual(crop, (50, 0)) crop = parse_crop('10% 80%', (500, 500), (400, 400)) self.assertEqual(crop, (10, 80)) def testPxCrop(self): crop = parse_crop('200px 33px', (500, 500), (400, 400)) self.assertEqual(crop, (100, 33)) def testBadCrop(self): self.assertRaises(ThumbnailError, parse_crop, '-200px', (500, 500), (400, 400)) def testGeometry(self): g = parse_geometry('222x30') self.assertEqual(g, (222, 30)) g = parse_geometry('222') self.assertEqual(g, (222, None)) g = parse_geometry('x999') self.assertEqual(g, (None, 999)) class SimpleTestCaseBase(unittest.TestCase): def setUp(self): self.backend = get_module_class(settings.THUMBNAIL_BACKEND)() self.engine = get_module_class(settings.THUMBNAIL_ENGINE)() self.kvstore = get_module_class(settings.THUMBNAIL_KVSTORE)() if not os.path.exists(settings.MEDIA_ROOT): os.makedirs(settings.MEDIA_ROOT) dims = [ (500, 500), (100, 100), ] for dim in dims: name = '%sx%s.jpg' % dim fn = pjoin(settings.MEDIA_ROOT, name) im = Image.new('L', dim) im.save(fn) Item.objects.get_or_create(image=name) def tearDown(self): shutil.rmtree(settings.MEDIA_ROOT) class SimpleTestCase(SimpleTestCaseBase): def testSimple(self): item = Item.objects.get(image='500x500.jpg') t = self.backend.get_thumbnail(item.image, '400x300', crop='center') self.assertEqual(t.x, 400) self.assertEqual(t.y, 300) t = self.backend.get_thumbnail(item.image, '1200x900', crop='13% 89%') self.assertEqual(t.x, 1200) self.assertEqual(t.y, 900) def testUpscale(self): item = Item.objects.get(image='100x100.jpg') t = self.backend.get_thumbnail(item.image, '400x300', upscale=False) self.assertEqual(t.x, 100) self.assertEqual(t.y, 100) t = self.backend.get_thumbnail(item.image, '400x300', upscale=True) self.assertEqual(t.x, 300) self.assertEqual(t.y, 300) def testKVStore(self): im = ImageFile(Item.objects.get(image='500x500.jpg').image) self.kvstore.delete_thumbnails(im) th1 = self.backend.get_thumbnail(im, '50') th2 = self.backend.get_thumbnail(im, 'x50') th3 = self.backend.get_thumbnail(im, '20x20') self.assertEqual( set([th1.key, th2.key, th3.key]), set(self.kvstore._get(im.key, identity='thumbnails')) ) self.kvstore.delete_thumbnails(im) self.assertEqual( None, self.kvstore._get(im.key, identity='thumbnails') ) def testIsPortrait(self): im = ImageFile(Item.objects.get(image='500x500.jpg').image) th = self.backend.get_thumbnail(im, '50x200', crop='center') self.assertEqual(th.is_portrait(), True) th = self.backend.get_thumbnail(im, '500x2', crop='center') self.assertEqual(th.is_portrait(), False) def testMargin(self): im = ImageFile(Item.objects.get(image='500x500.jpg').image) self.assertEqual(margin(im, '1000x1000'), '250px 250px 250px 250px') self.assertEqual(margin(im, '800x1000'), '250px 150px 250px 150px') self.assertEqual(margin(im, '500x500'), '0px 0px 0px 0px') self.assertEqual(margin(im, '500x501'), '0px 0px 1px 0px') self.assertEqual(margin(im, '503x500'), '0px 2px 0px 1px') self.assertEqual(margin(im, '300x300'), '-100px -100px -100px -100px') def testKVStoreGetSet(self): im = ImageFile(Item.objects.get(image='500x500.jpg').image) self.kvstore.delete(im) self.assertEqual(self.kvstore.get(im), None) self.kvstore.set(im) self.assertEqual(im.size, [500, 500]) def test_cleanup1(self): im = ImageFile(Item.objects.get(image='500x500.jpg').image) self.kvstore.delete_thumbnails(im) th = self.backend.get_thumbnail(im, '3x3') self.assertEqual(th.exists(), True) th.delete() self.assertEqual(th.exists(), False) self.assertEqual(self.kvstore.get(th).x, 3) self.assertEqual(self.kvstore.get(th).y, 3) self.kvstore.cleanup() self.assertEqual(self.kvstore.get(th), None) self.kvstore.delete(im) def test_cleanup2(self): self.kvstore.clear() im = ImageFile(Item.objects.get(image='500x500.jpg').image) th3 = self.backend.get_thumbnail(im, '27x27') th4 = self.backend.get_thumbnail(im, '81x81') def keys_test(x, y, z): self.assertEqual(x, len(list(self.kvstore._find_keys(identity='image')))) self.assertEqual(y, len(list(self.kvstore._find_keys(identity='thumbnails')))) self.assertEqual(z, len(self.kvstore._get(im.key, identity='thumbnails') or [])) keys_test(3, 1, 2) th3.delete() keys_test(3, 1, 2) self.kvstore.cleanup() keys_test(2, 1, 1) th4.delete() keys_test(2, 1, 1) self.kvstore.cleanup() keys_test(1, 0, 0) self.kvstore.clear() keys_test(0, 0, 0) def test_storage_serialize(self): im = ImageFile(Item.objects.get(image='500x500.jpg').image) self.assertEqual(im.serialize_storage(), 'thumbnail_tests.storage.TestStorage') self.assertEqual( ImageFile('http://www.image.jpg').serialize_storage(), 'sorl.thumbnail.images.UrlStorage', ) self.assertEqual( ImageFile('http://www.image.jpg', default.storage).serialize_storage(), 'thumbnail_tests.storage.TestStorage', ) self.assertEqual( ImageFile('getit', default_storage).serialize_storage(), 'thumbnail_tests.storage.TestStorage', ) def test_quality(self): im = ImageFile(Item.objects.get(image='500x500.jpg').image) th = self.backend.get_thumbnail(im, '100x100', quality=50) p1 = Popen(['identify', '-verbose', th.storage.path(th.name)], stdout=PIPE) p2 = Popen(['grep', '-c', 'Quality: 50'], stdin=p1.stdout, stdout=PIPE) p1.stdout.close() output = p2.communicate()[0].strip() self.assertEqual(output, '1') def test_image_file_deserialize(self): im = ImageFile(Item.objects.get(image='500x500.jpg').image) default.kvstore.set(im) self.assertEqual( default.kvstore.get(im).serialize_storage(), 'thumbnail_tests.storage.TestStorage', ) im = ImageFile('http://www.aino.se/media/i/logo.png') default.kvstore.set(im) self.assertEqual( default.kvstore.get(im).serialize_storage(), 'sorl.thumbnail.images.UrlStorage', ) def test_abspath(self): item = Item.objects.get(image='500x500.jpg') image = ImageFile(item.image.path) val = render_to_string('thumbnail20.html', { 'image': image, }).strip() im = self.backend.get_thumbnail(image, '32x32', crop='center') self.assertEqual('
'
''))
def test_serialization_options(self):
item = Item.objects.get(image='500x500.jpg')
for j in xrange(0, 20):
# we could be lucky...
val0 = render_to_string('thumbnail7.html', {
'item': item,
}).strip()
val1 = render_to_string('thumbnail7a.html', {
'item': item,
}).strip()
self.assertEqual(val0, val1)
def test_options(self):
item = Item.objects.get(image='500x500.jpg')
options = {
'crop': "center",
'upscale': True,
'quality': 77,
}
val0 = render_to_string('thumbnail8.html', {
'item': item,
'options': options,
}).strip()
val1 = render_to_string('thumbnail8a.html', {
'item': item,
}).strip()
self.assertEqual(val0, val1)
def test_progressive(self):
im = Item.objects.get(image='500x500.jpg').image
th = self.backend.get_thumbnail(im, '100x100', progressive=True)
path = pjoin(settings.MEDIA_ROOT, th.name)
p = Popen(['identify', '-verbose', path], stdout=PIPE)
p.wait()
m = re.search('Interlace: JPEG', p.stdout.read())
self.assertEqual(bool(m), True)
def test_nonprogressive(self):
im = Item.objects.get(image='500x500.jpg').image
th = self.backend.get_thumbnail(im, '100x100', progressive=False)
path = pjoin(settings.MEDIA_ROOT, th.name)
p = Popen(['identify', '-verbose', path], stdout=PIPE)
p.wait()
m = re.search('Interlace: None', p.stdout.read())
self.assertEqual(bool(m), True)
def test_orientation(self):
data_dir = pjoin(settings.MEDIA_ROOT, 'data')
shutil.copytree(settings.DATA_ROOT, data_dir)
ref = Image.open(pjoin(data_dir, '1_topleft.jpg'))
top = ref.getpixel((14, 7))
left = ref.getpixel((7, 14))
engine = PILEngine()
def epsilon(x, y):
if isinstance(x, (tuple, list)):
x = sum(x) / len(x)
if isinstance(y, (tuple, list)):
y = sum(y) / len(y)
return abs(x - y)
for name in sorted(os.listdir(data_dir)):
th = self.backend.get_thumbnail('data/%s' % name, '30x30')
im = engine.get_image(th)
self.assertLess(epsilon(top, im.getpixel((14, 7))), 10)
self.assertLess(epsilon(left, im.getpixel((7, 14))), 10)
exif = im._getexif()
if exif:
self.assertEqual(exif.get(0x0112), 1)
class TemplateTestCaseB(unittest.TestCase):
def tearDown(self):
try:
shutil.rmtree(settings.MEDIA_ROOT)
except Exception:
pass
def testUrl(self):
val = render_to_string('thumbnail3.html', {}).strip()
self.assertEqual(val, '
')
def testEmpty(self):
val = render_to_string('thumbnail5.html', {}).strip()
self.assertEqual(val, 'empty
') class TemplateTestCaseClient(unittest.TestCase): def setUp(self): self.org_settings = {} params = { 'THUMBNAIL_DEBUG': False, } for k, v in params.iteritems(): self.org_settings[k] = getattr(settings, k) setattr(settings, k, v) def testEmptyError(self): client = Client() response = client.get('/thumbnail9.html') self.assertEqual(response.content.strip(), 'empty
') from django.core.mail import outbox self.assertEqual(outbox[0].subject, '[sorl-thumbnail] ERROR: /thumbnail9.html') end = outbox[0].body.split('\n\n')[-2][-20:-1] self.assertEqual(end, 'tests/media/invalid') def tearDown(self): for k, v in self.org_settings.iteritems(): setattr(settings, k, v) class CropTestCase(unittest.TestCase): def setUp(self): self.backend = get_module_class(settings.THUMBNAIL_BACKEND)() self.engine = get_module_class(settings.THUMBNAIL_ENGINE)() self.kvstore = get_module_class(settings.THUMBNAIL_KVSTORE)() if not os.path.exists(settings.MEDIA_ROOT): os.makedirs(settings.MEDIA_ROOT) # portrait name = 'portrait.jpg' fn = pjoin(settings.MEDIA_ROOT, name) im = Image.new('L', (100, 200)) im.paste(255, (0, 0, 100, 100)) im.save(fn) self.portrait = ImageFile(Item.objects.get_or_create(image=name)[0].image) self.kvstore.delete(self.portrait) # landscape name = 'landscape.jpg' fn = pjoin(settings.MEDIA_ROOT, name) im = Image.new('L', (200, 100)) im.paste(255, (0, 0, 100, 100)) im.save(fn) self.landscape = ImageFile(Item.objects.get_or_create(image=name)[0].image) self.kvstore.delete(self.landscape) def testPortraitCrop(self): def mean_pixel(x, y): values = im.getpixel((x, y)) if not isinstance(values, (tuple, list)): values = [values] return reduce(operator.add, values) / len(values) for crop in ('center', '88% 50%', '50px'): th = self.backend.get_thumbnail(self.portrait, '100x100', crop=crop) engine = PILEngine() im = engine.get_image(th) self.assertEqual(mean_pixel(50,0), 255) self.assertEqual(mean_pixel(50,45), 255) self.assertEqual(250 < mean_pixel(50,49) <= 255, True) self.assertEqual(mean_pixel(50,55), 0) self.assertEqual(mean_pixel(50,99), 0) for crop in ('top', '0%', '0px'): th = self.backend.get_thumbnail(self.portrait, '100x100', crop=crop) engine = PILEngine() im = engine.get_image(th) for x in xrange(0, 99, 10): for y in xrange(0, 99, 10): self.assertEqual(250 < mean_pixel(x, y) <= 255, True) for crop in ('bottom', '100%', '100px'): th = self.backend.get_thumbnail(self.portrait, '100x100', crop=crop) engine = PILEngine() im = engine.get_image(th) for x in xrange(0, 99, 10): for y in xrange(0, 99, 10): self.assertEqual(0 <= mean_pixel(x, y) < 5, True) def testLandscapeCrop(self): def mean_pixel(x, y): values = im.getpixel((x, y)) if not isinstance(values, (tuple, list)): values = [values] return reduce(operator.add, values) / len(values) for crop in ('center', '50% 200%', '50px 700px'): th = self.backend.get_thumbnail(self.landscape, '100x100', crop=crop) engine = PILEngine() im = engine.get_image(th) self.assertEqual(mean_pixel(0, 50), 255) self.assertEqual(mean_pixel(45, 50), 255) self.assertEqual(250 < mean_pixel(49, 50) <= 255, True) self.assertEqual(mean_pixel(55, 50), 0) self.assertEqual(mean_pixel(99, 50), 0) for crop in ('left', '0%', '0px'): th = self.backend.get_thumbnail(self.landscape, '100x100', crop=crop) engine = PILEngine() im = engine.get_image(th) for x in xrange(0, 99, 10): for y in xrange(0, 99, 10): self.assertEqual(250 < mean_pixel(x, y) <= 255, True) for crop in ('right', '100%', '100px'): th = self.backend.get_thumbnail(self.landscape, '100x100', crop=crop) engine = PILEngine() im = engine.get_image(th) for x in xrange(0, 99, 10): for y in xrange(0, 99, 10): self.assertEqual(0 <= mean_pixel(x, y) < 5, True) def tearDown(self): shutil.rmtree(settings.MEDIA_ROOT) class DummyTestCase(unittest.TestCase): def setUp(self): self.backend = get_module_class(settings.THUMBNAIL_BACKEND)() self.org_settings = {} params = { 'THUMBNAIL_DUMMY': True, } for k, v in params.iteritems(): self.org_settings[k] = getattr(settings, k) setattr(settings, k, v) def test_dummy_tags(self): val = render_to_string('thumbnaild1.html', { 'anything': 'AINO', }).strip() self.assertEqual(val, 'NOT
') val = render_to_string('thumbnaild3.html', { }).strip() self.assertEqual(val, 'No image
{% endthumbnail %} Nesting tags and setting size (geometry) for width only:: {% thumbnail item.image "1000" as big %} {% thumbnail item.image "50x50" crop="center" as small %}
{% thumbnail item.image "100" crop="10px 10px" format="PNG" as im %}
{% endthumbnail %}
{% else %}
{% thumbnail item.image "50" crop="bottom" format="PNG" as im %}
{% endthumbnail %}
Undefined behaviour
{% thumbnail profile.photo "100x100" as im %}
{% empty %}
{% endthumbnail %}
{% enfor %}
The more problematic is to get the top margin, however the margin filter
outputs all values.
.. _css background-position: http://www.w3.org/TR/CSS2/colors.html#propdef-background-position
sorl-thumbnail-11.12/docs/operation.rst 0000644 0001750 0001750 00000006173 11635604732 017164 0 ustar mikko mikko ***************************
How sorl-thumbnail operates
***************************
.. highlight:: python
When you use the ``thumbnail`` template tag sorl-thumbnail looks up the
thumbnail in a :ref:`kvstore-requirements`. The key for a thumbnail is
generated from its filename and storage. The thumbnail filename in turn is
generated from the source and requested thumbnail size and options. If the key
for the thumbnail is found in the |kvstore|, the serialized thumbnail
information is fetched from it and returned. If the thumbnail key is not found
there sorl-thumbnail continues to generate the thumbnail and stores necessary
information in the |kvstore|. It is worth noting that sorl-thumbnail does not
check if source or thumbnail exists if the thumbnail key is found in the
|kvstore|.
.. note:: This means that if you change or delete a source file or delete the
thumbnail, sorl-thumbnail will still fetch from the |kvstore|.
Therefore it is important that if you delete or change a source or
thumbnail file notify the |kvstore|.
If you change or delete a source or a thumbnail for some reason, you can use
the ``delete`` method of the ``ThumbnailBackend`` class or subclass::
from sorl.thumbnail import delete
# Delete the Key Value Store reference but **not** the file.
# Use this if you have changed the source
delete(my_file, delete_file=False)
# Delete the Key Value Store reference and the file
# Use this if you want to delete the source file
delete(my_file) # delete_file=True is default
The ``sorl.thumbnail.delete`` method always deletes the input files thumbnail
Key Value Store references as well as thumbnail files. You can use this method
on thumbnails as well as source files. Alternatively if you have **deleted** a
file you can use the management command :ref:`thumbnail-cleanup`. Deleting an
image using the ``sorl.thumbnail.ImageField`` will notify the |kvstore| to
delete references to it and delete all of its thumbnail references and files,
exactly like the above code example.
**Why you ask?** Why go through all the trouble with a |kvstore| and risk
stale cache? Why not use a database to cache if you are going to do that?
The reason is speed and especially with storages other than local file storage.
Checking if a file exists before serving it will cost too much. Speed is also
the reason for not choosing to use a standard database for this kind of
persistent caching. However sorl-thumbnail does ship with a *cached* database
|kvstore|.
.. note:: We have to assume the thumbnail exists if the thumbnail key exists in
the |kvstore|
**There are bonuses**. We can store meta data in the |kvstore| that would be
too costly to retrieve even for local file storage. Today this meta data
consists only of the image size but this could be expanded to for example EXIF
data. The other bonus is that we can keep track of what thumbnails has been
generated from a particular source and deleting them too when the source is
deleted.
`Schematic view of how things are done
{% endthumbnail %}
'
u''
u'
%s
'
) % (mini.width, value.url, mini.url, output)
return mark_safe(output)
class AdminClearWidget(forms.CheckboxInput):
def render(self, name, value, attrs=None):
output = super(AdminClearWidget, self).render(name, value, attrs)
output = (
u''
u'%s'
u'
'
) % (name, _('Clear image'), output)
return mark_safe(output)
class AdminClearableImageWidget(forms.MultiWidget):
def __init__(self, attrs=None):
widgets = (AdminImageWidget(attrs=attrs), AdminClearWidget())
super(AdminClearableImageWidget, self).__init__(widgets, attrs)
def decompress(self, value):
if value:
return (value, False)
return (None, None)
class AdminImageMixin(object):
"""
This is a mix-in for ModelAdmin subclasses to make ``ImageField`` show nicer
form class and widget
"""
def formfield_for_dbfield(self, db_field, **kwargs):
if isinstance(db_field, ImageField):
if not db_field.blank:
return db_field.formfield(widget=AdminImageWidget)
return db_field.formfield(
form_class=ClearableImageFormField,
widget=AdminClearableImageWidget,
)
sup = super(AdminImageMixin, self)
return sup.formfield_for_dbfield(db_field, **kwargs)
sorl-thumbnail-11.12/sorl/thumbnail/admin/current.py 0000644 0001750 0001750 00000003201 11635604732 021555 0 ustar mikko mikko from django import forms
from django.utils.safestring import mark_safe
from sorl.thumbnail.fields import ImageField
from sorl.thumbnail.shortcuts import get_thumbnail
class AdminImageWidget(forms.ClearableFileInput):
"""
An ImageField Widget for django.contrib.admin that shows a thumbnailed
image as well as a link to the current one if it hase one.
"""
template_with_initial = u'%(clear_template)s%(input_text)s: %(input)s' template_with_clear = u'%(clear)s ' def render(self, name, value, attrs=None): output = super(AdminImageWidget, self).render(name, value, attrs) if value and hasattr(value, 'url'): try: mini = get_thumbnail(value, 'x80', upscale=False) except Exception: pass else: output = ( u'
'
u''
u'%s
'
) % (mini.width, value.url, mini.url, output)
return mark_safe(output)
class AdminImageMixin(object):
"""
This is a mix-in for InlineModelAdmin subclasses to make ``ImageField``
show nicer form widget
"""
def formfield_for_dbfield(self, db_field, **kwargs):
if isinstance(db_field, ImageField):
return db_field.formfield(widget=AdminImageWidget)
sup = super(AdminImageMixin, self)
return sup.formfield_for_dbfield(db_field, **kwargs)
sorl-thumbnail-11.12/sorl/thumbnail/base.py 0000644 0001750 0001750 00000007702 11666137404 017730 0 ustar mikko mikko from sorl.thumbnail.conf import settings, defaults as default_settings
from sorl.thumbnail.helpers import tokey, serialize
from sorl.thumbnail.images import ImageFile
from sorl.thumbnail import default
from sorl.thumbnail.parsers import parse_geometry
EXTENSIONS = {
'JPEG': 'jpg',
'PNG': 'png',
}
class ThumbnailBackend(object):
"""
The main class for sorl-thumbnail, you can subclass this if you for example
want to change the way destination filename is generated.
"""
default_options = {
'format': settings.THUMBNAIL_FORMAT,
'quality': settings.THUMBNAIL_QUALITY,
'colorspace': settings.THUMBNAIL_COLORSPACE,
'upscale': settings.THUMBNAIL_UPSCALE,
'crop': False,
}
extra_options = (
('progressive', 'THUMBNAIL_PROGRESSIVE'),
('orientation', 'THUMBNAIL_ORIENTATION'),
)
def get_thumbnail(self, file_, geometry_string, **options):
"""
Returns thumbnail as an ImageFile instance for file with geometry and
options given. First it will try to get it from the key value store,
secondly it will create it.
"""
source = ImageFile(file_)
for key, value in self.default_options.iteritems():
options.setdefault(key, value)
# For the future I think it is better to add options only if they
# differ from the default settings as below. This will ensure the same
# filenames beeing generated for new options at default.
for key, attr in self.extra_options:
value = getattr(settings, attr)
if value != getattr(default_settings, attr):
options.setdefault(key, value)
name = self._get_thumbnail_filename(source, geometry_string, options)
thumbnail = ImageFile(name, default.storage)
cached = default.kvstore.get(thumbnail)
if cached:
return cached
if not thumbnail.exists():
# We have to check exists() because the Storage backend does not
# overwrite in some implementations.
source_image = default.engine.get_image(source)
# We might as well set the size since we have the image in memory
size = default.engine.get_image_size(source_image)
source.set_size(size)
self._create_thumbnail(source_image, geometry_string, options,
thumbnail)
# If the thumbnail exists we don't create it, the other option is
# to delete and write but this could lead to race conditions so I
# will just leave that out for now.
default.kvstore.get_or_set(source)
default.kvstore.set(thumbnail, source)
return thumbnail
def delete(self, file_, delete_file=True):
"""
Deletes file_ references in Key Value store and optionally the file_
it self.
"""
image_file = ImageFile(file_)
if delete_file:
image_file.delete()
default.kvstore.delete(image_file)
def _create_thumbnail(self, source_image, geometry_string, options,
thumbnail):
"""
Creates the thumbnail by using default.engine
"""
ratio = default.engine.get_image_ratio(source_image)
geometry = parse_geometry(geometry_string, ratio)
image = default.engine.create(source_image, geometry, options)
default.engine.write(image, options, thumbnail)
# It's much cheaper to set the size here
size = default.engine.get_image_size(image)
thumbnail.set_size(size)
def _get_thumbnail_filename(self, source, geometry_string, options):
"""
Computes the destination filename.
"""
key = tokey(source.key, geometry_string, serialize(options))
# make some subdirs
path = '%s/%s/%s' % (key[:2], key[2:4], key)
return '%s%s.%s' % (settings.THUMBNAIL_PREFIX, path,
EXTENSIONS[options['format']])
sorl-thumbnail-11.12/sorl/thumbnail/conf/ 0000755 0001750 0001750 00000000000 11677075433 017370 5 ustar mikko mikko sorl-thumbnail-11.12/sorl/thumbnail/conf/__init__.py 0000644 0001750 0001750 00000000731 11666137404 021475 0 ustar mikko mikko from django.conf import settings as user_settings
from django.utils.functional import LazyObject
from sorl.thumbnail.conf import defaults
class Settings(object):
pass
class LazySettings(LazyObject):
def _setup(self):
self._wrapped = Settings()
for obj in (defaults, user_settings):
for attr in dir(obj):
if attr == attr.upper():
setattr(self, attr, getattr(obj, attr))
settings = LazySettings()
sorl-thumbnail-11.12/sorl/thumbnail/conf/defaults.py 0000644 0001750 0001750 00000005115 11666137507 021552 0 ustar mikko mikko from django.conf import settings
# When True ThumbnailNode.render can raise errors
THUMBNAIL_DEBUG = False
# Backend
THUMBNAIL_BACKEND = 'sorl.thumbnail.base.ThumbnailBackend'
# Key-value store, ships with:
# sorl.thumbnail.kvstores.cached_db_kvstore.KVStore
# sorl.thumbnail.kvstores.redis_kvstore.KVStore
# Redis requires some more work, see docs
THUMBNAIL_KVSTORE = 'sorl.thumbnail.kvstores.cached_db_kvstore.KVStore'
# Change this to something else for MSSQL
THUMBNAIL_KEY_DBCOLUMN = 'key'
# Engine, ships with:
# sorl.thumbnail.engines.convert_engine.Engine
# sorl.thumbnail.engines.pil_engine.Engine
# sorl.thumbnail.engines.pgmagick_engine.Engine
# convert is preferred but requires imagemagick or graphicsmagick, se docs
THUMBNAIL_ENGINE = 'sorl.thumbnail.engines.pil_engine.Engine'
# Path to Imagemagick or Graphicsmagick ``convert`` and ``identify``.
THUMBNAIL_CONVERT = 'convert'
THUMBNAIL_IDENTIFY = 'identify'
# Storage for the generated thumbnails
THUMBNAIL_STORAGE = settings.DEFAULT_FILE_STORAGE
# Redis settings
THUMBNAIL_REDIS_DB = 0
THUMBNAIL_REDIS_PASSWORD = ''
THUMBNAIL_REDIS_HOST = 'localhost'
THUMBNAIL_REDIS_PORT = 6379
THUMBNAIL_REDIS_UNIX_SOCKET_PATH = None
# Cache timeout for ``cached_db`` store. You should probably keep this at
# maximum or ``0`` if your caching backend can handle that as infinate.
THUMBNAIL_CACHE_TIMEOUT = 3600 * 24 * 365 * 10 # 10 years
# Key prefix used by the key value store
THUMBNAIL_KEY_PREFIX = 'sorl-thumbnail'
# Thumbnail filename prefix
THUMBNAIL_PREFIX = 'cache/'
# Image format, common formats are: JPEG, PNG
# Make sure the backend can handle the format you specify
THUMBNAIL_FORMAT = 'JPEG'
# Colorspace, backends are required to implement: RGB, GRAY
# Setting this to None will keep the original colorspace.
THUMBNAIL_COLORSPACE = 'RGB'
# Should we upscale images by default
THUMBNAIL_UPSCALE = True
# Quality, 0-100
THUMBNAIL_QUALITY = 95
# Save as progressive when saving as jpeg
THUMBNAIL_PROGRESSIVE = True
# Orientate the thumbnail with respect to source EXIF orientation tag
THUMBNAIL_ORIENTATION = True
# This means sorl.thumbnail will generate and serve a generated dummy image
# regardless of the thumbnail source content
THUMBNAIL_DUMMY = False
# Thumbnail dummy (placeholder) source. Some you might try are:
# http://placekitten.com/%(width)s/%(height)s
# http://placekitten.com/g/%(width)s/%(height)s
# http://placehold.it/%(width)sx%(height)s
THUMBNAIL_DUMMY_SOURCE = 'http://dummyimage.com/%(width)sx%(height)s'
# Sets the source image ratio for dummy generation of images with only width
# or height given
THUMBNAIL_DUMMY_RATIO = 1.5
sorl-thumbnail-11.12/sorl/thumbnail/templatetags/ 0000755 0001750 0001750 00000000000 11677075433 021135 5 ustar mikko mikko sorl-thumbnail-11.12/sorl/thumbnail/templatetags/__init__.py 0000644 0001750 0001750 00000000000 11467213637 023231 0 ustar mikko mikko sorl-thumbnail-11.12/sorl/thumbnail/templatetags/thumbnail.py 0000644 0001750 0001750 00000011451 11476142267 023471 0 ustar mikko mikko import logging
import re
import sys
from django.template import Library, Node, NodeList, TemplateSyntaxError
from django.utils.encoding import smart_str
from functools import wraps
from sorl.thumbnail.conf import settings
from sorl.thumbnail.images import ImageFile, DummyImageFile
from sorl.thumbnail import default
from sorl.thumbnail.parsers import parse_geometry
register = Library()
kw_pat = re.compile(r'^(?P