From d79c85c7af9e0e5628096bfc77bb2ea34ae21e58 Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Mon, 11 Nov 2024 18:13:48 -0600
Subject: [PATCH 01/13] refactor: simpler syntax for group perms (#894)
* chore: remove unused imports
* refactor: add & use add_perm utility function
* docs: add & use add_perm utility function
* docs: missing spaces
* docs: missing spaces
---
.../management/commands/group_perms/README.md | 14 +-
.../group_perms/media_editor_advanced.py | 168 +++++-------------
.../group_perms/media_editor_basic.py | 82 +++------
.../group_perms/news_writer_advanced.py | 95 +++++-----
.../commands/group_perms/news_writer_basic.py | 59 +++---
.../group_perms/text_editor_advanced.py | 86 +++------
.../commands/group_perms/text_editor_basic.py | 60 ++-----
.../management/commands/group_perms/util.py | 23 +++
.../management/commands/set_group_perms.py | 1 -
9 files changed, 218 insertions(+), 370 deletions(-)
create mode 100644 taccsite_cms/management/commands/group_perms/util.py
diff --git a/taccsite_cms/management/commands/group_perms/README.md b/taccsite_cms/management/commands/group_perms/README.md
index 0d7e86d20..f8d7a0f2f 100644
--- a/taccsite_cms/management/commands/group_perms/README.md
+++ b/taccsite_cms/management/commands/group_perms/README.md
@@ -27,12 +27,10 @@ Use regex to convert the ``s from HTML to Python Django CMS instructions
- Replace:
- ```text
+ ```text
- model_name = '$2'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='$1', model=model_name)
- group.permissions.add( Permission.objects.get(name='$3', content_type=content_type) )
- ```
+ add_perm(group, '$1', '$2', '$3')
+ ```
## Program Permissions
@@ -40,13 +38,11 @@ Use regex to convert the ` `s from HTML to Python Django CMS instructions
2. Add this starter code:
```py
- from django.contrib.auth.models import Group, Permission
- from django.contrib.contenttypes.models import ContentType
- from django.core.management import BaseCommand
+ from django.contrib.auth.models import Group
def set_group_perms():
group, was_created = Group.objects.get_or_create(
- name='__GROUP_NAME__'
+ name='__GROUP_NAME__'
)
```
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
index 3855270da..77bec06dc 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
@@ -1,126 +1,54 @@
-from django.contrib.auth.models import Group, Permission
-from django.contrib.contenttypes.models import ContentType
-from django.core.management import BaseCommand
+from django.contrib.auth.models import Group
+
+from .util import add_perm
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='Media Editor (Advanced)'
)
- model_name = 'page'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='cms', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change page', content_type=content_type) )
- model_name = 'page'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='cms', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view page', content_type=content_type) )
-
- model_name = 'placeholder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='cms', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can use Structure mode', content_type=content_type) )
-
- model_name = 'bootstrap4 picture'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='bootstrap4_picture', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can add bootstrap4 picture', content_type=content_type) )
- model_name = 'bootstrap4 picture'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='bootstrap4_picture', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change bootstrap4 picture', content_type=content_type) )
- model_name = 'bootstrap4 picture'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='bootstrap4_picture', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can delete bootstrap4 picture', content_type=content_type) )
- model_name = 'bootstrap4 picture'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='bootstrap4_picture', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view bootstrap4 picture', content_type=content_type) )
-
- model_name = 'picture'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_picture', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can add picture', content_type=content_type) )
- model_name = 'picture'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_picture', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change picture', content_type=content_type) )
- model_name = 'picture'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_picture', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can delete picture', content_type=content_type) )
- model_name = 'picture'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_picture', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view picture', content_type=content_type) )
-
- model_name = 'video player'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can add video player', content_type=content_type) )
- model_name = 'video player'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change video player', content_type=content_type) )
- model_name = 'video player'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can delete video player', content_type=content_type) )
- model_name = 'video player'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view video player', content_type=content_type) )
- model_name = 'video source'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can add video source', content_type=content_type) )
- model_name = 'video source'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change video source', content_type=content_type) )
- model_name = 'video source'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can delete video source', content_type=content_type) )
- model_name = 'video source'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view video source', content_type=content_type) )
- model_name = 'video track'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can add video track', content_type=content_type) )
- model_name = 'video track'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change video track', content_type=content_type) )
- model_name = 'video track'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can delete video track', content_type=content_type) )
- model_name = 'video track'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view video track', content_type=content_type) )
-
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can add Folder', content_type=content_type) )
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change Folder', content_type=content_type) )
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view Folder', content_type=content_type) )
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can delete Folder', content_type=content_type) )
-
- model_name = 'file'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can add file', content_type=content_type) )
- model_name = 'file'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change file', content_type=content_type) )
- model_name = 'file'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view file', content_type=content_type) )
- model_name = 'file'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can delete file', content_type=content_type) )
-
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can use directory listing', content_type=content_type) )
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view Folder', content_type=content_type) )
-
- model_name = 'image'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change image', content_type=content_type) )
- model_name = 'image'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view image', content_type=content_type) )
-
- model_name = 'thumbnail option'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view thumbnail option', content_type=content_type) )
+ add_perm(group, 'cms', 'page', 'Can change page')
+ add_perm(group, 'cms', 'page', 'Can view page')
+
+ add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
+
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can add bootstrap4 picture')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can change bootstrap4 picture')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can delete bootstrap4 picture')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can view bootstrap4 picture')
+
+ add_perm(group, 'djangocms_picture', 'picture', 'Can add picture')
+ add_perm(group, 'djangocms_picture', 'picture', 'Can change picture')
+ add_perm(group, 'djangocms_picture', 'picture', 'Can delete picture')
+ add_perm(group, 'djangocms_picture', 'picture', 'Can view picture')
+
+ add_perm(group, 'djangocms_video', 'video player', 'Can add video player')
+ add_perm(group, 'djangocms_video', 'video player', 'Can change video player')
+ add_perm(group, 'djangocms_video', 'video player', 'Can delete video player')
+ add_perm(group, 'djangocms_video', 'video player', 'Can view video player')
+ add_perm(group, 'djangocms_video', 'video source', 'Can add video source')
+ add_perm(group, 'djangocms_video', 'video source', 'Can change video source')
+ add_perm(group, 'djangocms_video', 'video source', 'Can delete video source')
+ add_perm(group, 'djangocms_video', 'video source', 'Can view video source')
+ add_perm(group, 'djangocms_video', 'video track', 'Can add video track')
+ add_perm(group, 'djangocms_video', 'video track', 'Can change video track')
+ add_perm(group, 'djangocms_video', 'video track', 'Can delete video track')
+ add_perm(group, 'djangocms_video', 'video track', 'Can view video track')
+
+ add_perm(group, 'filer', 'Folder', 'Can add Folder')
+ add_perm(group, 'filer', 'Folder', 'Can change Folder')
+ add_perm(group, 'filer', 'Folder', 'Can view Folder')
+ add_perm(group, 'filer', 'Folder', 'Can delete Folder')
+
+ add_perm(group, 'filer', 'file', 'Can add file')
+ add_perm(group, 'filer', 'file', 'Can change file')
+ add_perm(group, 'filer', 'file', 'Can view file')
+ add_perm(group, 'filer', 'file', 'Can delete file')
+
+ add_perm(group, 'filer', 'Folder', 'Can use directory listing')
+ add_perm(group, 'filer', 'Folder', 'Can view Folder')
+
+ add_perm(group, 'filer', 'image', 'Can change image')
+ add_perm(group, 'filer', 'image', 'Can view image')
+
+ add_perm(group, 'filer', 'thumbnail option', 'Can view thumbnail option')
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_basic.py b/taccsite_cms/management/commands/group_perms/media_editor_basic.py
index 470a18d06..4f4239af6 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_basic.py
@@ -1,74 +1,36 @@
-from django.contrib.auth.models import Group, Permission
-from django.contrib.contenttypes.models import ContentType
-from django.core.management import BaseCommand
+from django.contrib.auth.models import Group
+
+from .util import add_perm
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='Media Editor (Basic)'
)
- model_name = 'page'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='cms', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change page', content_type=content_type) )
+ add_perm(group, 'cms', 'page', 'Can change page')
- model_name = 'placeholder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='cms', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can use Structure mode', content_type=content_type) )
+ add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
- model_name = 'bootstrap4 picture'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='bootstrap4_picture', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change bootstrap4 picture', content_type=content_type) )
- model_name = 'bootstrap4 picture'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='bootstrap4_picture', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view bootstrap4 picture', content_type=content_type) )
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can change bootstrap4 picture')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can view bootstrap4 picture')
- model_name = 'picture'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_picture', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change picture', content_type=content_type) )
- model_name = 'picture'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_picture', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view picture', content_type=content_type) )
+ add_perm(group, 'djangocms_picture', 'picture', 'Can change picture')
+ add_perm(group, 'djangocms_picture', 'picture', 'Can view picture')
- model_name = 'video player'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change video player', content_type=content_type) )
- model_name = 'video player'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view video player', content_type=content_type) )
- model_name = 'video source'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change video source', content_type=content_type) )
- model_name = 'video source'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view video source', content_type=content_type) )
- model_name = 'video track'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change video track', content_type=content_type) )
- model_name = 'video track'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_video', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view video track', content_type=content_type) )
+ add_perm(group, 'djangocms_video', 'video player', 'Can change video player')
+ add_perm(group, 'djangocms_video', 'video player', 'Can view video player')
+ add_perm(group, 'djangocms_video', 'video source', 'Can change video source')
+ add_perm(group, 'djangocms_video', 'video source', 'Can view video source')
+ add_perm(group, 'djangocms_video', 'video track', 'Can change video track')
+ add_perm(group, 'djangocms_video', 'video track', 'Can view video track')
- model_name = 'file'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change file', content_type=content_type) )
- model_name = 'file'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view file', content_type=content_type) )
+ add_perm(group, 'filer', 'file', 'Can change file')
+ add_perm(group, 'filer', 'file', 'Can view file')
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can use directory listing', content_type=content_type) )
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view Folder', content_type=content_type) )
+ add_perm(group, 'filer', 'Folder', 'Can use directory listing')
+ add_perm(group, 'filer', 'Folder', 'Can view Folder')
- model_name = 'image'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change image', content_type=content_type) )
- model_name = 'image'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view image', content_type=content_type) )
+ add_perm(group, 'filer', 'image', 'Can change image')
+ add_perm(group, 'filer', 'image', 'Can view image')
- model_name = 'thumbnail option'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view thumbnail option', content_type=content_type) )
+ add_perm(group, 'filer', 'thumbnail option', 'Can view thumbnail option')
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
index 931dc8f5d..861dc433b 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
@@ -1,53 +1,54 @@
-from django.contrib.auth.models import Group, Permission
-from django.core.management import BaseCommand
+from django.contrib.auth.models import Group
+
+from .util import add_perm
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='News Writer (Advanced)'
)
- group.permissions.add( Permission.objects.get(name='Can add bootstrap4 blockquote') )
- group.permissions.add( Permission.objects.get(name='Can change bootstrap4 blockquote') )
- group.permissions.add( Permission.objects.get(name='Can delete bootstrap4 blockquote') )
- group.permissions.add( Permission.objects.get(name='Can view bootstrap4 blockquote') )
- group.permissions.add( Permission.objects.get(name='Can add bootstrap4 picture') )
- group.permissions.add( Permission.objects.get(name='Can change bootstrap4 picture') )
- group.permissions.add( Permission.objects.get(name='Can delete bootstrap4 picture') )
- group.permissions.add( Permission.objects.get(name='Can view bootstrap4 picture') )
- group.permissions.add( Permission.objects.get(name='Can change cms plugin') )
- group.permissions.add( Permission.objects.get(name='Can view cms plugin') )
- group.permissions.add( Permission.objects.get(name='Can add cms plugin') )
- group.permissions.add( Permission.objects.get(name='Can delete cms plugin') )
- group.permissions.add( Permission.objects.get(name='Can change page') )
- group.permissions.add( Permission.objects.get(name='Can view page') )
- group.permissions.add( Permission.objects.get(name='Can use Structure mode') )
- group.permissions.add( Permission.objects.get(name='Can add blog category') )
- group.permissions.add( Permission.objects.get(name='Can change blog category') )
- group.permissions.add( Permission.objects.get(name='Can delete blog category') )
- group.permissions.add( Permission.objects.get(name='Can view blog category') )
- group.permissions.add( Permission.objects.get(name='Can add blog article') )
- group.permissions.add( Permission.objects.get(name='Can change blog article') )
- group.permissions.add( Permission.objects.get(name='Can view blog article') )
- group.permissions.add( Permission.objects.get(name='Can add link') )
- group.permissions.add( Permission.objects.get(name='Can change link') )
- group.permissions.add( Permission.objects.get(name='Can delete link') )
- group.permissions.add( Permission.objects.get(name='Can view link') )
- group.permissions.add( Permission.objects.get(name='Can add text') )
- group.permissions.add( Permission.objects.get(name='Can change text') )
- group.permissions.add( Permission.objects.get(name='Can delete text') )
- group.permissions.add( Permission.objects.get(name='Can view text') )
- group.permissions.add( Permission.objects.get(name='Can add video player') )
- group.permissions.add( Permission.objects.get(name='Can change video player') )
- group.permissions.add( Permission.objects.get(name='Can delete video player') )
- group.permissions.add( Permission.objects.get(name='Can view video player') )
- group.permissions.add( Permission.objects.get(name='Can add image') )
- group.permissions.add( Permission.objects.get(name='Can change image') )
- group.permissions.add( Permission.objects.get(name='Can view image') )
- group.permissions.add( Permission.objects.get(name='Can add tag') )
- group.permissions.add( Permission.objects.get(name='Can change tag') )
- group.permissions.add( Permission.objects.get(name='Can delete tag') )
- group.permissions.add( Permission.objects.get(name='Can view tag') )
- group.permissions.add( Permission.objects.get(name='Can add tagged item') )
- group.permissions.add( Permission.objects.get(name='Can change tagged item') )
- group.permissions.add( Permission.objects.get(name='Can delete tagged item') )
- group.permissions.add( Permission.objects.get(name='Can view tagged item') )
+ add_perm(group, 'bootstrap4_blockquote', 'bootstrap4 blockquote', 'Can add bootstrap4 blockquote')
+ add_perm(group, 'bootstrap4_blockquote', 'bootstrap4 blockquote', 'Can change bootstrap4 blockquote')
+ add_perm(group, 'bootstrap4_blockquote', 'bootstrap4 blockquote', 'Can delete bootstrap4 blockquote')
+ add_perm(group, 'bootstrap4_blockquote', 'bootstrap4 blockquote', 'Can view bootstrap4 blockquote')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can add bootstrap4 picture')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can change bootstrap4 picture')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can delete bootstrap4 picture')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can view bootstrap4 picture')
+ add_perm(group, 'cms', 'cms plugin', 'Can change cms plugin')
+ add_perm(group, 'cms', 'cms plugin', 'Can view cms plugin')
+ add_perm(group, 'cms', 'cms plugin', 'Can add cms plugin')
+ add_perm(group, 'cms', 'cms plugin', 'Can delete cms plugin')
+ add_perm(group, 'cms', 'page', 'Can change page')
+ add_perm(group, 'cms', 'page', 'Can view page')
+ add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
+ add_perm(group, 'djangocms_blog', 'blog category', 'Can add blog category')
+ add_perm(group, 'djangocms_blog', 'blog category', 'Can change blog category')
+ add_perm(group, 'djangocms_blog', 'blog category', 'Can delete blog category')
+ add_perm(group, 'djangocms_blog', 'blog category', 'Can view blog category')
+ add_perm(group, 'djangocms_blog', 'blog article', 'Can add blog article')
+ add_perm(group, 'djangocms_blog', 'blog article', 'Can change blog article')
+ add_perm(group, 'djangocms_blog', 'blog article', 'Can view blog article')
+ add_perm(group, 'djangocms_link', 'link', 'Can add link')
+ add_perm(group, 'djangocms_link', 'link', 'Can change link')
+ add_perm(group, 'djangocms_link', 'link', 'Can delete link')
+ add_perm(group, 'djangocms_link', 'link', 'Can view link')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can add text')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can change text')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can delete text')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can view text')
+ add_perm(group, 'djangocms_video', 'video player', 'Can add video player')
+ add_perm(group, 'djangocms_video', 'video player', 'Can change video player')
+ add_perm(group, 'djangocms_video', 'video player', 'Can delete video player')
+ add_perm(group, 'djangocms_video', 'video player', 'Can view video player')
+ add_perm(group, 'filer', 'image', 'Can add image')
+ add_perm(group, 'filer', 'image', 'Can change image')
+ add_perm(group, 'filer', 'image', 'Can view image')
+ add_perm(group, 'taggit', 'tag', 'Can add tag')
+ add_perm(group, 'taggit', 'tag', 'Can change tag')
+ add_perm(group, 'taggit', 'tag', 'Can delete tag')
+ add_perm(group, 'taggit', 'tag', 'Can view tag')
+ add_perm(group, 'taggit', 'tagged item', 'Can add tagged item')
+ add_perm(group, 'taggit', 'tagged item', 'Can change tagged item')
+ add_perm(group, 'taggit', 'tagged item', 'Can delete tagged item')
+ add_perm(group, 'taggit', 'tagged item', 'Can view tagged item')
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_basic.py b/taccsite_cms/management/commands/group_perms/news_writer_basic.py
index b5924611d..0faf36e8d 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_basic.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_basic.py
@@ -1,35 +1,36 @@
-from django.contrib.auth.models import Group, Permission
-from django.core.management import BaseCommand
+from django.contrib.auth.models import Group
+
+from .util import add_perm
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='News Writer (Basic)'
)
- group.permissions.add( Permission.objects.get(name='Can add bootstrap4 picture') )
- group.permissions.add( Permission.objects.get(name='Can change bootstrap4 picture') )
- group.permissions.add( Permission.objects.get(name='Can delete bootstrap4 picture') )
- group.permissions.add( Permission.objects.get(name='Can view bootstrap4 picture') )
- group.permissions.add( Permission.objects.get(name='Can change cms plugin') )
- group.permissions.add( Permission.objects.get(name='Can view cms plugin') )
- group.permissions.add( Permission.objects.get(name='Can change page') )
- group.permissions.add( Permission.objects.get(name='Can view page') )
- group.permissions.add( Permission.objects.get(name='Can use Structure mode') )
- group.permissions.add( Permission.objects.get(name='Can add blog article') )
- group.permissions.add( Permission.objects.get(name='Can change blog article') )
- group.permissions.add( Permission.objects.get(name='Can view blog article') )
- group.permissions.add( Permission.objects.get(name='Can add link') )
- group.permissions.add( Permission.objects.get(name='Can change link') )
- group.permissions.add( Permission.objects.get(name='Can delete link') )
- group.permissions.add( Permission.objects.get(name='Can view link') )
- group.permissions.add( Permission.objects.get(name='Can add text') )
- group.permissions.add( Permission.objects.get(name='Can change text') )
- group.permissions.add( Permission.objects.get(name='Can delete text') )
- group.permissions.add( Permission.objects.get(name='Can view text') )
- group.permissions.add( Permission.objects.get(name='Can add video player') )
- group.permissions.add( Permission.objects.get(name='Can change video player') )
- group.permissions.add( Permission.objects.get(name='Can delete video player') )
- group.permissions.add( Permission.objects.get(name='Can view video player') )
- group.permissions.add( Permission.objects.get(name='Can add image') )
- group.permissions.add( Permission.objects.get(name='Can change image') )
- group.permissions.add( Permission.objects.get(name='Can view image') )
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can add bootstrap4 picture')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can change bootstrap4 picture')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can delete bootstrap4 picture')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can view bootstrap4 picture')
+ add_perm(group, 'cms', 'cms plugin', 'Can change cms plugin')
+ add_perm(group, 'cms', 'cms plugin', 'Can view cms plugin')
+ add_perm(group, 'cms', 'page', 'Can change page')
+ add_perm(group, 'cms', 'page', 'Can view page')
+ add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
+ add_perm(group, 'djangocms_blog', 'blog article', 'Can add blog article')
+ add_perm(group, 'djangocms_blog', 'blog article', 'Can change blog article')
+ add_perm(group, 'djangocms_blog', 'blog article', 'Can view blog article')
+ add_perm(group, 'djangocms_link', 'link', 'Can add link')
+ add_perm(group, 'djangocms_link', 'link', 'Can change link')
+ add_perm(group, 'djangocms_link', 'link', 'Can delete link')
+ add_perm(group, 'djangocms_link', 'link', 'Can view link')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can add text')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can change text')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can delete text')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can view text')
+ add_perm(group, 'djangocms_video', 'video player', 'Can add video player')
+ add_perm(group, 'djangocms_video', 'video player', 'Can change video player')
+ add_perm(group, 'djangocms_video', 'video player', 'Can delete video player')
+ add_perm(group, 'djangocms_video', 'video player', 'Can view video player')
+ add_perm(group, 'filer', 'image', 'Can add image')
+ add_perm(group, 'filer', 'image', 'Can change image')
+ add_perm(group, 'filer', 'image', 'Can view image')
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
index 59103cec8..c12638a5b 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
@@ -1,74 +1,34 @@
-from django.contrib.auth.models import Group, Permission
-from django.contrib.contenttypes.models import ContentType
-from django.core.management import BaseCommand
+from django.contrib.auth.models import Group
+
+from .util import add_perm
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='Text Editor (Advanced)'
)
- model_name = 'page'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='cms', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change page', content_type=content_type) )
- model_name = 'page'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='cms', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view page', content_type=content_type) )
+ add_perm(group, 'cms', 'page', 'Can change page')
+ add_perm(group, 'cms', 'page', 'Can view page')
- model_name = 'placeholder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='cms', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can use Structure mode', content_type=content_type) )
+ add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
- model_name = 'link'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_link', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can add link', content_type=content_type) )
- model_name = 'link'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_link', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change link', content_type=content_type) )
- model_name = 'link'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_link', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can delete link', content_type=content_type) )
- model_name = 'link'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_link', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view link', content_type=content_type) )
+ add_perm(group, 'djangocms_link', 'link', 'Can add link')
+ add_perm(group, 'djangocms_link', 'link', 'Can change link')
+ add_perm(group, 'djangocms_link', 'link', 'Can delete link')
+ add_perm(group, 'djangocms_link', 'link', 'Can view link')
- model_name = 'text'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_text_ckeditor', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can add text', content_type=content_type) )
- model_name = 'text'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_text_ckeditor', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change text', content_type=content_type) )
- model_name = 'text'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_text_ckeditor', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can delete text', content_type=content_type) )
- model_name = 'text'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_text_ckeditor', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view text', content_type=content_type) )
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can add text')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can change text')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can delete text')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can view text')
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can use directory listing', content_type=content_type) )
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can add Folder', content_type=content_type) )
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change Folder', content_type=content_type) )
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view Folder', content_type=content_type) )
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can delete Folder', content_type=content_type) )
+ add_perm(group, 'filer', 'Folder', 'Can use directory listing')
+ add_perm(group, 'filer', 'Folder', 'Can add Folder')
+ add_perm(group, 'filer', 'Folder', 'Can change Folder')
+ add_perm(group, 'filer', 'Folder', 'Can view Folder')
+ add_perm(group, 'filer', 'Folder', 'Can delete Folder')
- model_name = 'file'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can add file', content_type=content_type) )
- model_name = 'file'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change file', content_type=content_type) )
- model_name = 'file'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can delete file', content_type=content_type) )
- model_name = 'file'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view file', content_type=content_type) )
+ add_perm(group, 'filer', 'file', 'Can add file')
+ add_perm(group, 'filer', 'file', 'Can change file')
+ add_perm(group, 'filer', 'file', 'Can delete file')
+ add_perm(group, 'filer', 'file', 'Can view file')
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_basic.py b/taccsite_cms/management/commands/group_perms/text_editor_basic.py
index 576b98566..8881c0367 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_basic.py
@@ -1,47 +1,25 @@
-from django.contrib.auth.models import Group, Permission
-from django.contrib.contenttypes.models import ContentType
-from django.core.management import BaseCommand
+from django.contrib.auth.models import Group
+
+from .util import add_perm
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='Text Editor (Basic)'
)
- model_name = 'page'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='cms', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change page', content_type=content_type) )
-
- model_name = 'placeholder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='cms', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can use Structure mode', content_type=content_type) )
-
- model_name = 'link'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_link', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change link', content_type=content_type) )
- model_name = 'link'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_link', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view link', content_type=content_type) )
-
- model_name = 'text'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_text_ckeditor', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change text', content_type=content_type) )
- model_name = 'text'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='djangocms_text_ckeditor', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view text', content_type=content_type) )
-
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can use directory listing', content_type=content_type) )
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change Folder', content_type=content_type) )
- model_name = 'Folder'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view Folder', content_type=content_type) )
-
- model_name = 'file'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can change file', content_type=content_type) )
- model_name = 'file'.lower().replace(' ', '')
- content_type = ContentType.objects.get(app_label='filer', model=model_name)
- group.permissions.add( Permission.objects.get(name='Can view file', content_type=content_type) )
+ add_perm(group, 'cms', 'page', 'Can change page')
+
+ add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
+
+ add_perm(group, 'djangocms_link', 'link', 'Can change link')
+ add_perm(group, 'djangocms_link', 'link', 'Can view link')
+
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can change text')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can view text')
+
+ add_perm(group, 'filer', 'Folder', 'Can use directory listing')
+ add_perm(group, 'filer', 'Folder', 'Can change Folder')
+ add_perm(group, 'filer', 'Folder', 'Can view Folder')
+
+ add_perm(group, 'filer', 'file', 'Can change file')
+ add_perm(group, 'filer', 'file', 'Can view file')
diff --git a/taccsite_cms/management/commands/group_perms/util.py b/taccsite_cms/management/commands/group_perms/util.py
new file mode 100644
index 000000000..a3c0097cf
--- /dev/null
+++ b/taccsite_cms/management/commands/group_perms/util.py
@@ -0,0 +1,23 @@
+from django.contrib.auth.models import Permission
+from django.contrib.contenttypes.models import ContentType
+
+def add_perm(group, app_label, model_name, perm_name):
+ """
+ Add specific permission to a given group
+
+ This can often be done with just the permission name e.g. —
+ `group.permissions.add( Permission.objects.get( name='…' ) )`
+ — but providing app and model ensure no conflict.
+ """
+ model = model_name.lower().replace(' ', '')
+ content_type = ContentType.objects.get(
+ app_label=app_label,
+ model=model
+ )
+
+ group.permissions.add(
+ Permission.objects.get(
+ name=perm_name,
+ content_type=content_type
+ )
+ )
diff --git a/taccsite_cms/management/commands/set_group_perms.py b/taccsite_cms/management/commands/set_group_perms.py
index c767db0a3..28fe4097f 100644
--- a/taccsite_cms/management/commands/set_group_perms.py
+++ b/taccsite_cms/management/commands/set_group_perms.py
@@ -2,7 +2,6 @@
import logging
import importlib
-from django.contrib.auth.models import Group, Permission
from django.core.management import BaseCommand
logger = logging.getLogger(__name__)
From 42190a76a0517c1c97d5ff7a4119b47a4a71825a Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Fri, 15 Nov 2024 15:45:28 -0600
Subject: [PATCH 02/13] feat: grid editor group and permissions (#896)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* feat: grid editor (⚠️ untested)
* fix: grid editor "row" not "rw"
* fix: grid editor permission name typos
---
.../group_perms/grid_editor_advanced.py | 28 +++++++++++++++++++
.../commands/group_perms/grid_editor_basic.py | 22 +++++++++++++++
2 files changed, 50 insertions(+)
create mode 100644 taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
create mode 100644 taccsite_cms/management/commands/group_perms/grid_editor_basic.py
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
new file mode 100644
index 000000000..5b3715355
--- /dev/null
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
@@ -0,0 +1,28 @@
+from django.contrib.auth.models import Group
+
+from .util import add_perm
+
+def set_group_perms():
+ group, was_created = Group.objects.get_or_create(
+ name='Grid Editor (Advanced)'
+ )
+
+ add_perm(group, 'cms', 'page', 'Can change page')
+ add_perm(group, 'cms', 'page', 'Can view page')
+
+ add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
+
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can add bootstrap4 grid container')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can change bootstrap4 grid container')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can delete bootstrap4 grid container')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can view bootstrap4 grid container')
+
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can add bootstrap4 grid column')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can change bootstrap4 grid column')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can delete bootstrap4 grid column')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can view bootstrap4 grid column')
+
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can add bootstrap4 grid row')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can change bootstrap4 grid row')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can delete bootstrap4 grid row')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can view bootstrap4 grid row')
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_basic.py b/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
new file mode 100644
index 000000000..e27e69c0b
--- /dev/null
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
@@ -0,0 +1,22 @@
+from django.contrib.auth.models import Group
+
+from .util import add_perm
+
+def set_group_perms():
+ group, was_created = Group.objects.get_or_create(
+ name='Grid Editor (Basic)'
+ )
+
+ add_perm(group, 'cms', 'page', 'Can change page')
+ add_perm(group, 'cms', 'page', 'Can view page')
+
+ add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
+
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can change bootstrap4 grid container')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can view bootstrap4 grid container')
+
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can change bootstrap4 grid column')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can view bootstrap4 grid column')
+
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can change bootstrap4 grid row')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can view bootstrap4 grid row')
From a88e9f8f0f51bef0b55e8407def47d9501d61900 Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Mon, 18 Nov 2024 16:11:38 -0600
Subject: [PATCH 03/13] refactor: less calls to `add_perm` (#899)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* refactor: consolidate add_perm calls (⚠️ untested)
* refactor: news_writer (⚠️ untested) & renames
* fix: user lacks [Edit] / [View published] buttons
* fix: errors adding permissions
---
.../group_perms/grid_editor_advanced.py | 28 +--
.../commands/group_perms/grid_editor_basic.py | 20 +-
.../group_perms/media_editor_advanced.py | 64 ++---
.../group_perms/media_editor_basic.py | 42 ++--
.../group_perms/news_writer_advanced.py | 75 +++---
.../commands/group_perms/news_writer_basic.py | 52 ++--
.../group_perms/text_editor_advanced.py | 42 ++--
.../commands/group_perms/text_editor_basic.py | 27 +-
.../management/commands/group_perms/util.py | 237 +++++++++++++++++-
9 files changed, 362 insertions(+), 225 deletions(-)
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
index 5b3715355..572a5823f 100644
--- a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
@@ -1,28 +1,16 @@
from django.contrib.auth.models import Group
-from .util import add_perm
+from .util import (
+ let_view_and_change_page_structure,
+ let_view_and_change_grid,
+ let_add_and_delete_grid
+)
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='Grid Editor (Advanced)'
)
- add_perm(group, 'cms', 'page', 'Can change page')
- add_perm(group, 'cms', 'page', 'Can view page')
-
- add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
-
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can add bootstrap4 grid container')
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can change bootstrap4 grid container')
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can delete bootstrap4 grid container')
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can view bootstrap4 grid container')
-
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can add bootstrap4 grid column')
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can change bootstrap4 grid column')
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can delete bootstrap4 grid column')
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can view bootstrap4 grid column')
-
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can add bootstrap4 grid row')
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can change bootstrap4 grid row')
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can delete bootstrap4 grid row')
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can view bootstrap4 grid row')
+ let_view_and_change_page_structure(group)
+ let_view_and_change_grid(group)
+ let_add_and_delete_grid(group)
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_basic.py b/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
index e27e69c0b..938356637 100644
--- a/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
@@ -1,22 +1,14 @@
from django.contrib.auth.models import Group
-from .util import add_perm
+from .util import (
+ let_view_and_change_page_structure,
+ let_view_and_change_grid
+)
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='Grid Editor (Basic)'
)
- add_perm(group, 'cms', 'page', 'Can change page')
- add_perm(group, 'cms', 'page', 'Can view page')
-
- add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
-
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can change bootstrap4 grid container')
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can view bootstrap4 grid container')
-
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can change bootstrap4 grid column')
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can view bootstrap4 grid column')
-
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can change bootstrap4 grid row')
- add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can view bootstrap4 grid row')
+ let_view_and_change_page_structure(group)
+ let_view_and_change_grid(group)
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
index 77bec06dc..0d377e7f3 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
@@ -1,54 +1,26 @@
from django.contrib.auth.models import Group
-from .util import add_perm
+from .util import (
+ let_view_and_change_page_structure,
+ let_view_and_change_media_plugins,
+ let_add_and_delete_media_plugins,
+ let_view_and_change_adv_media_plugins,
+ let_add_and_delete_adv_media_plugins,
+ let_view_thumbnail_option,
+ let_view_and_change_folder,
+ let_view_and_change_image_file,
+)
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='Media Editor (Advanced)'
)
- add_perm(group, 'cms', 'page', 'Can change page')
- add_perm(group, 'cms', 'page', 'Can view page')
-
- add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
-
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can add bootstrap4 picture')
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can change bootstrap4 picture')
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can delete bootstrap4 picture')
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can view bootstrap4 picture')
-
- add_perm(group, 'djangocms_picture', 'picture', 'Can add picture')
- add_perm(group, 'djangocms_picture', 'picture', 'Can change picture')
- add_perm(group, 'djangocms_picture', 'picture', 'Can delete picture')
- add_perm(group, 'djangocms_picture', 'picture', 'Can view picture')
-
- add_perm(group, 'djangocms_video', 'video player', 'Can add video player')
- add_perm(group, 'djangocms_video', 'video player', 'Can change video player')
- add_perm(group, 'djangocms_video', 'video player', 'Can delete video player')
- add_perm(group, 'djangocms_video', 'video player', 'Can view video player')
- add_perm(group, 'djangocms_video', 'video source', 'Can add video source')
- add_perm(group, 'djangocms_video', 'video source', 'Can change video source')
- add_perm(group, 'djangocms_video', 'video source', 'Can delete video source')
- add_perm(group, 'djangocms_video', 'video source', 'Can view video source')
- add_perm(group, 'djangocms_video', 'video track', 'Can add video track')
- add_perm(group, 'djangocms_video', 'video track', 'Can change video track')
- add_perm(group, 'djangocms_video', 'video track', 'Can delete video track')
- add_perm(group, 'djangocms_video', 'video track', 'Can view video track')
-
- add_perm(group, 'filer', 'Folder', 'Can add Folder')
- add_perm(group, 'filer', 'Folder', 'Can change Folder')
- add_perm(group, 'filer', 'Folder', 'Can view Folder')
- add_perm(group, 'filer', 'Folder', 'Can delete Folder')
-
- add_perm(group, 'filer', 'file', 'Can add file')
- add_perm(group, 'filer', 'file', 'Can change file')
- add_perm(group, 'filer', 'file', 'Can view file')
- add_perm(group, 'filer', 'file', 'Can delete file')
-
- add_perm(group, 'filer', 'Folder', 'Can use directory listing')
- add_perm(group, 'filer', 'Folder', 'Can view Folder')
-
- add_perm(group, 'filer', 'image', 'Can change image')
- add_perm(group, 'filer', 'image', 'Can view image')
-
- add_perm(group, 'filer', 'thumbnail option', 'Can view thumbnail option')
+ let_view_and_change_page_structure(group)
+ let_view_and_change_media_plugins(group)
+ let_add_and_delete_media_plugins(group)
+ let_view_and_change_adv_media_plugins(group)
+ let_add_and_delete_adv_media_plugins(group)
+ let_view_thumbnail_option(group)
+ let_view_and_change_folder(group)
+ let_view_and_change_image_file(group)
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_basic.py b/taccsite_cms/management/commands/group_perms/media_editor_basic.py
index 4f4239af6..a6bf7ad41 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_basic.py
@@ -1,36 +1,22 @@
from django.contrib.auth.models import Group
-from .util import add_perm
+from .util import (
+ let_view_and_change_page_structure,
+ let_view_and_change_media_plugins,
+ let_view_and_change_adv_media_plugins,
+ let_view_thumbnail_option,
+ let_view_folder,
+ let_view_and_change_image_file,
+)
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='Media Editor (Basic)'
)
- add_perm(group, 'cms', 'page', 'Can change page')
-
- add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
-
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can change bootstrap4 picture')
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can view bootstrap4 picture')
-
- add_perm(group, 'djangocms_picture', 'picture', 'Can change picture')
- add_perm(group, 'djangocms_picture', 'picture', 'Can view picture')
-
- add_perm(group, 'djangocms_video', 'video player', 'Can change video player')
- add_perm(group, 'djangocms_video', 'video player', 'Can view video player')
- add_perm(group, 'djangocms_video', 'video source', 'Can change video source')
- add_perm(group, 'djangocms_video', 'video source', 'Can view video source')
- add_perm(group, 'djangocms_video', 'video track', 'Can change video track')
- add_perm(group, 'djangocms_video', 'video track', 'Can view video track')
-
- add_perm(group, 'filer', 'file', 'Can change file')
- add_perm(group, 'filer', 'file', 'Can view file')
-
- add_perm(group, 'filer', 'Folder', 'Can use directory listing')
- add_perm(group, 'filer', 'Folder', 'Can view Folder')
-
- add_perm(group, 'filer', 'image', 'Can change image')
- add_perm(group, 'filer', 'image', 'Can view image')
-
- add_perm(group, 'filer', 'thumbnail option', 'Can view thumbnail option')
+ let_view_and_change_page_structure(group)
+ let_view_and_change_media_plugins(group)
+ let_view_and_change_adv_media_plugins(group)
+ let_view_folder(group)
+ let_view_and_change_image_file(group)
+ let_view_thumbnail_option(group)
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
index 861dc433b..036e45742 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
@@ -1,49 +1,50 @@
from django.contrib.auth.models import Group
-from .util import add_perm
+from .util import (
+ add_perm,
+ let_view_and_change_page_structure,
+ let_view_and_change_plugin,
+ let_view_and_change_text,
+ let_add_and_delete_text,
+ let_view_and_change_media_plugins,
+ let_add_and_delete_media_plugins,
+ let_view_and_change_image_file,
+)
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='News Writer (Advanced)'
)
- add_perm(group, 'bootstrap4_blockquote', 'bootstrap4 blockquote', 'Can add bootstrap4 blockquote')
- add_perm(group, 'bootstrap4_blockquote', 'bootstrap4 blockquote', 'Can change bootstrap4 blockquote')
- add_perm(group, 'bootstrap4_blockquote', 'bootstrap4 blockquote', 'Can delete bootstrap4 blockquote')
- add_perm(group, 'bootstrap4_blockquote', 'bootstrap4 blockquote', 'Can view bootstrap4 blockquote')
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can add bootstrap4 picture')
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can change bootstrap4 picture')
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can delete bootstrap4 picture')
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can view bootstrap4 picture')
- add_perm(group, 'cms', 'cms plugin', 'Can change cms plugin')
- add_perm(group, 'cms', 'cms plugin', 'Can view cms plugin')
- add_perm(group, 'cms', 'cms plugin', 'Can add cms plugin')
- add_perm(group, 'cms', 'cms plugin', 'Can delete cms plugin')
- add_perm(group, 'cms', 'page', 'Can change page')
- add_perm(group, 'cms', 'page', 'Can view page')
- add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
- add_perm(group, 'djangocms_blog', 'blog category', 'Can add blog category')
- add_perm(group, 'djangocms_blog', 'blog category', 'Can change blog category')
- add_perm(group, 'djangocms_blog', 'blog category', 'Can delete blog category')
- add_perm(group, 'djangocms_blog', 'blog category', 'Can view blog category')
- add_perm(group, 'djangocms_blog', 'blog article', 'Can add blog article')
- add_perm(group, 'djangocms_blog', 'blog article', 'Can change blog article')
- add_perm(group, 'djangocms_blog', 'blog article', 'Can view blog article')
- add_perm(group, 'djangocms_link', 'link', 'Can add link')
- add_perm(group, 'djangocms_link', 'link', 'Can change link')
- add_perm(group, 'djangocms_link', 'link', 'Can delete link')
- add_perm(group, 'djangocms_link', 'link', 'Can view link')
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can add text')
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can change text')
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can delete text')
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can view text')
- add_perm(group, 'djangocms_video', 'video player', 'Can add video player')
- add_perm(group, 'djangocms_video', 'video player', 'Can change video player')
- add_perm(group, 'djangocms_video', 'video player', 'Can delete video player')
- add_perm(group, 'djangocms_video', 'video player', 'Can view video player')
+ let_view_and_change_page_structure(group)
+ let_view_and_change_plugin(group)
+
+ let_view_and_change_text(group)
+ let_add_and_delete_text(group)
+ # NOTE: Consider adding these to `let…text` functions
+ add_perm(group, 'bootstrap4_content', 'bootstrap4 blockquote', 'Can add bootstrap4 blockquote')
+ add_perm(group, 'bootstrap4_content', 'bootstrap4 blockquote', 'Can change bootstrap4 blockquote')
+ add_perm(group, 'bootstrap4_content', 'bootstrap4 blockquote', 'Can delete bootstrap4 blockquote')
+ add_perm(group, 'bootstrap4_content', 'bootstrap4 blockquote', 'Can view bootstrap4 blockquote')
+
+ let_view_and_change_media_plugins(group)
+ let_add_and_delete_media_plugins(group)
+
+ let_view_and_change_image_file(group)
add_perm(group, 'filer', 'image', 'Can add image')
- add_perm(group, 'filer', 'image', 'Can change image')
- add_perm(group, 'filer', 'image', 'Can view image')
+
+ # Add permissions to view & change & add articles
+ add_perm(group, None, None, 'Can view blog article')
+ add_perm(group, None, None, 'Can change blog article')
+ add_perm(group, None, None, 'Can add blog article')
+
+ # Add permissions to manage categories
+ add_perm(group, None, None, 'Can add blog category')
+ add_perm(group, None, None, 'Can change blog category')
+ add_perm(group, None, None, 'Can delete blog category')
+ add_perm(group, None, None, 'Can view blog category')
+
+ # Add permissions to manage tags & tagged items (e.g. articles)
add_perm(group, 'taggit', 'tag', 'Can add tag')
add_perm(group, 'taggit', 'tag', 'Can change tag')
add_perm(group, 'taggit', 'tag', 'Can delete tag')
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_basic.py b/taccsite_cms/management/commands/group_perms/news_writer_basic.py
index 0faf36e8d..39938e2f5 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_basic.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_basic.py
@@ -1,36 +1,34 @@
from django.contrib.auth.models import Group
-from .util import add_perm
+from .util import (
+ add_perm,
+ let_view_and_change_page_structure,
+ let_view_and_change_plugin,
+ let_view_and_change_text,
+ let_add_and_delete_text,
+ let_view_and_change_media_plugins,
+ let_add_and_delete_media_plugins,
+ let_view_and_change_image_file,
+)
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='News Writer (Basic)'
)
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can add bootstrap4 picture')
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can change bootstrap4 picture')
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can delete bootstrap4 picture')
- add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can view bootstrap4 picture')
- add_perm(group, 'cms', 'cms plugin', 'Can change cms plugin')
- add_perm(group, 'cms', 'cms plugin', 'Can view cms plugin')
- add_perm(group, 'cms', 'page', 'Can change page')
- add_perm(group, 'cms', 'page', 'Can view page')
- add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
- add_perm(group, 'djangocms_blog', 'blog article', 'Can add blog article')
- add_perm(group, 'djangocms_blog', 'blog article', 'Can change blog article')
- add_perm(group, 'djangocms_blog', 'blog article', 'Can view blog article')
- add_perm(group, 'djangocms_link', 'link', 'Can add link')
- add_perm(group, 'djangocms_link', 'link', 'Can change link')
- add_perm(group, 'djangocms_link', 'link', 'Can delete link')
- add_perm(group, 'djangocms_link', 'link', 'Can view link')
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can add text')
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can change text')
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can delete text')
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can view text')
- add_perm(group, 'djangocms_video', 'video player', 'Can add video player')
- add_perm(group, 'djangocms_video', 'video player', 'Can change video player')
- add_perm(group, 'djangocms_video', 'video player', 'Can delete video player')
- add_perm(group, 'djangocms_video', 'video player', 'Can view video player')
+ let_view_and_change_page_structure(group)
+ let_view_and_change_plugin(group)
+
+ let_view_and_change_text(group)
+ let_add_and_delete_text(group)
+
+ let_view_and_change_media_plugins(group)
+ let_add_and_delete_media_plugins(group)
+
+ let_view_and_change_image_file(group)
add_perm(group, 'filer', 'image', 'Can add image')
- add_perm(group, 'filer', 'image', 'Can change image')
- add_perm(group, 'filer', 'image', 'Can view image')
+
+ # Add permissions to view & change & add articles
+ add_perm(group, None, None, 'Can view blog article')
+ add_perm(group, None, None, 'Can change blog article')
+ add_perm(group, None, None, 'Can add blog article')
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
index c12638a5b..0e8ad5ae2 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
@@ -1,34 +1,24 @@
from django.contrib.auth.models import Group
-from .util import add_perm
+from .util import (
+ let_view_and_change_page_structure,
+ let_view_and_change_text,
+ let_add_and_delete_text,
+ let_view_and_change_folder,
+ let_add_and_delete_folder,
+ let_view_and_change_file,
+ let_add_and_delete_file,
+)
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='Text Editor (Advanced)'
)
- add_perm(group, 'cms', 'page', 'Can change page')
- add_perm(group, 'cms', 'page', 'Can view page')
-
- add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
-
- add_perm(group, 'djangocms_link', 'link', 'Can add link')
- add_perm(group, 'djangocms_link', 'link', 'Can change link')
- add_perm(group, 'djangocms_link', 'link', 'Can delete link')
- add_perm(group, 'djangocms_link', 'link', 'Can view link')
-
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can add text')
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can change text')
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can delete text')
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can view text')
-
- add_perm(group, 'filer', 'Folder', 'Can use directory listing')
- add_perm(group, 'filer', 'Folder', 'Can add Folder')
- add_perm(group, 'filer', 'Folder', 'Can change Folder')
- add_perm(group, 'filer', 'Folder', 'Can view Folder')
- add_perm(group, 'filer', 'Folder', 'Can delete Folder')
-
- add_perm(group, 'filer', 'file', 'Can add file')
- add_perm(group, 'filer', 'file', 'Can change file')
- add_perm(group, 'filer', 'file', 'Can delete file')
- add_perm(group, 'filer', 'file', 'Can view file')
+ let_view_and_change_page_structure(group)
+ let_view_and_change_text(group)
+ let_add_and_delete_text(group)
+ let_view_and_change_folder(group)
+ let_add_and_delete_folder(group)
+ let_view_and_change_file(group)
+ let_add_and_delete_file(group)
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_basic.py b/taccsite_cms/management/commands/group_perms/text_editor_basic.py
index 8881c0367..8a0f13508 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_basic.py
@@ -1,25 +1,18 @@
from django.contrib.auth.models import Group
-from .util import add_perm
+from .util import (
+ let_view_and_change_page_structure,
+ let_view_and_change_text,
+ let_view_and_change_folder,
+ let_view_and_change_file,
+)
def set_group_perms():
group, was_created = Group.objects.get_or_create(
name='Text Editor (Basic)'
)
- add_perm(group, 'cms', 'page', 'Can change page')
-
- add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
-
- add_perm(group, 'djangocms_link', 'link', 'Can change link')
- add_perm(group, 'djangocms_link', 'link', 'Can view link')
-
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can change text')
- add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can view text')
-
- add_perm(group, 'filer', 'Folder', 'Can use directory listing')
- add_perm(group, 'filer', 'Folder', 'Can change Folder')
- add_perm(group, 'filer', 'Folder', 'Can view Folder')
-
- add_perm(group, 'filer', 'file', 'Can change file')
- add_perm(group, 'filer', 'file', 'Can view file')
+ let_view_and_change_page_structure(group)
+ let_view_and_change_text(group)
+ let_view_and_change_folder(group)
+ let_view_and_change_file(group)
diff --git a/taccsite_cms/management/commands/group_perms/util.py b/taccsite_cms/management/commands/group_perms/util.py
index a3c0097cf..f5bb831b7 100644
--- a/taccsite_cms/management/commands/group_perms/util.py
+++ b/taccsite_cms/management/commands/group_perms/util.py
@@ -1,6 +1,11 @@
+import logging
+
+from django.core.management import BaseCommand
from django.contrib.auth.models import Permission
from django.contrib.contenttypes.models import ContentType
+logger = logging.getLogger(__name__)
+
def add_perm(group, app_label, model_name, perm_name):
"""
Add specific permission to a given group
@@ -9,15 +14,227 @@ def add_perm(group, app_label, model_name, perm_name):
`group.permissions.add( Permission.objects.get( name='…' ) )`
— but providing app and model ensure no conflict.
"""
- model = model_name.lower().replace(' ', '')
- content_type = ContentType.objects.get(
- app_label=app_label,
- model=model
- )
+ logger.debug(f'Adding permission ({app_label}.{model_name}) "{perm_name}"')
- group.permissions.add(
- Permission.objects.get(
- name=perm_name,
- content_type=content_type
+ if app_label and model_name:
+ model = model_name.lower().replace(' ', '')
+ content_type = ContentType.objects.get(
+ app_label=app_label,
+ model=model
+ )
+ group.permissions.add(
+ Permission.objects.get(
+ name=perm_name,
+ content_type=content_type
+ )
)
- )
+ else:
+ group.permissions.add( Permission.objects.get( name=perm_name ))
+
+
+
+# Page
+def let_view_and_change_page_structure(group):
+ """
+ Add permissions to edit a page
+ """
+ add_perm(group, 'cms', 'page', 'Can view page')
+ add_perm(group, 'cms', 'page', 'Can change page')
+
+ add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
+ # HELP: Not necessary on TACC (as of Core-CMS v4.17.1)
+ # Is necessary on WTCS (as of Core-CMS v4.20.2)
+ add_perm(group, 'cms', 'static placeholder', 'Can change static placeholder')
+
+
+
+# Plugin
+# HELP: What does this do? Does plugin-specific permission make this moot?
+def let_view_and_change_plugin(group):
+ """
+ Add permissions to view & change ??? plugins
+ """
+ add_perm(group, 'cms', 'cms plugin', 'Can view cms plugin')
+ add_perm(group, 'cms', 'cms plugin', 'Can change cms plugin')
+
+
+
+# Grid
+def let_view_and_change_grid(group):
+ """
+ Add permissions to view & change Grid plugins
+ """
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can view bootstrap4 grid container')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can change bootstrap4 grid container')
+
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can view bootstrap4 grid column')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can change bootstrap4 grid column')
+
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can view bootstrap4 grid row')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can change bootstrap4 grid row')
+
+def let_add_and_delete_grid(group):
+ """
+ Add permissions to add & delete Grid plugins
+ """
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can add bootstrap4 grid container')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid container', 'Can delete bootstrap4 grid container')
+
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can add bootstrap4 grid column')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid column', 'Can delete bootstrap4 grid column')
+
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can add bootstrap4 grid row')
+ add_perm(group, 'bootstrap4_grid', 'bootstrap4 grid row', 'Can delete bootstrap4 grid row')
+
+
+
+# Text
+def let_view_and_change_text(group):
+ """
+ Add permissions to view & change text-based plugins
+ """
+ add_perm(group, 'djangocms_link', 'link', 'Can change link')
+ add_perm(group, 'djangocms_link', 'link', 'Can view link')
+
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can change text')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can view text')
+
+def let_add_and_delete_text(group):
+ """
+ Add permissions to add & delete text-based plugins
+ """
+ add_perm(group, 'djangocms_link', 'link', 'Can add link')
+ add_perm(group, 'djangocms_link', 'link', 'Can delete link')
+
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can add text')
+ add_perm(group, 'djangocms_text_ckeditor', 'text', 'Can delete text')
+
+
+
+# Media
+def let_view_and_change_media_plugins(group):
+ """
+ Add permissions to view & change media plugins
+ """
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can view bootstrap4 picture')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can change bootstrap4 picture')
+
+ add_perm(group, 'djangocms_picture', 'picture', 'Can view picture')
+ add_perm(group, 'djangocms_picture', 'picture', 'Can change picture')
+
+ add_perm(group, 'djangocms_video', 'video player', 'Can view video player')
+ add_perm(group, 'djangocms_video', 'video player', 'Can change video player')
+
+def let_view_and_change_adv_media_plugins(group):
+ """
+ Add permissions to view & change advanced media plugins
+ """
+ add_perm(group, 'djangocms_video', 'video source', 'Can view video source')
+ add_perm(group, 'djangocms_video', 'video source', 'Can change video source')
+
+ add_perm(group, 'djangocms_video', 'video track', 'Can view video track')
+ add_perm(group, 'djangocms_video', 'video track', 'Can change video track')
+
+def let_add_and_delete_media_plugins(group):
+ """
+ Add permissions to add & delete media plugins
+ """
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can add bootstrap4 picture')
+ add_perm(group, 'bootstrap4_picture', 'bootstrap4 picture', 'Can delete bootstrap4 picture')
+
+ add_perm(group, 'djangocms_picture', 'picture', 'Can add picture')
+ add_perm(group, 'djangocms_picture', 'picture', 'Can delete picture')
+
+ add_perm(group, 'djangocms_video', 'video player', 'Can add video player')
+ add_perm(group, 'djangocms_video', 'video player', 'Can delete video player')
+
+def let_add_and_delete_adv_media_plugins(group):
+ """
+ Add permissions to add & delete advanced media plugins
+ """
+ add_perm(group, 'djangocms_video', 'video source', 'Can add video source')
+ add_perm(group, 'djangocms_video', 'video source', 'Can delete video source')
+
+ add_perm(group, 'djangocms_video', 'video track', 'Can add video track')
+ add_perm(group, 'djangocms_video', 'video track', 'Can delete video track')
+
+
+
+# Files
+def let_view_and_change_file(group):
+ """
+ Add permissions to view & change files and file plugins
+ """
+ # (actual files)
+ add_perm(group, 'filer', 'file', 'Can change file')
+ add_perm(group, 'filer', 'file', 'Can view file')
+ # (file plugin instances)
+ add_perm(group, 'djangocms_file', 'file', 'Can change file')
+ add_perm(group, 'djangocms_file', 'file', 'Can view file')
+
+def let_add_and_delete_file(group):
+ """
+ Add permissions to add & delete files
+ """
+ # (actual files)
+ add_perm(group, 'filer', 'file', 'Can add file')
+ add_perm(group, 'filer', 'file', 'Can delete file')
+ # (file plugin instances)
+ add_perm(group, 'djangocms_file', 'file', 'Can add file')
+ add_perm(group, 'djangocms_file', 'file', 'Can delete file')
+
+def let_view_and_change_image_file(group):
+ """
+ Add permissions to view & change image files
+ """
+ add_perm(group, 'filer', 'image', 'Can change image')
+ add_perm(group, 'filer', 'image', 'Can view image')
+
+def let_add_and_delete_image_file(group):
+ """
+ Add permissions to add & delete image files
+ """
+ add_perm(group, 'filer', 'image', 'Can add image')
+ add_perm(group, 'filer', 'image', 'Can delete image')
+ # HELP: An image is a file… Is this overkill?
+ add_perm(group, 'filer', 'file', 'Can add file')
+ add_perm(group, 'filer', 'file', 'Can delete file')
+
+
+
+# Folders
+def let_view_folder(group):
+ """
+ Add permissions to view folders
+ """
+
+ add_perm(group, 'filer', 'Folder', 'Can use directory listing')
+ add_perm(group, 'filer', 'Folder', 'Can view Folder')
+
+ add_perm(group, 'djangocms_file', 'folder', 'Can view folder')
+
+def let_view_and_change_folder(group):
+ """
+ Add permissions to view & change folders
+ """
+
+ let_view_folder(group)
+ add_perm(group, 'filer', 'Folder', 'Can change Folder')
+
+def let_add_and_delete_folder(group):
+ """
+ Add permissions to add & delete folders
+ """
+
+ add_perm(group, 'filer', 'Folder', 'Can add Folder')
+ add_perm(group, 'filer', 'Folder', 'Can delete Folder')
+
+
+
+# Miscellaneous
+def let_view_thumbnail_option(group):
+ """
+ Add permissions to view thumbnail options
+ """
+
+ add_perm(group, 'filer', 'thumbnail option', 'Can view thumbnail option')
From 7ea572c065177ce7f2575c725c1d06f5df3612dc Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Tue, 10 Dec 2024 12:33:18 -0600
Subject: [PATCH 04/13] docs: CMD-189 groups & permissions & usage
---
.../management/commands/group_perms/README.md | 108 +++++++++++-------
1 file changed, 64 insertions(+), 44 deletions(-)
diff --git a/taccsite_cms/management/commands/group_perms/README.md b/taccsite_cms/management/commands/group_perms/README.md
index f8d7a0f2f..f6b84d65c 100644
--- a/taccsite_cms/management/commands/group_perms/README.md
+++ b/taccsite_cms/management/commands/group_perms/README.md
@@ -1,55 +1,26 @@
-# Programmatically Add Groups & Permissions to CMS
+# Programmatically Add Groups & Permissions
-## Get Permissions
+## Groups & Permissions
-You may **either** download an appropriate `.html` from [Django CMS - Developer Guide - User Permissions / Groups / Roles](https://tacc-main.atlassian.net/wiki/x/egtv) **or**:
-
-1. Using the CMS admin interface, build out the permissions for a group.
-2. Using the browser Developer Tools, copy the ` `s from the `` that has the permissions you chose.
-3. Save those `` to a new blank file.
-
-## Convert Permissions
-
-Use regex to convert the ``s from HTML to Python Django CMS instructions.
-
-- Find:\
- (minified HTML)
-
- ```regexp
- [\s\w]+ \| [\s\w]+ \| [\s\w]+
- ```
-
- (unminified HTML)
-
- ```regexp
- [\n\s]*\n*[\s]*[\s\w]+ \| [\s\w]+ \| [\s\w]+
- ```
+**News Writer (Basic)**: To edit/add Blog articles.
-- Replace:
+**News Writer (Advanced)**: As much as "News Writer (Basic)" **plus** edit/add/delete Blockquotes **plus** add/delete news Categories and Tags.
- ```text
+**Text Editor (Basic)**: To edit textual elements blocks, folders, and files.
- add_perm(group, '$1', '$2', '$3')
- ```
+**Text Editor (Advanced)**: As much as "Text Editor (Basic)" **plus** add/delete textual elements, folders and files.
-## Program Permissions
+**Media Editor (Basic)**: To edit images, videos, thumbnail sizes, and folders.
-1. Create a python script in this directory named after the group e.g. `news_writer_advanced.py`.
-2. Add this starter code:
+**Media Editor (Advanced)**: As much as "Media Editor (Basic)" **plus** add/delete images, videos, thumbnail sizes, and folders.
- ```py
- from django.contrib.auth.models import Group
+**Grid Editor (Basic)**: To edit layout (Containers, Rows, Columns).
- def set_group_perms():
- group, was_created = Group.objects.get_or_create(
- name='__GROUP_NAME__'
- )
- ```
+**Grid Editor (Advanced)**: As much as "Grid Editor (Basic)" **plus** add/delete layout (Containers, Rows, Columns).
-3. Change `__GROUP_NAME__` to the name of the group to add permissions for e.g. `News Writer (Advanced)`.
-4. Within the `handle` method, add all the commands from the "Convert Permissions" step.
+## Usage
-## Set Permissions
+### Set Permissions
1. Login to the CMS admin.
2. Open a shell into the CMS container e.g.
@@ -60,7 +31,7 @@ Use regex to convert the ``s from HTML to Python Django CMS instructions
[https://localhost:8000/admin/auth/group](https://localhost:8000/admin/auth/group)
5. In the CMS admin, verify group permissions are as you intend.
-## Debug Command
+### Debug a Command
1. Open a shell into the CMS container e.g. `docker exec -it core_cms /bin/bash`.
2. In the shell, open a Python shell i.e. `python`.
@@ -74,8 +45,57 @@ django.setup()
# any additional debugging code or scripts you want to execute
```
+## Develepment
+
+### Create a New Group
+
+1. Duplicate an existing group.
+2. Rename the file and group name.
+3. Adjust permissions usign existing sets.
+
+### Create a New Permission Set
+
+### via Existing Set in this Code
+
+1. Duplicate an existing `let_*` function in [`util.py`](./util.py).
+2. Rename the function. Rewrite its descritpion.
+3. Assign the permission set to a relevant group.
+
+### via Existing Group in CMS Admin
+
+#### 1. Get Permissions from HTML
+
+You may **either** download an appropriate `.html` from [Django CMS - Developer Guide - User Permissions / Groups / Roles](https://tacc-main.atlassian.net/wiki/x/egtv) **or**:
+
+1. Using the CMS admin interface, build out the permissions for a group.
+2. Using the browser Developer Tools, copy the ` `s from the `` that has the permissions you chose.
+3. Save those `` to a new blank file.
+
+#### 2. Convert Permissions to Python
+
+Use regex to convert the ``s from HTML to Python Django CMS instructions.
+
+- Find:\
+ (minified HTML)
+
+ ```regexp
+ [\s\w]+ \| [\s\w]+ \| [\s\w]+
+ ```
+
+ (unminified HTML)
+
+ ```regexp
+ [\n\s]*\n*[\s]*[\s\w]+ \| [\s\w]+ \| [\s\w]+
+ ```
+
+- Replace:
+
+ ```text
+
+ add_perm(group, '$1', '$2', '$3')
+ ```
+
## Reference
-- ["Next Steps" for this feature](https://github.com/TACC/Core-CMS/pull/598#issuecomment-1423258767)
- [Programmatically create a django group with permissions](https://stackoverflow.com/q/22250352/11817077)
-- [Writing custom django-admin commands](https://docs.djangoproject.com/en/2.2/howto/custom-management-commands/)
+- [Writing custom django-admin commands](https://docs.djangoproject.com/en/4.2/howto/custom-management-commands/)
From 648f1ef978e3aa9ade087171961b670b4530082c Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Tue, 10 Dec 2024 12:44:33 -0600
Subject: [PATCH 05/13] docs: CMD-189 move group perm descs to files
---
.../management/commands/group_perms/README.md | 20 +++----------------
.../group_perms/grid_editor_advanced.py | 5 +++++
.../commands/group_perms/grid_editor_basic.py | 4 ++++
.../group_perms/media_editor_advanced.py | 5 +++++
.../group_perms/media_editor_basic.py | 4 ++++
.../group_perms/news_writer_advanced.py | 6 ++++++
.../commands/group_perms/news_writer_basic.py | 4 ++++
.../group_perms/text_editor_advanced.py | 5 +++++
.../commands/group_perms/text_editor_basic.py | 4 ++++
9 files changed, 40 insertions(+), 17 deletions(-)
diff --git a/taccsite_cms/management/commands/group_perms/README.md b/taccsite_cms/management/commands/group_perms/README.md
index f6b84d65c..ecf6ba38f 100644
--- a/taccsite_cms/management/commands/group_perms/README.md
+++ b/taccsite_cms/management/commands/group_perms/README.md
@@ -2,21 +2,7 @@
## Groups & Permissions
-**News Writer (Basic)**: To edit/add Blog articles.
-
-**News Writer (Advanced)**: As much as "News Writer (Basic)" **plus** edit/add/delete Blockquotes **plus** add/delete news Categories and Tags.
-
-**Text Editor (Basic)**: To edit textual elements blocks, folders, and files.
-
-**Text Editor (Advanced)**: As much as "Text Editor (Basic)" **plus** add/delete textual elements, folders and files.
-
-**Media Editor (Basic)**: To edit images, videos, thumbnail sizes, and folders.
-
-**Media Editor (Advanced)**: As much as "Media Editor (Basic)" **plus** add/delete images, videos, thumbnail sizes, and folders.
-
-**Grid Editor (Basic)**: To edit layout (Containers, Rows, Columns).
-
-**Grid Editor (Advanced)**: As much as "Grid Editor (Basic)" **plus** add/delete layout (Containers, Rows, Columns).
+See the description at the top of each file in this folder.
## Usage
@@ -50,8 +36,8 @@ django.setup()
### Create a New Group
1. Duplicate an existing group.
-2. Rename the file and group name.
-3. Adjust permissions usign existing sets.
+2. Rename the file and gorup name. Rewrite file description.
+3. Adjust permissions using existing sets.
### Create a New Permission Set
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
index 572a5823f..fae97da79 100644
--- a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
@@ -1,3 +1,8 @@
+"""
+To do as much as `grid_editor_basic`
+To add/delete layout (Containers, Rows, Columns)
+"""
+
from django.contrib.auth.models import Group
from .util import (
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_basic.py b/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
index 938356637..f16f8b9e7 100644
--- a/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
@@ -1,3 +1,7 @@
+"""
+To edit layout (Containers, Rows, Columns)
+"""
+
from django.contrib.auth.models import Group
from .util import (
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
index 0d377e7f3..327c9a6dc 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
@@ -1,3 +1,8 @@
+"""
+To do as much as `media_editor_basic`
+To add/delete images, videos, thumbnail sizes, and folders
+"""
+
from django.contrib.auth.models import Group
from .util import (
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_basic.py b/taccsite_cms/management/commands/group_perms/media_editor_basic.py
index a6bf7ad41..d60b76386 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_basic.py
@@ -1,3 +1,7 @@
+"""
+To edit images, videos, thumbnail sizes, and folders
+"""
+
from django.contrib.auth.models import Group
from .util import (
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
index 036e45742..bb56789b2 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
@@ -1,3 +1,9 @@
+"""
+To do as much as `news_writer_basic`
+To edit/add/delete Blockquotes
+To add/delete news Categories and Tags
+"""
+
from django.contrib.auth.models import Group
from .util import (
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_basic.py b/taccsite_cms/management/commands/group_perms/news_writer_basic.py
index 39938e2f5..925422ee4 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_basic.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_basic.py
@@ -1,3 +1,7 @@
+"""
+To edit/add Blog articles
+"""
+
from django.contrib.auth.models import Group
from .util import (
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
index 0e8ad5ae2..f7458e247 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
@@ -1,3 +1,8 @@
+"""
+To do as much as `text_editor_basic`
+To add/delete textual elements, folders and files
+"""
+
from django.contrib.auth.models import Group
from .util import (
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_basic.py b/taccsite_cms/management/commands/group_perms/text_editor_basic.py
index 8a0f13508..12994f6a0 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_basic.py
@@ -1,3 +1,7 @@
+"""
+To edit textual elements blocks, folders, and files
+"""
+
from django.contrib.auth.models import Group
from .util import (
From 361a404f25366ba6d25fccd3dd0601fbf24ddd72 Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Tue, 10 Dec 2024 12:48:05 -0600
Subject: [PATCH 06/13] refactor: CMD-189 move utils and README to root
---
taccsite_cms/management/commands/{group_perms => }/README.md | 2 +-
.../management/commands/group_perms/grid_editor_advanced.py | 2 +-
.../management/commands/group_perms/grid_editor_basic.py | 2 +-
.../management/commands/group_perms/media_editor_advanced.py | 2 +-
.../management/commands/group_perms/media_editor_basic.py | 2 +-
.../management/commands/group_perms/news_writer_advanced.py | 2 +-
.../management/commands/group_perms/news_writer_basic.py | 2 +-
.../management/commands/group_perms/text_editor_advanced.py | 2 +-
.../management/commands/group_perms/text_editor_basic.py | 2 +-
taccsite_cms/management/commands/{group_perms => }/util.py | 0
10 files changed, 9 insertions(+), 9 deletions(-)
rename taccsite_cms/management/commands/{group_perms => }/README.md (97%)
rename taccsite_cms/management/commands/{group_perms => }/util.py (100%)
diff --git a/taccsite_cms/management/commands/group_perms/README.md b/taccsite_cms/management/commands/README.md
similarity index 97%
rename from taccsite_cms/management/commands/group_perms/README.md
rename to taccsite_cms/management/commands/README.md
index ecf6ba38f..24cfee8de 100644
--- a/taccsite_cms/management/commands/group_perms/README.md
+++ b/taccsite_cms/management/commands/README.md
@@ -2,7 +2,7 @@
## Groups & Permissions
-See the description at the top of each file in this folder.
+See the description at the top of each file in [`group_perms/`](./group_perms).
## Usage
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
index fae97da79..05dc452a9 100644
--- a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
@@ -5,7 +5,7 @@
from django.contrib.auth.models import Group
-from .util import (
+from ..util import (
let_view_and_change_page_structure,
let_view_and_change_grid,
let_add_and_delete_grid
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_basic.py b/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
index f16f8b9e7..443efa1e8 100644
--- a/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
@@ -4,7 +4,7 @@
from django.contrib.auth.models import Group
-from .util import (
+from ..util import (
let_view_and_change_page_structure,
let_view_and_change_grid
)
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
index 327c9a6dc..4d63fac22 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
@@ -5,7 +5,7 @@
from django.contrib.auth.models import Group
-from .util import (
+from ..util import (
let_view_and_change_page_structure,
let_view_and_change_media_plugins,
let_add_and_delete_media_plugins,
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_basic.py b/taccsite_cms/management/commands/group_perms/media_editor_basic.py
index d60b76386..256279b8c 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_basic.py
@@ -4,7 +4,7 @@
from django.contrib.auth.models import Group
-from .util import (
+from ..util import (
let_view_and_change_page_structure,
let_view_and_change_media_plugins,
let_view_and_change_adv_media_plugins,
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
index bb56789b2..d26ba72b2 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
@@ -6,7 +6,7 @@
from django.contrib.auth.models import Group
-from .util import (
+from ..util import (
add_perm,
let_view_and_change_page_structure,
let_view_and_change_plugin,
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_basic.py b/taccsite_cms/management/commands/group_perms/news_writer_basic.py
index 925422ee4..eef009de2 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_basic.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_basic.py
@@ -4,7 +4,7 @@
from django.contrib.auth.models import Group
-from .util import (
+from ..util import (
add_perm,
let_view_and_change_page_structure,
let_view_and_change_plugin,
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
index f7458e247..b3fdfd2b9 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
@@ -5,7 +5,7 @@
from django.contrib.auth.models import Group
-from .util import (
+from ..util import (
let_view_and_change_page_structure,
let_view_and_change_text,
let_add_and_delete_text,
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_basic.py b/taccsite_cms/management/commands/group_perms/text_editor_basic.py
index 12994f6a0..b9f207f8d 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_basic.py
@@ -4,7 +4,7 @@
from django.contrib.auth.models import Group
-from .util import (
+from ..util import (
let_view_and_change_page_structure,
let_view_and_change_text,
let_view_and_change_folder,
diff --git a/taccsite_cms/management/commands/group_perms/util.py b/taccsite_cms/management/commands/util.py
similarity index 100%
rename from taccsite_cms/management/commands/group_perms/util.py
rename to taccsite_cms/management/commands/util.py
From 559290c81693a4441346f487489a3c41c4aa7c25 Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Tue, 10 Dec 2024 12:52:05 -0600
Subject: [PATCH 07/13] docs: CMD-189 group descs, do not ref other groups
The previous documentation would allow groups that reference other groups to become inaccurate when referenced group changes without updating referencing group
---
.../management/commands/group_perms/grid_editor_advanced.py | 2 +-
.../management/commands/group_perms/media_editor_advanced.py | 2 +-
.../management/commands/group_perms/news_writer_advanced.py | 2 +-
.../management/commands/group_perms/text_editor_advanced.py | 4 ++--
4 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
index 05dc452a9..8ab2c0927 100644
--- a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
@@ -1,5 +1,5 @@
"""
-To do as much as `grid_editor_basic`
+To edit layout (Containers, Rows, Columns)
To add/delete layout (Containers, Rows, Columns)
"""
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
index 4d63fac22..2eabd9e11 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
@@ -1,5 +1,5 @@
"""
-To do as much as `media_editor_basic`
+To edit images, videos, thumbnail sizes, and folders
To add/delete images, videos, thumbnail sizes, and folders
"""
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
index d26ba72b2..18b8831bd 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
@@ -1,5 +1,5 @@
"""
-To do as much as `news_writer_basic`
+To edit/add Blog articles
To edit/add/delete Blockquotes
To add/delete news Categories and Tags
"""
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
index b3fdfd2b9..f494c02b3 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
@@ -1,6 +1,6 @@
"""
-To do as much as `text_editor_basic`
-To add/delete textual elements, folders and files
+To edit textual elements blocks, folders, and files
+To add/delete textual elements, folders, and files
"""
from django.contrib.auth.models import Group
From f830cf0d61584b8abae2a897ebab135dc01039c9 Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Tue, 10 Dec 2024 12:53:34 -0600
Subject: [PATCH 08/13] docs: CMD-189 reduce verbosity of descs
---
.../management/commands/group_perms/grid_editor_advanced.py | 3 +--
.../management/commands/group_perms/media_editor_advanced.py | 3 +--
.../management/commands/group_perms/text_editor_advanced.py | 3 +--
3 files changed, 3 insertions(+), 6 deletions(-)
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
index 8ab2c0927..bb2ca61e6 100644
--- a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
@@ -1,6 +1,5 @@
"""
-To edit layout (Containers, Rows, Columns)
-To add/delete layout (Containers, Rows, Columns)
+To edit/add/delete layout (Containers, Rows, Columns)
"""
from django.contrib.auth.models import Group
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
index 2eabd9e11..d0d603754 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
@@ -1,6 +1,5 @@
"""
-To edit images, videos, thumbnail sizes, and folders
-To add/delete images, videos, thumbnail sizes, and folders
+To edit/add/delete images, videos, thumbnail sizes, and folders
"""
from django.contrib.auth.models import Group
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
index f494c02b3..89ea00ea7 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
@@ -1,6 +1,5 @@
"""
-To edit textual elements blocks, folders, and files
-To add/delete textual elements, folders, and files
+To edit/add/delete textual elements, folders, and files
"""
from django.contrib.auth.models import Group
From edc31ed79b9cff4200fc475b374ed10c5b2dc054 Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Tue, 10 Dec 2024 13:27:08 -0600
Subject: [PATCH 09/13] docs: CMD-189 notes & polish
---
taccsite_cms/management/commands/README.md | 77 +++++++++++++++-------
1 file changed, 55 insertions(+), 22 deletions(-)
diff --git a/taccsite_cms/management/commands/README.md b/taccsite_cms/management/commands/README.md
index 24cfee8de..0d69cd286 100644
--- a/taccsite_cms/management/commands/README.md
+++ b/taccsite_cms/management/commands/README.md
@@ -1,38 +1,69 @@
# Programmatically Add Groups & Permissions
+- [Groups & Permissions](#groups--permissions)
+- [Usage](#usage)
+- [Develepment](#develepment)
+- [Reference](#reference)
+
## Groups & Permissions
-See the description at the top of each file in [`group_perms/`](./group_perms).
+Every file in [`group_perms/`](./group_perms) represents a group. Each group's intended usage is described at the top of its file. Permissions are set via function calls in each file.[^1]
## Usage
-### Set Permissions
+- [Add a Permissions Group](#add-a-permissions-group)
+- [Debug a Command](#debug-a-command)
+- [Assign Permissions to a User](#assign-permissions-to-a-user)
+
+### Add a Permissions Group
-1. Login to the CMS admin.
-2. Open a shell into the CMS container e.g.
- `docker exec -it core_cms /bin/bash`
-3. In the shell, run the group/permission command e.g.
- `python manage.py set_group_perms news_writer_advanced`
-4. Open the CMS admin interface e.g.
+1. Open a shell into the CMS container e.g.
+ ```sh
+ docker exec -it core_cms /bin/bash
+ ```
+2. In the shell, run the group/permission command e.g.
+ ```sh
+ python manage.py set_group_perms news_writer_advanced grid_editor_basic
+ ```
+3. Open the CMS admin interface e.g.
[https://localhost:8000/admin/auth/group](https://localhost:8000/admin/auth/group)
-5. In the CMS admin, verify group permissions are as you intend.
+4. Verify group permissions are as you intend.
+
+> **Note:** If group does not exist, this will **create** it. If group exists, this will **add** permissions to it, but will **not remove** permissions from it.
### Debug a Command
-1. Open a shell into the CMS container e.g. `docker exec -it core_cms /bin/bash`.
-2. In the shell, open a Python shell i.e. `python`.
+1. Open a shell into the CMS container e.g.
+ ```sh
+ docker exec -it core_cms /bin/bash
+ ```
+2. In the shell, open a Python shell i.e.
+ ```sh
+ python
+ ```
3. In the Python shell, run the following commands.
+ ```py
+ import os
+ import django
+ os.environ.setdefault("DJANGO_SETTINGS_MODULE", "taccsite_cms.settings")
+ django.setup()
+ ```
+4. Then run any additional debugging code or scripts you want to execute.
+
+### Assign Permissions to a User
-```py
-import os
-import django
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "taccsite_cms.settings")
-django.setup()
-# any additional debugging code or scripts you want to execute
-```
+Add the User to one or more groups.[^1]
+
+> **Warning:**
+> If [`CMS_PERMISSION = True`](https://docs.django-cms.org/en/3.11.8/topics/permissions.html#permission-modes) ([default for Core-CMS](https://github.com/TACC/Core-CMS/blob/v4.21.0/taccsite_cms/settings.py#L164)), then assigning one of these groups to a user is **not enough** to allow them to edit a page. You must also give that user [Global or per-page permissions](https://docs.django-cms.org/en/3.11.8/topics/permissions.html#global-and-per-page-permissions); do so [via a group](https://docs.django-cms.org/en/3.11.8/topics/permissions.html#use-permissions-on-groups-not-on-users).
## Develepment
+- [Create a New Group](#create-a-new-group)
+- [Create a New Permission Set](#create-a-new-permission-set)
+ - [via Existing Set in this Code](#via-existing-set-in-this-code)
+ - [via Existing Group in CMS Admin](#via-existing-group-in-cms-admin)
+
### Create a New Group
1. Duplicate an existing group.
@@ -41,15 +72,15 @@ django.setup()
### Create a New Permission Set
-### via Existing Set in this Code
+#### via Existing Set in this Code
1. Duplicate an existing `let_*` function in [`util.py`](./util.py).
2. Rename the function. Rewrite its descritpion.
3. Assign the permission set to a relevant group.
-### via Existing Group in CMS Admin
+#### via Existing Group in CMS Admin
-#### 1. Get Permissions from HTML
+##### 1. Get Permissions from HTML
You may **either** download an appropriate `.html` from [Django CMS - Developer Guide - User Permissions / Groups / Roles](https://tacc-main.atlassian.net/wiki/x/egtv) **or**:
@@ -57,7 +88,7 @@ You may **either** download an appropriate `.html` from [Django CMS - Developer
2. Using the browser Developer Tools, copy the ``s from the `` that has the permissions you chose.
3. Save those `` to a new blank file.
-#### 2. Convert Permissions to Python
+##### 2. Convert Permissions to Python
Use regex to convert the ``s from HTML to Python Django CMS instructions.
@@ -85,3 +116,5 @@ Use regex to convert the ` `s from HTML to Python Django CMS instructions
- [Programmatically create a django group with permissions](https://stackoverflow.com/q/22250352/11817077)
- [Writing custom django-admin commands](https://docs.djangoproject.com/en/4.2/howto/custom-management-commands/)
+
+[^1]: Groups that end in "(Advanced)" include the permissions of the corresponding "(Basic)" group.
From 1763effd59d15e39b3b92d6ef405be0002353029 Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Tue, 10 Dec 2024 13:30:40 -0600
Subject: [PATCH 10/13] docs: CMD-189 clearer group decs
---
.../management/commands/group_perms/grid_editor_advanced.py | 2 +-
.../management/commands/group_perms/grid_editor_basic.py | 2 +-
.../commands/group_perms/media_editor_advanced.py | 2 +-
.../management/commands/group_perms/media_editor_basic.py | 2 +-
.../management/commands/group_perms/news_writer_advanced.py | 6 +++---
.../management/commands/group_perms/news_writer_basic.py | 2 +-
.../management/commands/group_perms/text_editor_advanced.py | 2 +-
.../management/commands/group_perms/text_editor_basic.py | 2 +-
8 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
index bb2ca61e6..f84402e62 100644
--- a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
@@ -1,5 +1,5 @@
"""
-To edit/add/delete layout (Containers, Rows, Columns)
+To edit, move, add, and delete layout elements (Containers, Rows, Columns)
"""
from django.contrib.auth.models import Group
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_basic.py b/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
index 443efa1e8..83bb932d2 100644
--- a/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
@@ -1,5 +1,5 @@
"""
-To edit layout (Containers, Rows, Columns)
+To edit and move layout elements (Containers, Rows, Columns)
"""
from django.contrib.auth.models import Group
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
index d0d603754..5002290b3 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
@@ -1,5 +1,5 @@
"""
-To edit/add/delete images, videos, thumbnail sizes, and folders
+To edit, move, add, and delete images, videos, thumbnail sizes, and folders
"""
from django.contrib.auth.models import Group
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_basic.py b/taccsite_cms/management/commands/group_perms/media_editor_basic.py
index 256279b8c..12add3970 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_basic.py
@@ -1,5 +1,5 @@
"""
-To edit images, videos, thumbnail sizes, and folders
+To edit and move images, videos, thumbnail sizes, and folders
"""
from django.contrib.auth.models import Group
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
index 18b8831bd..fd84d9dbc 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
@@ -1,7 +1,7 @@
"""
-To edit/add Blog articles
-To edit/add/delete Blockquotes
-To add/delete news Categories and Tags
+To edit and add Blog articles
+To edit, add, and delete Blockquotes
+To edit, assign, add, and delete news Categories and Tags
"""
from django.contrib.auth.models import Group
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_basic.py b/taccsite_cms/management/commands/group_perms/news_writer_basic.py
index eef009de2..66ae2df4d 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_basic.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_basic.py
@@ -1,5 +1,5 @@
"""
-To edit/add Blog articles
+To edit and add Blog articles
"""
from django.contrib.auth.models import Group
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
index 89ea00ea7..95bf52e0b 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
@@ -1,5 +1,5 @@
"""
-To edit/add/delete textual elements, folders, and files
+To edit, move, add, and delete textual elements, folders, and files
"""
from django.contrib.auth.models import Group
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_basic.py b/taccsite_cms/management/commands/group_perms/text_editor_basic.py
index b9f207f8d..92d0a9e60 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_basic.py
@@ -1,5 +1,5 @@
"""
-To edit textual elements blocks, folders, and files
+To edit and move textual elements blocks, folders, and files
"""
from django.contrib.auth.models import Group
From 262093c8b023910397391313df9a43dbf7649c0c Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Tue, 10 Dec 2024 16:04:08 -0600
Subject: [PATCH 11/13] refactor: CMD-189 allow export of group names
---
.../management/commands/group_perms/grid_editor_advanced.py | 4 +++-
.../management/commands/group_perms/grid_editor_basic.py | 4 +++-
.../management/commands/group_perms/media_editor_advanced.py | 4 +++-
.../management/commands/group_perms/media_editor_basic.py | 4 +++-
.../management/commands/group_perms/news_writer_advanced.py | 4 +++-
.../management/commands/group_perms/news_writer_basic.py | 4 +++-
.../management/commands/group_perms/text_editor_advanced.py | 4 +++-
.../management/commands/group_perms/text_editor_basic.py | 4 +++-
8 files changed, 24 insertions(+), 8 deletions(-)
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
index f84402e62..fd7d4bdf0 100644
--- a/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_advanced.py
@@ -10,9 +10,11 @@
let_add_and_delete_grid
)
+GROUP_NAME = 'Grid Editor (Advanced)'
+
def set_group_perms():
group, was_created = Group.objects.get_or_create(
- name='Grid Editor (Advanced)'
+ name=GROUP_NAME
)
let_view_and_change_page_structure(group)
diff --git a/taccsite_cms/management/commands/group_perms/grid_editor_basic.py b/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
index 83bb932d2..582167ff0 100644
--- a/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/grid_editor_basic.py
@@ -9,9 +9,11 @@
let_view_and_change_grid
)
+GROUP_NAME = 'Grid Editor (Basic)'
+
def set_group_perms():
group, was_created = Group.objects.get_or_create(
- name='Grid Editor (Basic)'
+ name=GROUP_NAME
)
let_view_and_change_page_structure(group)
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
index 5002290b3..ad16e0132 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_advanced.py
@@ -15,9 +15,11 @@
let_view_and_change_image_file,
)
+GROUP_NAME = 'Media Editor (Advanced)'
+
def set_group_perms():
group, was_created = Group.objects.get_or_create(
- name='Media Editor (Advanced)'
+ name=GROUP_NAME
)
let_view_and_change_page_structure(group)
diff --git a/taccsite_cms/management/commands/group_perms/media_editor_basic.py b/taccsite_cms/management/commands/group_perms/media_editor_basic.py
index 12add3970..175d27d49 100644
--- a/taccsite_cms/management/commands/group_perms/media_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/media_editor_basic.py
@@ -13,9 +13,11 @@
let_view_and_change_image_file,
)
+GROUP_NAME = 'Media Editor (Basic)'
+
def set_group_perms():
group, was_created = Group.objects.get_or_create(
- name='Media Editor (Basic)'
+ name=GROUP_NAME
)
let_view_and_change_page_structure(group)
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
index fd84d9dbc..2e0234a69 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_advanced.py
@@ -17,9 +17,11 @@
let_view_and_change_image_file,
)
+GROUP_NAME = 'News Writer (Advanced)'
+
def set_group_perms():
group, was_created = Group.objects.get_or_create(
- name='News Writer (Advanced)'
+ name=GROUP_NAME
)
let_view_and_change_page_structure(group)
diff --git a/taccsite_cms/management/commands/group_perms/news_writer_basic.py b/taccsite_cms/management/commands/group_perms/news_writer_basic.py
index 66ae2df4d..fc91cbbf1 100644
--- a/taccsite_cms/management/commands/group_perms/news_writer_basic.py
+++ b/taccsite_cms/management/commands/group_perms/news_writer_basic.py
@@ -15,9 +15,11 @@
let_view_and_change_image_file,
)
+GROUP_NAME = 'News Writer (Basic)'
+
def set_group_perms():
group, was_created = Group.objects.get_or_create(
- name='News Writer (Basic)'
+ name=GROUP_NAME
)
let_view_and_change_page_structure(group)
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
index 95bf52e0b..3b1f21d31 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_advanced.py
@@ -14,9 +14,11 @@
let_add_and_delete_file,
)
+GROUP_NAME = 'Text Editor (Advanced)'
+
def set_group_perms():
group, was_created = Group.objects.get_or_create(
- name='Text Editor (Advanced)'
+ name=GROUP_NAME
)
let_view_and_change_page_structure(group)
diff --git a/taccsite_cms/management/commands/group_perms/text_editor_basic.py b/taccsite_cms/management/commands/group_perms/text_editor_basic.py
index 92d0a9e60..33e551ccc 100644
--- a/taccsite_cms/management/commands/group_perms/text_editor_basic.py
+++ b/taccsite_cms/management/commands/group_perms/text_editor_basic.py
@@ -11,9 +11,11 @@
let_view_and_change_file,
)
+GROUP_NAME = 'Text Editor (Basic)'
+
def set_group_perms():
group, was_created = Group.objects.get_or_create(
- name='Text Editor (Basic)'
+ name=GROUP_NAME
)
let_view_and_change_page_structure(group)
From 50479b7b08fee0ad1760525338b0338d1210f0f9 Mon Sep 17 00:00:00 2001
From: Wesley B <62723358+wesleyboar@users.noreply.github.com>
Date: Tue, 10 Dec 2024 16:05:36 -0600
Subject: [PATCH 12/13] =?UTF-8?q?docs:=20Development=20=E2=86=92=20Update?=
=?UTF-8?q?=20all=20CMS=20Instances?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Instruct developer how to update all instances of CMS via migrations.
---
taccsite_cms/management/commands/README.md | 106 ++++++++++++++++++++-
1 file changed, 103 insertions(+), 3 deletions(-)
diff --git a/taccsite_cms/management/commands/README.md b/taccsite_cms/management/commands/README.md
index 0d69cd286..679f64f3c 100644
--- a/taccsite_cms/management/commands/README.md
+++ b/taccsite_cms/management/commands/README.md
@@ -1,8 +1,8 @@
-# Programmatically Add Groups & Permissions
+# TACC CMS - Add Groups & Permissions
- [Groups & Permissions](#groups--permissions)
- [Usage](#usage)
-- [Develepment](#develepment)
+- [Development](#development)
- [Reference](#reference)
## Groups & Permissions
@@ -57,12 +57,13 @@ Add the User to one or more groups.[^1]
> **Warning:**
> If [`CMS_PERMISSION = True`](https://docs.django-cms.org/en/3.11.8/topics/permissions.html#permission-modes) ([default for Core-CMS](https://github.com/TACC/Core-CMS/blob/v4.21.0/taccsite_cms/settings.py#L164)), then assigning one of these groups to a user is **not enough** to allow them to edit a page. You must also give that user [Global or per-page permissions](https://docs.django-cms.org/en/3.11.8/topics/permissions.html#global-and-per-page-permissions); do so [via a group](https://docs.django-cms.org/en/3.11.8/topics/permissions.html#use-permissions-on-groups-not-on-users).
-## Develepment
+## Development
- [Create a New Group](#create-a-new-group)
- [Create a New Permission Set](#create-a-new-permission-set)
- [via Existing Set in this Code](#via-existing-set-in-this-code)
- [via Existing Group in CMS Admin](#via-existing-group-in-cms-admin)
+- [Update all CMS Instances](#update-all-cms-instances)
### Create a New Group
@@ -112,6 +113,105 @@ Use regex to convert the ` `s from HTML to Python Django CMS instructions
add_perm(group, '$1', '$2', '$3')
```
+### Update all CMS Instances
+
+Add new (reversible) migration file to `taccsite_cms/migrations`.
+
+#### Examples
+
+Add New Permission to Existing Group
+
+`add_new_perm_to_existing_group.py`
+```py
+from django.db import migrations
+
+def add_new_perm_in_existing_group(apps, schema_editor):
+ group = Group.objects.get(name='Your Group Name')
+ add_perm(group, 'the app label', 'the model name', 'The permission name')
+
+def del_new_perm_in_existing_group(apps, schema_editor):
+ group = Group.objects.get(name='Your Group Name')
+ del_perm(group, 'the app label', 'the model name', 'The permission name')
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('taccsite_cms', '0001_add_groups.py'), # most recent migration
+ ]
+
+ operations = [
+ migrations.RunPython(
+ add_new_perm_to_existing_group,
+ reverse_code=del_new_perm_in_existing_group
+ ),
+ ]
+```
+
+Add New Groups
+
+`add_new_groups.py`:
+```py
+from django.db import migrations
+
+def add_new_groups(apps, schema_editor):
+ from taccsite_cms.management.commands.group_perms.new_group_basic import set_group_perms as add_new_group_basic
+ from taccsite_cms.management.commands.group_perms.new_group_advanced import set_group_perms as add_new_group_advanced
+
+ add_new_group_basic()
+ add_new_group_advanced()
+
+def del_new_groups(apps, schema_editor):
+ from taccsite_cms.management.commands.group_perms.new_group_basic import GROUP_NAME as new_group_basic_group_name
+ from taccsite_cms.management.commands.group_perms.new_group_advanced import GROUP_NAME as new_group_advanced_group_name
+
+ Group = apps.get_model('auth', 'Group')
+ Group.objects.filter(name=new_group_basic_group_name).delete()
+ Group.objects.filter(name=new_group_advanced_group_name).delete()
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('taccsite_cms', '0002_add_new_perm_to_existing_group.py'), # most recent migration
+ ]
+
+ operations = [
+ migrations.RunPython(add_new_groups, reverse_code=del_new_groups),
+ ]
+```
+Delete a Group
+
+`del_group.py`:
+```py
+from django.db import migrations
+
+def del_group(apps, schema_editor):
+ from taccsite_cms.management.commands.group_perms.media_editor_advanced import GROUP_NAME as media_editor_advanced_group_name
+
+ Group = apps.get_model('auth', 'Group')
+ Group.objects.filter(name=media_editor_advanced_group_name).delete()
+
+def add_group(apps, schema_editor):
+ from taccsite_cms.management.commands.group_perms.media_editor_advanced import set_group_perms as add_media_editor_advanced
+
+ add_media_editor_advanced()
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ('taccsite_cms', '0003_add_new_groups.py'), # most recent migration
+ ]
+
+ operations = [
+ migrations.RunPython(del_group, reverse_code=add_group),
+ ]
+```
+
+e.g. docker exec -it core_cms /bin/bash
2. Add groups implicitely via migration:
`python manage.py migrate taccsite_cms`
3. Verify [groups], and their permissions, are **present**.
4. Reverse that migration:
`python manage.py migrate taccsite_cms zero`
5. Verify [groups], and their permissions, are **absent**.
6. Add groups explicitely via migration:
`python manage.py migrate taccsite_cms 0001_add_groups`
7. Verify [groups], and their permissions, are **present**.
8. Reverse that migration:
`python manage.py migrate taccsite_cms zero`
9. Verify [groups], and their permissions, are **absent**.
[groups]: https://localhost:8000/admin/auth/group
---
taccsite_cms/migrations/0001_add_groups.py | 42 ++++++++++++++++++++++
taccsite_cms/migrations/README.md | 7 ++++
taccsite_cms/migrations/__init__.py | 0
3 files changed, 49 insertions(+)
create mode 100644 taccsite_cms/migrations/0001_add_groups.py
create mode 100644 taccsite_cms/migrations/README.md
create mode 100644 taccsite_cms/migrations/__init__.py
diff --git a/taccsite_cms/migrations/0001_add_groups.py b/taccsite_cms/migrations/0001_add_groups.py
new file mode 100644
index 000000000..94ef39471
--- /dev/null
+++ b/taccsite_cms/migrations/0001_add_groups.py
@@ -0,0 +1,42 @@
+from django.db import migrations
+
+def add_groups(apps, schema_editor):
+ from taccsite_cms.management.commands.group_perms.text_editor_basic import set_group_perms as add_text_editor_basic
+ from taccsite_cms.management.commands.group_perms.text_editor_advanced import set_group_perms as add_text_editor_advanced
+ from taccsite_cms.management.commands.group_perms.media_editor_basic import set_group_perms as add_media_editor_basic
+ from taccsite_cms.management.commands.group_perms.media_editor_advanced import set_group_perms as add_media_editor_advanced
+ from taccsite_cms.management.commands.group_perms.grid_editor_basic import set_group_perms as add_grid_editor_basic
+ from taccsite_cms.management.commands.group_perms.grid_editor_advanced import set_group_perms as add_grid_editor_advanced
+
+ add_text_editor_basic()
+ add_text_editor_advanced()
+ add_media_editor_basic()
+ add_media_editor_advanced()
+ add_grid_editor_basic()
+ add_grid_editor_advanced()
+
+def remove_groups(apps, schema_editor):
+ from taccsite_cms.management.commands.group_perms.text_editor_basic import GROUP_NAME as text_editor_basic_name
+ from taccsite_cms.management.commands.group_perms.text_editor_advanced import GROUP_NAME as text_editor_advanced_name
+ from taccsite_cms.management.commands.group_perms.media_editor_basic import GROUP_NAME as media_editor_basic_name
+ from taccsite_cms.management.commands.group_perms.media_editor_advanced import GROUP_NAME as media_editor_advanced_name
+ from taccsite_cms.management.commands.group_perms.grid_editor_basic import GROUP_NAME as grid_editor_basic_name
+ from taccsite_cms.management.commands.group_perms.grid_editor_advanced import GROUP_NAME as grid_editor_advanced_name
+
+ Group = apps.get_model('auth', 'Group')
+
+ group_names = [
+ text_editor_basic_name,
+ text_editor_advanced_name,
+ media_editor_basic_name,
+ media_editor_advanced_name,
+ grid_editor_basic_name,
+ grid_editor_advanced_name,
+ ]
+
+ Group.objects.filter(name__in=group_names).delete()
+
+class Migration(migrations.Migration):
+ operations = [
+ migrations.RunPython(add_groups, reverse_code=remove_groups),
+ ]
diff --git a/taccsite_cms/migrations/README.md b/taccsite_cms/migrations/README.md
new file mode 100644
index 000000000..de13c8599
--- /dev/null
+++ b/taccsite_cms/migrations/README.md
@@ -0,0 +1,7 @@
+# TACC CMS - Migrations
+
+These allow us to perform programmatic actions, and successive adjustments, in sequence, for all instances of a Core-CMS.
+
+## Reference
+
+- [Mastering Django Migrations: A Comprehensive Guide for Efficient Database Management](https://medium.com/django-unleashed/mastering-django-migrations-a-comprehensive-guide-for-efficient-database-management-f2fc219f9a20)
diff --git a/taccsite_cms/migrations/__init__.py b/taccsite_cms/migrations/__init__.py
new file mode 100644
index 000000000..e69de29bb