Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions taccsite_cms/management/commands/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [How to Use](#how-to-use)
- [List Pages Using Each Template](#list-pages-using-each-template)
- [List Pages Using Plugins](#list-pages-using-plugins)
- [Set Groups & Permissions](#set-groups--permissions)
- [Reference](#reference)

Expand All @@ -25,6 +26,21 @@ Usage:
python manage.py list_page_templates
```

## List Pages Using Plugins

This command lists all pages that use a specific plugin instance (given a plugin instance ID), along with the page's path.

Usage:
```sh
python manage.py list_plugin_pages <plugin_instance_id> [<plugin_instance_id> ...]
```

Example:
```sh
python manage.py list_plugin_pages 42 99
```


## Set Groups & Permissions

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]
Expand Down
25 changes: 25 additions & 0 deletions taccsite_cms/management/commands/list_plugin_pages.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
from django.core.management import BaseCommand
from django.apps import apps

class Command(BaseCommand):
help = 'Finds the page that uses a specific plugin instance by its ID'

def add_arguments(self, parser):
parser.add_argument('plugin_instance_ids', nargs='+', type=str)

def handle(self, *args, **options):
for plugin_instance_id in options['plugin_instance_ids']:
page = self.find_page_using_plugin_instance(plugin_instance_id)
if page:
self.stdout.write(f'Plugin instance ID {plugin_instance_id} is used on page: {page.get_path()}')
else:
self.stdout.write(f'No page found using plugin instance ID {plugin_instance_id}')

def find_page_using_plugin_instance(self, plugin_instance_id):
try:
CMSPlugin = apps.get_model('cms', 'CMSPlugin')
plugin_instance = CMSPlugin.objects.get(id=plugin_instance_id)
page = plugin_instance.placeholder.page if plugin_instance.placeholder else None
return page
except CMSPlugin.DoesNotExist:
return None