diff --git a/netbox/users/api/urls.py b/netbox/users/api/urls.py
index 4176cc806..df2e8c25a 100644
--- a/netbox/users/api/urls.py
+++ b/netbox/users/api/urls.py
@@ -12,5 +12,8 @@ router.register('groups', views.GroupViewSet)
# Permissions
router.register('permissions', views.ObjectPermissionViewSet)
+# User preferences
+router.register('config', views.UserConfigViewSet, basename='userconfig')
+
app_name = 'users-api'
urlpatterns = router.urls
diff --git a/netbox/users/api/views.py b/netbox/users/api/views.py
index b799bee19..7773e54f4 100644
--- a/netbox/users/api/views.py
+++ b/netbox/users/api/views.py
@@ -1,11 +1,15 @@
from django.contrib.auth.models import Group, User
from django.db.models import Count
+from rest_framework.permissions import IsAuthenticated
+from rest_framework.response import Response
from rest_framework.routers import APIRootView
+from rest_framework.viewsets import ViewSet
from netbox.api.views import ModelViewSet
from users import filters
-from users.models import ObjectPermission
+from users.models import ObjectPermission, UserConfig
from utilities.querysets import RestrictedQuerySet
+from utilities.utils import deepmerge
from . import serializers
@@ -41,3 +45,36 @@ class ObjectPermissionViewSet(ModelViewSet):
queryset = ObjectPermission.objects.prefetch_related('object_types', 'groups', 'users')
serializer_class = serializers.ObjectPermissionSerializer
filterset_class = filters.ObjectPermissionFilterSet
+
+
+#
+# User preferences
+#
+
+class UserConfigViewSet(ViewSet):
+ """
+ An API endpoint via which a user can update his or her own UserConfig data (but no one else's).
+ """
+ permission_classes = [IsAuthenticated]
+
+ def get_queryset(self):
+ return UserConfig.objects.filter(user=self.request.user)
+
+ def list(self, request):
+ """
+ Return the UserConfig for the currently authenticated User.
+ """
+ userconfig = self.get_queryset().first()
+
+ return Response(userconfig.data)
+
+ def patch(self, request):
+ """
+ Update the UserConfig for the currently authenticated User.
+ """
+ # TODO: How can we validate this data?
+ userconfig = self.get_queryset().first()
+ userconfig.data = deepmerge(userconfig.data, request.data)
+ userconfig.save()
+
+ return Response(userconfig.data)
diff --git a/netbox/users/tests/test_api.py b/netbox/users/tests/test_api.py
index c4229bff9..7530b1d2d 100644
--- a/netbox/users/tests/test_api.py
+++ b/netbox/users/tests/test_api.py
@@ -1,11 +1,10 @@
from django.contrib.auth.models import Group, User
from django.contrib.contenttypes.models import ContentType
-from django.test import override_settings
from django.urls import reverse
-from rest_framework import status
from users.models import ObjectPermission
-from utilities.testing import APIViewTestCases, APITestCase, disable_warnings
+from utilities.testing import APIViewTestCases, APITestCase
+from utilities.utils import deepmerge
class AppTest(APITestCase):
@@ -132,3 +131,56 @@ class ObjectPermissionTest(APIViewTestCases.APIViewTestCase):
'constraints': {'name': 'TEST6'},
},
]
+
+
+class UserConfigTest(APITestCase):
+
+ def test_get(self):
+ """
+ Retrieve user configuration via GET request.
+ """
+ userconfig = self.user.config
+ url = reverse('users-api:userconfig-list')
+
+ response = self.client.get(url, **self.header)
+ self.assertEqual(response.data, {})
+
+ data = {
+ "a": 123,
+ "b": 456,
+ "c": 789,
+ }
+ userconfig.data = data
+ userconfig.save()
+ response = self.client.get(url, **self.header)
+ self.assertEqual(response.data, data)
+
+ def test_patch(self):
+ """
+ Set user config via PATCH requests.
+ """
+ userconfig = self.user.config
+ url = reverse('users-api:userconfig-list')
+
+ data = {
+ "a": {
+ "a1": "X",
+ "a2": "Y",
+ },
+ "b": {
+ "b1": "Z",
+ }
+ }
+ response = self.client.patch(url, data=data, format='json', **self.header)
+ self.assertDictEqual(response.data, data)
+ userconfig.refresh_from_db()
+ self.assertDictEqual(userconfig.data, data)
+
+ update_data = {
+ "c": 123
+ }
+ response = self.client.patch(url, data=update_data, format='json', **self.header)
+ new_data = deepmerge(data, update_data)
+ self.assertDictEqual(response.data, new_data)
+ userconfig.refresh_from_db()
+ self.assertDictEqual(userconfig.data, new_data)
diff --git a/netbox/utilities/forms/forms.py b/netbox/utilities/forms/forms.py
index bc68f29f6..f259f6b6d 100644
--- a/netbox/utilities/forms/forms.py
+++ b/netbox/utilities/forms/forms.py
@@ -161,6 +161,7 @@ class TableConfigForm(BootstrapMixin, forms.Form):
"""
columns = forms.MultipleChoiceField(
choices=[],
+ required=False,
widget=forms.SelectMultiple(
attrs={'size': 10}
),
@@ -168,8 +169,14 @@ class TableConfigForm(BootstrapMixin, forms.Form):
)
def __init__(self, table, *args, **kwargs):
+ self.table = table
+
super().__init__(*args, **kwargs)
# Initialize columns field based on table attributes
self.fields['columns'].choices = table.configurable_columns
self.fields['columns'].initial = table.visible_columns
+
+ @property
+ def table_name(self):
+ return self.table.__class__.__name__
diff --git a/netbox/utilities/tables.py b/netbox/utilities/tables.py
index 5fd3a3a79..dfd175345 100644
--- a/netbox/utilities/tables.py
+++ b/netbox/utilities/tables.py
@@ -1,4 +1,5 @@
import django_tables2 as tables
+from django.contrib.auth.models import AnonymousUser
from django.contrib.contenttypes.fields import GenericForeignKey
from django.core.exceptions import FieldDoesNotExist
from django.db.models.fields.related import RelatedField
@@ -11,10 +12,11 @@ class BaseTable(tables.Table):
"""
Default table for object lists
- :param add_prefetch: By default, modify the queryset passed to the table upon initialization to automatically
- prefetch related data. Set this to False if it's necessary to avoid modifying the queryset (e.g. to
- accommodate PrefixQuerySet.annotate_depth()).
+ :param user: Personalize table display for the given user (optional). Has no effect if AnonymousUser is passed.
"""
+ # By default, modify the queryset passed to the table upon initialization to automatically prefetch related
+ # data. Set this to False if it's necessary to avoid modifying the queryset (e.g. to accommodate
+ # PrefixQuerySet.annotate_depth()).
add_prefetch = True
class Meta:
@@ -22,7 +24,7 @@ class BaseTable(tables.Table):
'class': 'table table-hover table-headings',
}
- def __init__(self, *args, columns=None, **kwargs):
+ def __init__(self, *args, user=None, **kwargs):
super().__init__(*args, **kwargs)
# Set default empty_text if none was provided
@@ -36,25 +38,27 @@ class BaseTable(tables.Table):
if column.name not in default_columns:
self.columns.hide(column.name)
- # Apply custom column ordering
- if columns is not None:
- pk = self.base_columns.pop('pk', None)
- actions = self.base_columns.pop('actions', None)
+ # Apply custom column ordering for user
+ if user is not None and not isinstance(user, AnonymousUser):
+ columns = user.config.get(f"tables.{self.__class__.__name__}.columns")
+ if columns:
+ pk = self.base_columns.pop('pk', None)
+ actions = self.base_columns.pop('actions', None)
- for name, column in self.base_columns.items():
- if name in columns:
- self.columns.show(name)
- else:
- self.columns.hide(name)
- self.sequence = [c for c in columns if c in self.base_columns]
+ for name, column in self.base_columns.items():
+ if name in columns:
+ self.columns.show(name)
+ else:
+ self.columns.hide(name)
+ self.sequence = [c for c in columns if c in self.base_columns]
- # Always include PK and actions column, if defined on the table
- if pk:
- self.base_columns['pk'] = pk
- self.sequence.insert(0, 'pk')
- if actions:
- self.base_columns['actions'] = actions
- self.sequence.append('actions')
+ # Always include PK and actions column, if defined on the table
+ if pk:
+ self.base_columns['pk'] = pk
+ self.sequence.insert(0, 'pk')
+ if actions:
+ self.base_columns['actions'] = actions
+ self.sequence.append('actions')
# Dynamically update the table's QuerySet to ensure related fields are pre-fetched
if self.add_prefetch and isinstance(self.data, TableQuerysetData):
diff --git a/netbox/utilities/templatetags/helpers.py b/netbox/utilities/templatetags/helpers.py
index 151ca99cb..f095af58f 100644
--- a/netbox/utilities/templatetags/helpers.py
+++ b/netbox/utilities/templatetags/helpers.py
@@ -10,6 +10,7 @@ from django.utils.html import strip_tags
from django.utils.safestring import mark_safe
from markdown import markdown
+from utilities.forms import TableConfigForm
from utilities.utils import foreground_color
register = template.Library()
@@ -261,3 +262,11 @@ def badge(value, show_empty=False):
'value': value,
'show_empty': show_empty,
}
+
+
+@register.inclusion_tag('utilities/templatetags/table_config_form.html')
+def table_config_form(table, table_name=None):
+ return {
+ 'table_name': table_name or table.__class__.__name__,
+ 'table_config_form': TableConfigForm(table=table),
+ }
diff --git a/netbox/utilities/views.py b/netbox/utilities/views.py
index f527aeeba..b6731491c 100644
--- a/netbox/utilities/views.py
+++ b/netbox/utilities/views.py
@@ -289,12 +289,8 @@ class ObjectListView(ObjectPermissionRequiredMixin, View):
perm_name = get_permission_for_model(model, action)
permissions[action] = request.user.has_perm(perm_name)
- # Construct the table based on the user's permissions
- if request.user.is_authenticated:
- columns = request.user.config.get(f"tables.{self.table.__name__}.columns")
- else:
- columns = None
- table = self.table(self.queryset, columns=columns)
+ # Construct the objects table
+ table = self.table(self.queryset, user=request.user)
if 'pk' in table.base_columns and (permissions['change'] or permissions['delete']):
table.columns.show('pk')
@@ -317,23 +313,6 @@ class ObjectListView(ObjectPermissionRequiredMixin, View):
return render(request, self.template_name, context)
- @method_decorator(login_required)
- def post(self, request):
-
- # Update the user's table configuration
- table = self.table(self.queryset)
- form = TableConfigForm(table=table, data=request.POST)
- preference_name = f"tables.{self.table.__name__}.columns"
-
- if form.is_valid():
- if 'set' in request.POST:
- request.user.config.set(preference_name, form.cleaned_data['columns'], commit=True)
- elif 'clear' in request.POST:
- request.user.config.clear(preference_name, commit=True)
- messages.success(request, "Your preferences have been updated.")
-
- return redirect(request.get_full_path())
-
def extra_context(self):
return {}