From 6da47ccecd624b6fcb630bb864f30fd917862d0a Mon Sep 17 00:00:00 2001 From: Zbigniew Jasek Date: Thu, 1 Jan 2015 15:59:39 -0600 Subject: [PATCH] Added support for multiple gallery templates and the ability to select a template via user interface. --- README.rst | 18 +++ cmsplugin_filery/cms_plugins.py | 31 +++- .../0002_auto__add_field_filery_template.py | 140 ++++++++++++++++++ cmsplugin_filery/models.py | 11 +- 4 files changed, 197 insertions(+), 3 deletions(-) create mode 100644 cmsplugin_filery/migrations/0002_auto__add_field_filery_template.py diff --git a/README.rst b/README.rst index 6665dea..2dc15a2 100644 --- a/README.rst +++ b/README.rst @@ -39,6 +39,24 @@ like when you overide admin templates. templates/cmsplugin_filery/gallery.html +Additionally, you can add your templates to ``templates/cmsplugin_filery/`` and register them in ``settings.py``. +This will make the templates available for selection in the user interface. + +:: + + # In the templates directory + templates/cmsplugin_filery/gallery_1.html + templates/cmsplugin_filery/gallery_2.html + +:: + + # In settings.py + CMSPLUGIN_FILERY_TEMPLATES = ( + ('gallery_1.html', 'My First Gallery'), + ('gallery_2.html', 'My Second Gallery'), + ) + + Bugs & Contribution =================== diff --git a/cmsplugin_filery/cms_plugins.py b/cmsplugin_filery/cms_plugins.py index 2d361bd..4f480b6 100644 --- a/cmsplugin_filery/cms_plugins.py +++ b/cmsplugin_filery/cms_plugins.py @@ -3,7 +3,9 @@ from django.utils.translation import ugettext_lazy as _ from cmsplugin_filery.models import Filery from cmsplugin_filery.admin import ImageInline - +from django.template import loader +from django.conf import settings +from django import forms class FileryCMSPlugin(CMSPluginBase): model = Filery @@ -11,11 +13,38 @@ class FileryCMSPlugin(CMSPluginBase): name = _('Image gallery') render_template = 'cmsplugin_filery/gallery.html' raw_id_fields = ('image',) + + fields = ['title', 'template' ] def render(self, context, instance, placeholder): context['images'] = instance.image_set.all() context['gallery'] = instance + + try: + loader.get_template('cmsplugin_filery/' + instance.template) + self.render_template = 'cmsplugin_filery/' + instance.template + except: + pass # don't worry about it; default remdner_template will be used + return context + def get_form(self, request, obj=None, **kwargs): + form = super(FileryCMSPlugin, self).get_form(request, obj, **kwargs) + form.base_fields['template'] = forms.ChoiceField( + choices=self._get_available_templates(), + required=False + ) + + return form + + def _get_available_templates(self): + choices = (('default', _('Default')),) + try: + choices += settings.CMSPLUGIN_FILERY_TEMPLATES + except: + pass + + return choices + plugin_pool.register_plugin(FileryCMSPlugin) diff --git a/cmsplugin_filery/migrations/0002_auto__add_field_filery_template.py b/cmsplugin_filery/migrations/0002_auto__add_field_filery_template.py new file mode 100644 index 0000000..e535c18 --- /dev/null +++ b/cmsplugin_filery/migrations/0002_auto__add_field_filery_template.py @@ -0,0 +1,140 @@ +# -*- coding: utf-8 -*- +from south.utils import datetime_utils as datetime +from south.db import db +from south.v2 import SchemaMigration +from django.db import models + + +class Migration(SchemaMigration): + + def forwards(self, orm): + # Adding field 'Filery.template' + db.add_column(u'cmsplugin_filery', 'template', + self.gf('django.db.models.fields.CharField')(default='', max_length=255, blank=True), + keep_default=False) + + + def backwards(self, orm): + # Deleting field 'Filery.template' + db.delete_column(u'cmsplugin_filery', 'template') + + + models = { + u'auth.group': { + 'Meta': {'object_name': 'Group'}, + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}), + 'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': u"orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}) + }, + u'auth.permission': { + 'Meta': {'ordering': "(u'content_type__app_label', u'content_type__model', u'codename')", 'unique_together': "((u'content_type', u'codename'),)", 'object_name': 'Permission'}, + 'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}), + 'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['contenttypes.ContentType']"}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'max_length': '50'}) + }, + u'auth.user': { + 'Meta': {'object_name': 'User'}, + 'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}), + 'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}), + 'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}), + 'groups': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "u'user_set'", 'blank': 'True', 'to': u"orm['auth.Group']"}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}), + 'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}), + 'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}), + 'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'symmetrical': 'False', 'related_name': "u'user_set'", 'blank': 'True', 'to': u"orm['auth.Permission']"}), + 'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'}) + }, + 'cms.cmsplugin': { + 'Meta': {'object_name': 'CMSPlugin'}, + 'changed_date': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'blank': 'True'}), + 'creation_date': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'language': ('django.db.models.fields.CharField', [], {'max_length': '15', 'db_index': 'True'}), + 'level': ('django.db.models.fields.PositiveIntegerField', [], {'db_index': 'True'}), + 'lft': ('django.db.models.fields.PositiveIntegerField', [], {'db_index': 'True'}), + 'parent': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['cms.CMSPlugin']", 'null': 'True', 'blank': 'True'}), + 'placeholder': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['cms.Placeholder']", 'null': 'True'}), + 'plugin_type': ('django.db.models.fields.CharField', [], {'max_length': '50', 'db_index': 'True'}), + 'position': ('django.db.models.fields.PositiveSmallIntegerField', [], {'null': 'True', 'blank': 'True'}), + 'rght': ('django.db.models.fields.PositiveIntegerField', [], {'db_index': 'True'}), + 'tree_id': ('django.db.models.fields.PositiveIntegerField', [], {'db_index': 'True'}) + }, + 'cms.placeholder': { + 'Meta': {'object_name': 'Placeholder'}, + 'default_width': ('django.db.models.fields.PositiveSmallIntegerField', [], {'null': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'slot': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'}) + }, + u'cmsplugin_filery.filery': { + 'Meta': {'object_name': 'Filery', '_ormbases': ['cms.CMSPlugin']}, + u'cmsplugin_ptr': ('django.db.models.fields.related.OneToOneField', [], {'to': "orm['cms.CMSPlugin']", 'unique': 'True', 'primary_key': 'True'}), + 'template': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'}), + 'title': ('django.db.models.fields.CharField', [], {'max_length': '50', 'blank': 'True'}) + }, + u'cmsplugin_filery.image': { + 'Meta': {'ordering': "('order',)", 'object_name': 'Image'}, + 'active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'gallery': ('django.db.models.fields.related.ForeignKey', [], {'to': u"orm['cmsplugin_filery.Filery']"}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'image': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['filer.Image']", 'null': 'True', 'blank': 'True'}), + 'order': ('django.db.models.fields.IntegerField', [], {'null': 'True', 'blank': 'True'}) + }, + u'contenttypes.contenttype': { + 'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"}, + 'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}), + 'name': ('django.db.models.fields.CharField', [], {'max_length': '100'}) + }, + u'filer.file': { + 'Meta': {'object_name': 'File'}, + '_file_size': ('django.db.models.fields.IntegerField', [], {'null': 'True', 'blank': 'True'}), + 'description': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}), + 'file': ('django.db.models.fields.files.FileField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}), + 'folder': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "u'all_files'", 'null': 'True', 'to': u"orm['filer.Folder']"}), + 'has_all_mandatory_data': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + 'is_public': ('django.db.models.fields.BooleanField', [], {'default': 'True'}), + 'modified_at': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'blank': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'default': "u''", 'max_length': '255', 'blank': 'True'}), + 'original_filename': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}), + 'owner': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "u'owned_files'", 'null': 'True', 'to': u"orm['auth.User']"}), + 'polymorphic_ctype': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "u'polymorphic_filer.file_set'", 'null': 'True', 'to': u"orm['contenttypes.ContentType']"}), + 'sha1': ('django.db.models.fields.CharField', [], {'default': "u''", 'max_length': '40', 'blank': 'True'}), + 'uploaded_at': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}) + }, + u'filer.folder': { + 'Meta': {'ordering': "(u'name',)", 'unique_together': "((u'parent', u'name'),)", 'object_name': 'Folder'}, + 'created_at': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}), + u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}), + u'level': ('django.db.models.fields.PositiveIntegerField', [], {'db_index': 'True'}), + u'lft': ('django.db.models.fields.PositiveIntegerField', [], {'db_index': 'True'}), + 'modified_at': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'blank': 'True'}), + 'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}), + 'owner': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "u'filer_owned_folders'", 'null': 'True', 'to': u"orm['auth.User']"}), + 'parent': ('django.db.models.fields.related.ForeignKey', [], {'blank': 'True', 'related_name': "u'children'", 'null': 'True', 'to': u"orm['filer.Folder']"}), + u'rght': ('django.db.models.fields.PositiveIntegerField', [], {'db_index': 'True'}), + u'tree_id': ('django.db.models.fields.PositiveIntegerField', [], {'db_index': 'True'}), + 'uploaded_at': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}) + }, + 'filer.image': { + 'Meta': {'object_name': 'Image'}, + '_height': ('django.db.models.fields.IntegerField', [], {'null': 'True', 'blank': 'True'}), + '_width': ('django.db.models.fields.IntegerField', [], {'null': 'True', 'blank': 'True'}), + 'author': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}), + 'date_taken': ('django.db.models.fields.DateTimeField', [], {'null': 'True', 'blank': 'True'}), + 'default_alt_text': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}), + 'default_caption': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}), + u'file_ptr': ('django.db.models.fields.related.OneToOneField', [], {'to': u"orm['filer.File']", 'unique': 'True', 'primary_key': 'True'}), + 'must_always_publish_author_credit': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'must_always_publish_copyright': ('django.db.models.fields.BooleanField', [], {'default': 'False'}), + 'subject_location': ('django.db.models.fields.CharField', [], {'default': 'None', 'max_length': '64', 'null': 'True', 'blank': 'True'}) + } + } + + complete_apps = ['cmsplugin_filery'] \ No newline at end of file diff --git a/cmsplugin_filery/models.py b/cmsplugin_filery/models.py index d5a1337..eb9004e 100644 --- a/cmsplugin_filery/models.py +++ b/cmsplugin_filery/models.py @@ -22,6 +22,13 @@ class Filery(CMSPlugin): 'the gallery header (optional)') ) + template = models.CharField( + _('template'), + max_length=255, + blank=True, + help_text=_('The gallery template, ') + ) + def __unicode__(self): return _(u'%(count)d image(s) in gallery') % {'count': self.image_set.count()} @@ -39,8 +46,8 @@ def copy_relations(self, oldinstance): """ for img in oldinstance.image_set.all(): new_img = Image() - new_img.gallery = self - new_img.image = img.image + new_img.gallery = self + new_img.image = img.image new_img.save() class Meta: