Make permissions available in PluginTemplateExtension #3696

New Issue

adam · 2025-12-29T18:30:39+01:00

adam commented

2025-12-29 18:30:39 +01:00

Originally created by @steffann on GitHub (May 16, 2020).

Originally assigned to: @steffann on GitHub.

Environment

Python version: 3.7.6
NetBox version: 2.8.4

Proposed Functionality

Currently each PluginTemplateExtension is provided a context containing object, requests, settings and config. I propose to add a method for checking permissions to the default context.

Use Case

Writers of plugins may want to check whether the current user has certain permissions to only show certain information based on that and to only provide edit/delete links to those that are allowed to do so.

A work-around is to make perms available is:

from django.contrib.auth.context_processors import PermWrapper

def left_page(self):
   context = {
       'perms': PermWrapper(self.context['request'].user),
   }
   return self.render('pluginname/test.html', context)

My feeling is that this shouldn't be necessary and that NetBox should provide a method to check permissions by default.

Considering the work being done on #554 I suggest leaving this feature request until that work has been completed. Otherwise we would very quickly end up with having to provide multiple ways to check permissions. Let's standardise on something that supports #554 style permissions.

Database Changes

None

External Dependencies

None

Originally created by @steffann on GitHub (May 16, 2020). Originally assigned to: @steffann on GitHub. ### Environment * Python version: 3.7.6 * NetBox version: 2.8.4 ### Proposed Functionality Currently each `PluginTemplateExtension` is provided a context containing `object`, `requests`, `settings` and `config`. I propose to add a method for checking permissions to the default context. ### Use Case Writers of plugins may want to check whether the current user has certain permissions to only show certain information based on that and to only provide edit/delete links to those that are allowed to do so. A work-around is to make `perms` available is: ``` from django.contrib.auth.context_processors import PermWrapper def left_page(self): context = { 'perms': PermWrapper(self.context['request'].user), } return self.render('pluginname/test.html', context) ``` My feeling is that this shouldn't be necessary and that NetBox should provide a method to check permissions by default. Considering the work being done on #554 I suggest leaving this feature request until that work has been completed. Otherwise we would very quickly end up with having to provide multiple ways to check permissions. Let's standardise on something that supports #554 style permissions. ### Database Changes None ### External Dependencies None

adam added the status: accepted label 2025-12-29 18:30:39 +01:00

adam closed this issue

2025-12-29 18:30:39 +01:00

adam commented

2025-12-29 18:30:40 +01:00

@jeremystretch commented on GitHub (May 20, 2020):

I'd say I'm about 90% sure at this point that #554 will preserve the current behavior of the built-in perms context variable. Let's move ahead with this assumption, and if things do change, I'll make the necessary adjustments at a later point.

@jeremystretch commented on GitHub (May 20, 2020): I'd say I'm about 90% sure at this point that #554 will preserve the current behavior of the built-in `perms` context variable. Let's move ahead with this assumption, and if things do change, I'll make the necessary adjustments at a later point.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#3696