Closes #19735: Implement reuable bulk operations classes (#19774)

* Initial work on #19735

* Work in progress

* Remove ClusterRemoveDevicesView (anti-pattern)

* Misc cleanup

* Fix has_bulk_actions

* Fix has_bulk_actions for ObjectChildrenView

* Restore clone button

* Misc cleanup

* Clean up custom bulk actions

* Rename individual object actions

* Collapse into a single template tag

* Fix support for legacy action dicts

* Rename bulk attr to multi

* clone_button tag should fail silently if view name is invalid

* Clean up action buttons

* Fix export button label

* Replace clone_button with an ObjectAction

* Create object actions for adding device/VM components

* Move core_sync.html to core app

* Remove extra_bulk_buttons from template doc

Author: jeremystretch

netbox/core/object_actions.py

@@ -0,0 +1,18 @@
+from django.utils.translation import gettext as _
+
+from netbox.object_actions import ObjectAction
+
+__all__ = (
+    'BulkSync',
+)
+
+
+class BulkSync(ObjectAction):
+    """
+    Synchronize multiple objects at once.
+    """
+    name = 'bulk_sync'
+    label = _('Sync Data')
+    multi = True
+    permissions_required = {'sync'}
+    template_name = 'core/buttons/bulk_sync.html'

netbox/core/views.py

@@ -22,6 +22,7 @@
 
 from core.utils import delete_rq_job, enqueue_rq_job, get_rq_jobs_from_status, requeue_rq_job, stop_rq_job
 from netbox.config import get_config, PARAMS
+from netbox.object_actions import AddObject, BulkDelete, BulkExport, DeleteObject
 from netbox.registry import registry
 from netbox.views import generic
 from netbox.views.generic.base import BaseObjectView
@@ -138,14 +139,13 @@ class DataFileListView(generic.ObjectListView):
     filterset = filtersets.DataFileFilterSet
     filterset_form = forms.DataFileFilterForm
     table = tables.DataFileTable
-    actions = {
-        'bulk_delete': {'delete'},
-    }
+    actions = (BulkDelete,)
 
 
 @register_model_view(DataFile)
 class DataFileView(generic.ObjectView):
     queryset = DataFile.objects.all()
+    actions = (DeleteObject,)
 
 
 @register_model_view(DataFile, 'delete')
@@ -170,15 +170,13 @@ class JobListView(generic.ObjectListView):
     filterset = filtersets.JobFilterSet
     filterset_form = forms.JobFilterForm
     table = tables.JobTable
-    actions = {
-        'export': {'view'},
-        'bulk_delete': {'delete'},
-    }
+    actions = (BulkExport, BulkDelete)
 
 
 @register_model_view(Job)
 class JobView(generic.ObjectView):
     queryset = Job.objects.all()
+    actions = (DeleteObject,)
 
 
 @register_model_view(Job, 'delete')
@@ -204,9 +202,7 @@ class ObjectChangeListView(generic.ObjectListView):
     filterset_form = forms.ObjectChangeFilterForm
     table = tables.ObjectChangeTable
     template_name = 'core/objectchange_list.html'
-    actions = {
-        'export': {'view'},
-    }
+    actions = (BulkExport,)
 
 
 @register_model_view(ObjectChange)
@@ -274,6 +270,7 @@ class ConfigRevisionListView(generic.ObjectListView):
     filterset = filtersets.ConfigRevisionFilterSet
     filterset_form = forms.ConfigRevisionFilterForm
     table = tables.ConfigRevisionTable
+    actions = (AddObject, BulkExport)
 
 
 @register_model_view(ConfigRevision)

netbox/dcim/object_actions.py

@@ -0,0 +1,38 @@
+from django.utils.translation import gettext as _
+
+from netbox.object_actions import ObjectAction
+
+__all__ = (
+    'BulkAddComponents',
+    'BulkDisconnect',
+)
+
+
+class BulkAddComponents(ObjectAction):
+    """
+    Add components to the selected devices.
+    """
+    label = _('Add Components')
+    multi = True
+    permissions_required = {'change'}
+    template_name = 'dcim/buttons/bulk_add_components.html'
+
+    @classmethod
+    def get_context(cls, context, obj):
+        return {
+            'perms': context.get('perms'),
+            'request': context.get('request'),
+            'formaction': context.get('formaction'),
+            'label': cls.label,
+        }
+
+
+class BulkDisconnect(ObjectAction):
+    """
+    Disconnect each of a set of objects to which a cable is connected.
+    """
+    name = 'bulk_disconnect'
+    label = _('Disconnect Selected')
+    multi = True
+    permissions_required = {'change'}
+    template_name = 'dcim/buttons/bulk_disconnect.html'