8000 Refs #6083 -- Added on_delete for all ForeignKeys and OneToOneFields by timgraham · Pull Request #6108 · django-cms/django-cms · GitHub
[go: up one dir, main page]

Skip to content

Refs #6083 -- Added on_delete for all ForeignKeys and OneToOneFields #6108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 7, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions cms/extensions/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@


class BaseExtension(models.Model):
public_extension = models.OneToOneField('self', null=True, editable=False, related_name='draft_extension')
public_extension = models.OneToOneField(
'self',
on_delete=models.CASCADE,
null=True,
editable=False,
related_name='draft_extension',
)
extended_object = None

class Meta:
Expand Down Expand Up @@ -105,7 +111,7 @@ def copy_to_public(self, public_object, language):


class PageExtension(BaseExtension):
extended_object = models.OneToOneField(Page, editable=False)
extended_object = models.OneToOneField(Page, on_delete=models.CASCADE, editable=False)

class Meta:
abstract = True
Expand All @@ -125,7 +131,7 @@ def delete(self, *args, **kwargs):


class TitleExtension(BaseExtension):
extended_object = models.OneToOneField(Title, editable=False)
extended_object = models.OneToOneField(Title, on_delete=models.CASCADE, editable=False)

class Meta:
abstract = True
Expand Down
22 changes: 11 additions & 11 deletions cms/migrations/0001_initial.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ class Migration(migrations.Migration):
migrations.CreateModel(
name='AliasPluginModel',
fields=[
('cmsplugin_ptr', models.OneToOneField(primary_key=True, to='cms.CMSPlugin', auto_created=True, parent_link=True, serialize=False)),
('plugin', models.ForeignKey(null=True, to='cms.CMSPlugin', related_name='alias_reference', editable=False)),
('cmsplugin_ptr', models.OneToOneField(primary_key=True, to='cms.CMSPlugin', auto_created=True, parent_link=True, serialize=False, on_delete=models.CASCADE)),
('plugin', models.ForeignKey(on_delete=models.CASCADE, null=True, to='cms.CMSPlugin', related_name='alias_reference', editable=False)),
],
options={
},
Expand All @@ -54,7 +54,7 @@ class Migration(migrations.Migration):
migrations.AddField(
model_name='cmsplugin',
name='parent',
field=models.ForeignKey(null=True, to='cms.CMSPlugin', blank=True, editable=False),
field=models.ForeignKey(on_delete=models.CASCADE, null=True, to='cms.CMSPlugin', blank=Tru 8000 e, editable=False),
preserve_default=True,
),
migrations.CreateModel(
Expand All @@ -70,9 +70,9 @@ class Migration(migrations.Migration):
('can_move_page', models.BooleanField(default=True, verbose_name=_('can move'))),
('can_view', models.BooleanField(default=False, help_text='frontend view restriction', verbose_name=_('view restricted'))),
('can_recover_page', models.BooleanField(default=True, help_text='can recover any deleted page', verbose_name=_('can recover pages'))),
('group', models.ForeignKey(null=True, to='auth.Group', verbose_name=_('group'), blank=True)),
('group', models.ForeignKey(on_delete=models.CASCADE, null=True, to='auth.Group', verbose_name=_('group'), blank=True)),
('sites', models.ManyToManyField(null=True, help_text='If none selected, user haves granted permissions to all sites.', blank=True, to='sites.Site', verbose_name=_('sites'))),
('user', models.ForeignKey(null=True, to=settings.AUTH_USER_MODEL, verbose_name=_('user'), blank=True)),
('user', models.ForeignKey(on_delete=models.CASCADE, null=True, to=settings.AUTH_USER_MODEL, verbose_name=_('user'), blank=True)),
],
options={
'verbose_name': 'Page global permission',
Expand Down Expand Up @@ -108,9 +108,9 @@ class Migration(migrations.Migration):
('languages', models.CharField(max_length=255, null=True, blank=True, editable=False)),
('revision_id', models.PositiveIntegerField(default=0, editable=False)),
('xframe_options', models.IntegerField(default=get_cms_setting('DEFAULT_X_FRAME_OPTIONS'), choices=Page.X_FRAME_OPTIONS_CHOICES)),
('parent', models.ForeignKey(null=True, to='cms.Page', related_name='children', blank=True)),
('publisher_public', models.OneToOneField(null=True, to='cms.Page', related_name='publisher_draft', editable=False)),
('site', models.ForeignKey(to='sites.Site', verbose_name=_('site'), related_name='djangocms_pages', help_text='The site the page is accessible at.')),
('parent', models.ForeignKey(on_delete=models.CASCADE, null=True, to='cms.Page', related_name='children', blank=True)),
('publisher_public', models.OneToOneField(null=True, to='cms.Page', related_name='publisher_draft', editable=False, on_delete=models.CASCADE)),
('site', models.ForeignKey(on_delete=models.CASCADE, to='sites.Site', verbose_name=_('site'), related_name='djangocms_pages', help_text='The site the page is accessible at.')),
],
options={
'ordering': ('tree_id', 'lft'),
Expand All @@ -133,9 +133,9 @@ class Migration(migrations.Migration):
('can_move_page', models.BooleanField(default=True, verbose_name=_('can move'))),
('can_view', models.BooleanField(default=False, help_text='frontend view restriction', verbose_name=_('view restricted'))),
('grant_on', models.IntegerField(default=5, verbose_name=_('Grant on'), choices=ACCESS_CHOICES)),
('group', models.ForeignKey(null=True, to='auth.Group', verbose_name=_('group'), blank=True)),
('page', models.ForeignKey(null=True, to='cms.Page', verbose_name=_('page'), blank=True)),
('user', models.ForeignKey(null=True, to=settings.AUTH_USER_MODEL, verbose_name=_('user'), blank=True)),
('group', models.ForeignKey(on_delete=models.CASCADE, null=True, to='auth.Group', verbose_name=_('group'), blank=True)),
('page', models.ForeignKey(on_delete=models.CASCADE, null=True, to='cms.Page', verbose_name=_('page'), blank=True)),
('user', models.ForeignKey(on_delete=models.CASCADE, null=True, to= 8000 settings.AUTH_USER_MODEL, verbose_name=_('user'), blank=True)),
],
options={
'verbose_name': 'Page permission',
Expand Down
24 changes: 12 additions & 12 deletions cms/migrations/0002_auto_20140816_1918.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ class Migration(migrations.Migration):
migrations.CreateModel(
name='PageUser',
fields=[
(user_ptr_name, models.OneToOneField(primary_key=True, to=settings.AUTH_USER_MODEL, auto_created=True, parent_link=True, serialize=False)),
('created_by', models.ForeignKey(to=settings.AUTH_USER_MODEL, related_name='created_users')),
(user_ptr_name, models.OneToOneField(primary_key=True, to=settings.AUTH_USER_MODEL, auto_created=True, parent_link=True, serialize=False, on_delete=models.CASCADE)),
('created_by', models.ForeignKey(to=settings.AUTH_USER_MODEL, related_name='created_users', on_delete=models.CASCADE)),
],
options={
'verbose_name': 'User (page)',
Expand All @@ -36,8 +36,8 @@ class Migration(migrations.Migration):
migrations.CreateModel(
name='PageUserGroup',
fields=[
('group_ptr', models.OneToOneField(primary_key=True, to='auth.Group', auto_created=True, parent_link=True, serialize=False)),
('created_by', models.ForeignKey(to=settings.AUTH_USER_MODEL, related_name='created_usergroups')),
('group_ptr', models.OneToOneField(primary_key=True, to='auth.Group', auto_created=True, parent_link=True, serialize=False, on_delete=models.CASCADE)),
('created_by', models.ForeignKey(to=settings.AUTH_USER_MODEL, related_name='created_usergroups', on_delete=models.CASCADE)),
],
options={
'verbose_name': 'User group (page)',
Expand Down Expand Up @@ -69,19 +69,19 @@ class Migration(migrations.Migration):
migrations.AddField(
model_name='cmsplugin',
name='placeholder',
field=models.ForeignKey(null=True, to='cms.Placeholder', editable=False),
field=models.ForeignKey(null=True, to='cms.Placeholder', editable=False, on_delete=models.CASCADE),
preserve_default=True,
),
migrations.AddField(
model_name='aliaspluginmodel',
name='alias_placeholder',
field=models.ForeignKey(null=True, to='cms.Placeholder', related_name='alias_placeholder', editable=False),
field=models.ForeignKey(null=True, to='cms.Placeholder', related_name='alias_placeholder', editable=False, on_delete=models.CASCADE),
preserve_default=True,
),
migrations.CreateModel(
name='PlaceholderReference',
fields=[
('cmsplugin_ptr', models.OneToOneField(primary_key=True, to='cms.CMSPlugin', auto_created=True, parent_link=True, serialize=False)),
('cmsplugin_ptr', models.OneToOneField(primary_key=True, to='cms.CMSPlugin', auto_created=True, parent_link=True, serialize=False, on_delete=models.CASCADE)),
('name', models.CharField(max_length=255)),
('placeholder_ref', cms.models.fields.PlaceholderField(null=True, to='cms.Placeholder', slotname='clipboard', editable=False)),
],
Expand All @@ -99,7 +99,7 @@ class Migration(migrations.Migration):
('creation_method', models.CharField(max_length=20, default='code', blank=True, verbose_name='creation_method', choices=cms.models.static_placeholder.StaticPlaceholder.CREATION_METHODS)),
('draft', cms.models.fields.PlaceholderField(null=True, to='cms.Placeholder', verbose_name='placeholder content', related_name='static_draft', slotname=cms.models.static_placeholder.static_slotname, editable=False)),
('public', cms.models.fields.PlaceholderField(null=True, to='cms.Placeholder', slotname=cms.models.static_placeholder.static_slotname, related_name='static_public', editable=False)),
('site', models.ForeignKey(null=True, to='sites.Site', blank=True)),
('site', models.ForeignKey(null=True, to='sites.Site', blank=True, on_delete=models.CASCADE)),
],
options={
'verbose_name': 'static placeholder',
Expand Down Expand Up @@ -128,8 +128,8 @@ class Migration(migrations.Migration):
('published', models.BooleanField(default=False, verbose_name='is published')),
('publisher_is_draft', models.BooleanField(db_index=True, default=True, editable=False)),
('publisher_state', models.SmallIntegerField(db_index=True, default=0, editable=False)),
('page', models.ForeignKey(to='cms.Page', verbose_name='page', related_name='title_set')),
('publisher_public', models.OneToOneField(null=True, to='cms.Title', related_name='publisher_draft', editable=False)),
('page', models.ForeignKey(to='cms.Page', verbose_name='page', related_name='title_set', on_delete=models.CASCADE)),
('publisher_public', models.OneToOneField(null=True, to='cms.Title', related_name='publisher_draft', editable=False, on_delete=models.CASCADE)),
],
options={
},
Expand All @@ -144,8 +144,8 @@ class Migration(migrations.Migration):
fields=[
('id', models.AutoField(primary_key=True, verbose_name='ID', auto_created=True, serialize=False)),
('language', models.CharField(max_length=10, choices=settings.LANGUAGES, help_text='The language for the admin interface and toolbar', verbose_name='Language')),
('clipboard', models.ForeignKey(null=True, to='cms.Placeholder', blank=True, editable=False)),
('user', models.ForeignKey(to=settings.AUTH_USER_MODEL, unique=True, related_name='djangocms_usersettings', editable=False)),
('clipboard', models.ForeignKey(null=True, to='cms.Placeholder', blank=True, editable=False, on_delete=models.CASCADE)),
('user', models.ForeignKey(to=settings.AUTH_USER_MODEL, unique=True, related_name='djangocms_usersettings', editable=False, on_delete=models.CASCADE)),
],
options={
'verbose_name': 'user setting',
Expand Down
2 changes: 1 addition & 1 deletion cms/migrations/0012_auto_20150607_2207.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class Migration(migrations.Migration):
migrations.AlterField(
model_name='usersettings',
name='user',
field=models.OneToOneField(related_name='djangocms_usersettings', editable=False, to=settings.AUTH_USER_MODEL),
field=models.OneToOneField(on_delete=models.CASCADE, related_name='djangocms_usersettings', editable=False, to=settings.AUTH_USER_MODEL),
preserve_default=True,
),
]
4 changes: 2 additions & 2 deletions cms/migrations/0016_auto_20160608_1535.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ class Migration(migrations.Migration):
migrations.AlterField(
model_name='aliaspluginmodel',
name='cmsplugin_ptr',
field=models.OneToOneField(parent_link=True, related_name='cms_aliasplugin', primary_key=True, serialize=False, to='cms.CMSPlugin'),
field=models.OneToOneField(parent_link=True, related_name='cms_aliasplugin', primary_key=True, serialize=False, to='cms.CMSPlugin', on_delete=models.CASCADE),
),
migrations.AlterField(
model_name='placeholderreference',
name='cmsplugin_ptr',
field=models.OneToOneField(parent_link=True, related_name='cms_placeholderreference', primary_key=True, serialize=False, to='cms.CMSPlugin'),
field=models.OneToOneField(parent_link=True, related_name='cms_placeholderreference', primary_key=True, serialize=False, to='cms.CMSPlugin', on_delete=models.CASCADE),
),
]
23 changes: 20 additions & 3 deletions cms/models/aliaspluginmodel.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,26 @@

@python_2_unicode_compatible
class AliasPluginModel(CMSPlugin):
cmsplugin_ptr = models.OneToOneField(CMSPlugin, related_name='cms_aliasplugin', parent_link=True)
plugin = models.ForeignKey(CMSPlugin, editable=False, related_name="alias_reference", null=True)
alias_placeholder = models.ForeignKey(Placeholder, editable=False, related_name="alias_placeholder", null=True)
cmsplugin_ptr = models.OneToOneField(
CMSPlugin,
on_delete=models.CASCADE,
related_name='cms_aliasplugin',
parent_link=True,
)
plugin = models.ForeignKey(
CMSPlugin,
on_delete=models.CASCADE,
editable=False,
related_name='alias_reference',
null=True,
)
alias_placeholder = models.ForeignKey(
Placeholder,
on_delete=models.CASCADE,
editable=False,
related_name='alias_placeholder',
null=True,
)

class Meta:
app_label = 'cms'
Expand Down
2 changes: 2 additions & 0 deletions cms/models/fields.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ def __init__(self, slotname, default_width=None, actions=None, **kwargs):
# We hard-code the `to` argument for ForeignKey.__init__
# since a PlaceholderField can only be a ForeignKey to a Placeholder
kwargs['to'] = 'cms.Placeholder'
kwargs['on_delete'] = models.CASCADE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Setting this here means user still needs to set on_delete in the migrations no?
If so, then this would silence the warning from Django and thus user won't know to update the migration files for model that uses this field.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, this means that my_placeholder = PlaceholderField('placeholder_name') still works as documented. models.CASCADE is always used and can't be overridden. If there's a use case for overriding it, then this could be kwargs.setdefault('on_delete', models.CASCADE).

super(PlaceholderField, self).__init__(**kwargs)

def deconstruct(self):
Expand Down Expand Up @@ -82,6 +83,7 @@ def __init__(self, **kwargs):
# We hard-code the `to` argument for ForeignKey.__init__
# since a PageField can only be a ForeignKey to a Page
kwargs['to'] = 'cms.Page'
kwargs['on_delete'] = models.CASCADE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same concern as above.

super(PageField, self).__init__(**kwargs)

def formfield(self, **kwargs):
Expand Down
19 changes: 16 additions & 3 deletions cms/models/pagemodel.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,13 @@ class Page(six.with_metaclass(PageMetaClass, models.Model)):
template = models.CharField(_("template"), max_length=100, choices=template_choices,
help_text=_('The template used to render the content.'),
default=TEMPLATE_DEFAULT)
site = models.ForeignKey(Site, help_text=_('The site the page is accessible at.'), verbose_name=_("site"),
related_name='djangocms_pages')
site = models.ForeignKey(
Site,
on_delete=models.CASCADE,
help_text=_('The site the page is accessible at.'),
verbose_name=_('site'),
related_name='djangocms_pages',
)

login_required = models.BooleanField(_("login required"), default=False)
limit_visibility_in_menu = models.SmallIntegerField(_("menu visibility"), default=None, null=True, blank=True,
Expand All @@ -105,7 +110,13 @@ class Page(six.with_metaclass(PageMetaClass, models.Model)):
# Publisher fields
publisher_is_draft = models.BooleanField(default=True, editable=False, db_index=True)
# This is misnamed - the one-to-one relation is populated on both ends
publisher_public = models.OneToOneField('self', related_name='publisher_draft', null=True, editable=False)
publisher_public = models.OneToOneField(
'self',
on_delete=models.CASCADE,
related_name='publisher_draft',
null=True,
editable=False,
)
languages = models.CharField(max_length=255, editable=False, blank=True, null=True)

# If the draft is loaded from a reversion version save the revision id here.
Expand Down Expand Up @@ -1694,13 +1705,15 @@ class PageNode(MP_Node):
)
parent = models.ForeignKey(
'self',
on_delete=models.CASCADE,
blank=True,
null=True,
related_name='children',
db_index=True,
)
site = models.ForeignKey(
Site,
on_delete=models.CASCADE,
verbose_name=_("site"),
help_text=_('The site the page is accessible at.'),
related_name='djangocms_page_nodes',
Expand Down
22 changes: 17 additions & 5 deletions cms/models/permissionmodels.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,20 @@ class AbstractPagePermission(models.Model):
"""

# who:
user = models.ForeignKey(settings.AUTH_USER_MODEL, verbose_name=_("user"), blank=True, null=True)
group = models.ForeignKey(Group, verbose_name=_("group"), blank=True, null=True)
user = models.ForeignKey(
settings.AUTH_USER_MODEL,
on_delete=models.CASCADE,
verbose_name=_("user"),
blank=True,
null=True,
)
group = models.ForeignKey(
Group,
on_delete=models.CASCADE,
verbose_name=_("group"),
blank=True,
null=True,
)

# what:
can_change = models.BooleanField(_("can edit"), default=True)
Expand Down Expand Up @@ -198,7 +210,7 @@ class PagePermission(AbstractPagePermission):
"""Page permissions for single page
"""
grant_on = models.IntegerField(_("Grant on"), choices=ACCESS_CHOICES, default=ACCESS_PAGE_AND_DESCENDANTS)
page = models.ForeignKey(Page, null=True, blank=True, verbose_name=_("page"))
page = models.ForeignKey(Page, on_delete=models.CASCADE, null=True, blank=True, verbose_name=_("page"))

objects = PagePermissionManager()

Expand Down Expand Up @@ -249,7 +261,7 @@ class PageUserManager(UserManager):
class PageUser(User):
"""Cms specific user data, required for permission system
"""
created_by = models.ForeignKey(settings.AUTH_USER_MODEL, related_name="created_users")
created_by = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="created_users")

objects = PageUserManager()

Expand All @@ -262,7 +274,7 @@ class Meta:
class PageUserGroup(Group):
"""Cms specific group data, required for permission system
"""
created_by = models.ForeignKey(settings.AUTH_USER_MODEL, related_name="created_usergroups")
created_by = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE, related_name="created_usergroups")

class Meta:
verbose_name = _('User AC76 group (page)')
Expand Down
7 changes: 6 additions & 1 deletion cms/models/placeholderpluginmodel.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@

@python_2_unicode_compatible
class PlaceholderReference(CMSPlugin):
cmsplugin_ptr = models.OneToOneField(CMSPlugin, related_name='cms_placeholderreference', parent_link=True)
cmsplugin_ptr = models.OneToOneField(
CMSPlugin,
on_delete=models.CASCADE,
related_name='cms_placeholderreference',
parent_link=True,
)
name = models.CharField(max_length=255)
placeholder_ref = PlaceholderField(slotname='clipboard')
class Meta:
Expand Down
Loading
0