Renames File.file -> File.source to prevent issues in Django 1.9

Author: mkoistinen

djangocms_file/cms_plugins.py

@@ -15,7 +15,7 @@ class FilePlugin(CMSPluginBase):
 
     fieldsets = [
         (None, {
-            'fields': ('title', 'file', 'tooltip', 'target', )
+            'fields': ('title', 'source', 'tooltip', 'target', )
         })
     ]
 
@@ -30,6 +30,7 @@ def icon_src(self, instance):
         file_icon = instance.get_icon_url()
         if file_icon:
             return file_icon
+        return settings.STATIC_URL + u"cms/img/icons/plugins/source.png"
         return settings.STATIC_URL + u"cms/img/icons/plugins/file.png"
 
 plugin_pool.register_plugin(FilePlugin)

djangocms_file/migrations/0003_rename_file_field_20160115_1904.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.9.1 on 2016-01-16 00:04
+from __future__ import unicode_literals
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('djangocms_file', '0002_auto_20151202_1551'),
+    ]
+
+    operations = [
+        migrations.RenameField('file', 'file', 'source')
+    ]

djangocms_file/models.py

@@ -39,7 +39,7 @@ class File(CMSPlugin):
     The icon search is currently performed within get_icon_url; this is
     probably a performance concern.
     """
-    file = models.FileField(_("file"), upload_to=get_plugin_media_path)
+    source = models.FileField(_("source"), upload_to=get_plugin_media_path)
     title = models.CharField(
         _("title"), max_length=255, null=True, blank=True,
         help_text=_("Optional title to display. If not supplied, the filename "
@@ -70,9 +70,9 @@ class File(CMSPlugin):
     def __str__(self):
         if self.title:
             return self.title
-        elif self.file:
+        elif self.source:
             # added if, because it raised attribute error when
-            # file wasn't defined
+            # source wasn't defined
             return self.get_file_name()
         return "<empty>"
 
@@ -85,10 +85,10 @@ def get_icon_url(self):
         return None
 
     def file_exists(self):
-        return default_storage.exists(self.file.name)
+        return default_storage.exists(self.source.name)
 
     def get_file_name(self):
-        return os.path.basename(self.file.name)
+        return os.path.basename(self.source.name)
 
     def get_ext(self):
         return os.path.splitext(self.get_file_name())[1][1:].lower()

djangocms_file/south_migrations/0004_rename_file_field.py

@@ -0,0 +1,49 @@
+# -*- 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):
+        db.rename_column(u'djangocms_file_file', 'file', 'source')
+
+
+    def backwards(self, orm):
+        db.rename_column(u'djangocms_file_file', 'source', 'file')
+
+
+    models = {
+        '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'}),
+            'depth': ('django.db.models.fields.PositiveIntegerField', [], {}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'language': ('django.db.models.fields.CharField', [], {'max_length': '15', 'db_index': 'True'}),
+            'numchild': ('django.db.models.fields.PositiveIntegerField', [], {'default': '0'}),
+            'parent': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['cms.CMSPlugin']", 'null': 'True', 'blank': 'True'}),
+            'path': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '255'}),
+            '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'})
+        },
+        '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'djangocms_file.file': {
+            'Meta': {'object_name': 'File', '_ormbases': ['cms.CMSPlugin']},
+            u'cmsplugin_ptr': ('django.db.models.fields.related.OneToOneField', [], {'to': "orm['cms.CMSPlugin']", 'unique': 'True', 'primary_key': 'True'}),
+            'source': ('django.db.models.fields.files.FileField', [], {'max_length': '100'}),
+            'target': ('django.db.models.fields.CharField', [], {'default': "''", 'max_length': '100', 'blank': 'True'}),
+            'title': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
+            'tooltip': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'})
+        }
+    }
+
+    complete_apps = ['djangocms_file']

djangocms_file/templates/cms/plugins/file.html

@@ -1,9 +1,9 @@
 {% load i18n %}
-{% if object.file.url %}
+{% if object.source.url %}
 <p class="plugin_file">
-	<a href="{{ object.file.url }}"{% if object.target %} target="{{ object.target }}"{% endif %}{% if object.tooltip %} title="{{ object.tooltip }}"{% endif %}>
+	<a href="{{ object.source.url }}"{% if object.target %} target="{{ object.target }}"{% endif %}{% if object.tooltip %} title="{{ object.tooltip }}"{% endif %}>
 		{% if object.get_icon_url %}<img src="{{ object.get_icon_url }}" alt="" />{% endif %}
-		{% if object.title %}<span class="filetitle">{{ object.title }}{% else %}{{ object.get_file_name }}{% endif %} {% if object.file_exists %}<span class="filesize">({{ object.file.size|filesizeformat }})</span>{% else %}({% trans "file missing!" %}){% endif %}{% if object.title %}</span>{% endif %}
+		{% if object.title %}<span class="filetitle">{{ object.title }}{% else %}{{ object.get_file_name }}{% endif %} {% if object.file_exists %}<span class="filesize">({{ object.source.size|filesizeformat }})</span>{% else %}({% trans "file missing!" %}){% endif %}{% if object.title %}</span>{% endif %}
 	</a>
 </p>
 {% endif %}