starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Jinja2 condition not working anymore in Custom Link URL field #8106

New Issue
Closed
opened 2025-12-29 20:32:31 +01:00 by adam · 3 comments
adam commented 2025-12-29 20:32:31 +01:00
Owner
Copy Link

Originally created by @tux-mania on GitHub (May 24, 2023).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.5.2

Python version

3.9

Steps to Reproduce

  1. Create a custom link with jinja2 condition in "Link URL" field. For example, I set a new Custom Link named "website" with the following on the Link URL field:
{% if object.tenant_id == 1 %}
https://www.google.com
{% else %}
https://www.duckduckgo.com
{% endif %}

Expected Behavior

According to my object tenant id, it should open a webpage on google.com or duduckgo.com when clicking on the custom link button.

Observed Behavior

Instead, I got the following error:
netbox_sanitize_url

This behaviour seems related to the feature "Sanitize rendered custom link HTML" #12205 .
In fact, when removing the code added in the commit 89fa546, the expected behavior happens.

Thank you for your help.

Originally created by @tux-mania on GitHub (May 24, 2023). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.5.2 ### Python version 3.9 ### Steps to Reproduce 1. Create a custom link with jinja2 condition in "Link URL" field. For example, I set a new Custom Link named "website" with the following on the Link URL field: ``` {% if object.tenant_id == 1 %} https://www.google.com {% else %} https://www.duckduckgo.com {% endif %} ``` ### Expected Behavior According to my object tenant id, it should open a webpage on google.com or duduckgo.com when clicking on the custom link button. ### Observed Behavior Instead, I got the following error: ![netbox_sanitize_url](https://github.com/netbox-community/netbox/assets/57258906/cfac89b3-8b1a-4770-abec-c99a3cffc9ef) This behaviour seems related to the feature "Sanitize rendered custom link HTML" #12205 . In fact, when removing the code added in the commit [89fa546](https://github.com/netbox-community/netbox/commit/89fa546a1481e56d14cfc4d666a55482b0c85fd1), the expected behavior happens. Thank you for your help.
adam added the type: bugstatus: accepted labels 2025-12-29 20:32:31 +01:00
adam closed this issue 2025-12-29 20:32:31 +01:00
adam commented 2025-12-29 20:32:31 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (May 24, 2023):

The issue is that the rendered template produces errant line breaks before and after the URL (the %0A characters). We can tweak the code to tweak leading & trailing whitespace from the rendered template, but in the meantime I suggest altering your Jinja code to do this natively by adding hyphens to the block markers:

{% if object.tenant_id == 1 -%}
https://www.google.com
{%- else -%}
https://www.duckduckgo.com
{%- endif %}
@jeremystretch commented on GitHub (May 24, 2023): The issue is that the rendered template produces errant line breaks before and after the URL (the `%0A` characters). We can tweak the code to tweak leading & trailing whitespace from the rendered template, but in the meantime I suggest altering your Jinja code to [do this natively](https://jinja.palletsprojects.com/en/3.1.x/templates/#whitespace-control) by adding hyphens to the block markers: ``` {% if object.tenant_id == 1 -%} https://www.google.com {%- else -%} https://www.duckduckgo.com {%- endif %} ```
adam commented 2025-12-29 20:32:32 +01:00
Author
Owner
Copy Link

@tux-mania commented on GitHub (May 24, 2023):

Hello @jeremystretch !
I didn't know about the hyphens. Works perfectly fine with this modification.
Thank you very much!

@tux-mania commented on GitHub (May 24, 2023): Hello @jeremystretch ! I didn't know about the hyphens. Works perfectly fine with this modification. Thank you very much!
adam commented 2025-12-29 20:32:32 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (May 24, 2023):

Glad that worked out, but I'd still like to strip whitespace from the rendered template to help avoid this issue.

@jeremystretch commented on GitHub (May 24, 2023): Glad that worked out, but I'd still like to strip whitespace from the rendered template to help avoid this issue.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#8106
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?