nautobot 2.2.9__py3-none-any.whl → 2.3.0b1__py3-none-any.whl

nautobot/core/templates/utilities/templatetags/saved_view_modal.html

@@ -0,0 +1,38 @@
+{% load helpers %}
+{% load form_helpers %}
+
+<div class="modal fade" tabindex="-1" id="saved_view_modal">
+    <div class="modal-dialog modal-lg">
+        <div class="modal-content">
+            <div class="modal-header">
+                <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
+                <h4 class="modal-title">New Saved View</h4>
+            </div>
+            <form action="{% url 'extras:savedview_add' %}" method="post">
+                <div class="modal-body">
+                    {% csrf_token %}
+                    <div class="form-group">
+                        {% render_field form.name %}
+                        <div class="form-group">
+                            <label class="col-md-3 control-label" for="id_config">New Changes</label>
+                            <div class="col-md-9">
+                                <pre><code class="language-json">{{ param_dict }}</code></pre>
+                            </div>
+                        </div>
+                        {% render_field form.is_shared %}
+                        <input type="hidden" id="view" name="view" value="{{view}}">
+                        <input type="hidden" id="params" name="params" value="{{params}}">
+                    </div>
+                </div>
+                <div class="modal-footer">
+                    <button type="submit" class="btn btn-primary">
+                        <span class="mdi mdi-content-save-plus-outline" aria-hidden="true"></span> Save
+                    </button>
+                    <button class="btn btn-default" data-dismiss="modal">
+                        <span class="mdi mdi-close-thick" aria-hidden="true"></span> Cancel
+                    </button>
+                </div>
+            </form>
+        </div>
+    </div>
+</div>

nautobot/core/templates/utilities/theme_preview.html

@@ -41,9 +41,28 @@
 <div class="pull-right noprint">
     <button type="button" class="btn btn-default"><i class="mdi mdi-cog"></i> Configure</button>
     <button type="button" class="btn btn-default"><i class="mdi mdi-filter"></i> Filter</button>
-    {% add_button content_type.model_class|validated_viewname:"add" %}
-    {% job_import_button content_type %}
-    {% export_button content_type %}
+    <div class="btn-group">
+        {% add_button content_type.model_class|validated_viewname:"add" %}
+        <button type="button" class="btn btn-primary dropdown-toggle" data-toggle="dropdown">
+            <span class="caret"></span>
+            <span class="sr-only">Toggle Dropdown</span>
+        </button>
+        <ul class="dropdown-menu pull-right" role="menu">
+            {% job_import_button content_type list_element=True%}
+            <li class="divider"></li>
+            {% export_button content_type list_element=True %}
+        </ul>
+    </div>
+    <div class="btn-group">
+        <button type="button" class="btn btn-primary dropdown-toggle" data-toggle="dropdown">
+            Actions <span class="caret"></span>
+        </button>
+        <ul class="dropdown-menu pull-right" role="menu">
+            {% job_import_button content_type list_element=True%}
+            <li class="divider"></li>
+            {% export_button content_type list_element=True %}
+        </ul>
+    </div>
 </div>
 <h1>Object Listing</h1>
 <div class="row">
@@ -74,8 +93,8 @@
                     <li><a><i class="mdi mdi-chevron-double-right"></i></a></li>
                 </ul>
             </nav>
-            <form>
-                <select name="per_page" id="per_page">
+            <form class="form-inline">
+                <select name="per_page" id="per_page" class="form-control">
                     <option value="25" selected="selected">25</option>
                     <option value="50">50</option>
                     <option value="100">100</option>
@@ -115,9 +134,7 @@
 </div>
 
 <div class="pull-right noprint">
-    {% clone_button object %}
-    {% edit_button object %}
-    {% delete_button object %}
+    {% consolidate_detail_view_action_buttons %}
 </div>
 <h1>
     <span class="hover_copy">

nautobot/core/templates/utilities/worker_status.html

@@ -0,0 +1,152 @@
+{% extends 'base.html' %}
+{% load helpers %}
+
+{% block extra_styles %}
+<style>
+    .panel {
+        overflow: hidden  /* Fix for panel overflow issues */
+    }
+</style>
+{% endblock %}
+
+{% block header %}
+<h1>
+    {% block title %}Nautobot Worker Status{% endblock %}
+</h1>
+{% endblock %}
+
+{% block content %}
+<div class="row">
+    <div class="col-md-12">
+        <div class="panel panel-default">
+            <div class="panel-heading">
+                <strong>Worker Queues</strong>
+            </div>
+            <table class="table table-hover panel-body attr-table">
+                {% for queue_name, workers in worker_status.queue_worker_count.items %}
+                    <tr>
+                        <td><span class="label label-primary">{{ queue_name }}</span></td>
+                        <td>
+                            {% for worker in workers %}
+                                <span class="label label-default">{{ worker }}</span>
+                            {% empty %}
+                                No workers found.
+                            {% endfor %}
+                        </td>
+                    </tr>
+                {% endfor %}
+            </table>
+        </div>
+    </div>
+    {% for worker in worker_status.workers %}
+        <div class="col-md-6">
+            <div class="panel panel-default">
+                <div class="panel-heading">
+                    <strong>{{ worker.hostname }}</strong>
+                </div>
+                <table id="accordion" class="table table-hover panel-body attr-table">
+                    <tbody>
+                        <tr>
+                            <td>Uptime</td>
+                            <td colspan="2">{{ worker.uptime|render_uptime }}</td>
+                        </tr>
+                        <tr>
+                            <td>Queues</td>
+                            <td colspan="2">
+                                {% for queue in worker.queues %}
+                                    <span class="label label-primary">{{ queue }}</span>
+                                {% endfor %}
+                            </td>
+                        </tr>
+                        <tr>
+                            <th colspan="{{ worker.running_tasks_table.columns|length }}">
+                                <button type="button" class="btn-link accordion-toggle mdi mdi-chevron-right"
+                                        name="running-tasks-{{ worker.hostname|slugify }}" data-toggle="collapse"
+                                        data-target=".collapseme-running-tasks-{{ worker.hostname|slugify }}">
+                                    Running Tasks {% badge worker.running_tasks_table.rows|length show_empty=True %}
+                                </button>
+                            </th>
+                        </tr>
+                    </tbody>
+                    <tbody class="collapseme-running-tasks-{{ worker.hostname|slugify }} collapse" data-parent="#accordion" aria-expanded="false">
+                        <tr>
+                            {% for column in worker.running_tasks_table.columns %}
+                                <th {{ column.attrs.th.as_html }}>{{ column.header }}</th>
+                            {% endfor %}
+                        </tr>
+                        {% for row in worker.running_tasks_table.page.object_list|default:worker.running_tasks_table.rows %}
+                            <tr {{ row.attrs.as_html }}>
+                                {% for column, cell in row.items %}
+                                    <td {{ column.attrs.td.as_html }}>{{ cell }}</td>
+                                {% endfor %}
+                            </tr>
+                        {% empty %}
+                            {% if worker.running_tasks_table.empty_text %}
+                                <tr>
+                                    <td colspan="{{ worker.running_tasks_table.columns|length }}" class="text-center text-muted">
+                                        &mdash; {{ worker.running_tasks_table.empty_text }} &mdash;
+                                    </td>
+                                </tr>
+                            {% endif %}
+                        {% endfor %}
+                    </tbody>
+                    <tbody>
+                        <tr>
+                            <th colspan="{{ worker.pending_tasks_table.columns|length }}">
+                                <button type="button" class="btn-link accordion-toggle mdi mdi-chevron-right"
+                                        name="pending-tasks-{{ worker.hostname|slugify }}" data-toggle="collapse"
+                                        data-target=".collapseme-pending-tasks-{{ worker.hostname|slugify }}">
+                                    Pending Tasks {% badge worker.pending_tasks_table.rows|length show_empty=True %}
+                                </button>
+                            </th>
+                        </tr>
+                    </tbody>
+                    <tbody class="collapseme-pending-tasks-{{ worker.hostname|slugify }} collapse" data-parent="#accordion" aria-expanded="false">
+                        <tr>
+                            {% for column in worker.pending_tasks_table.columns %}
+                                <th {{ column.attrs.th.as_html }}>{{ column.header }}</th>
+                            {% endfor %}
+                        </tr>
+                        {% for row in worker.pending_tasks_table.page.object_list|default:worker.pending_tasks_table.rows %}
+                            <tr {{ row.attrs.as_html }}>
+                                {% for column, cell in row.items %}
+                                    <td {{ column.attrs.td.as_html }}>{{ cell }}</td>
+                                {% endfor %}
+                            </tr>
+                        {% empty %}
+                            {% if worker.pending_tasks_table.empty_text %}
+                                <tr>
+                                    <td colspan="{{ worker.pending_tasks_table.columns|length }}" class="text-center text-muted">
+                                        &mdash; {{ worker.pending_tasks_table.empty_text }} &mdash;
+                                    </td>
+                                </tr>
+                            {% endif %}
+                        {% endfor %}
+                    </tbody>
+                </table>
+            </div>
+        </div>
+    {% empty %}
+        </div>
+        <div class="alert alert-warning">
+            {% with increased_timeout=worker_status.timeout|add:5 %}
+                <strong>Warning:</strong> No workers responded within the {{ worker_status.timeout }} second timeout.
+                {% if increased_timeout <= worker_status.max_timeout %}
+                    <a href="{{ request.path }}?timeout={{ increased_timeout }}">Retry with a {{ increased_timeout }} second timeout</a>.
+                {% else %}
+                    <a href="{{ request.get_full_path }}">Retry</a>.
+                {% endif %}
+            {% endwith %}
+    {% endfor %}
+</div>
+{% endblock %}
+
+{% block javascript %}
+{{ block.super }}
+<script>
+    // Toggle v -. >
+    $("#accordion .accordion-toggle").click(function() {
+        $(this).toggleClass("mdi-chevron-down mdi-chevron-right");
+    });
+</script>
+{% endblock %}

nautobot/core/templatetags/buttons.py

@@ -1,6 +1,9 @@
 from django import template
 from django.urls import NoReverseMatch, reverse
+from django.utils.html import format_html, format_html_join
 
+from nautobot.core.templatetags.helpers import bettertitle
+from nautobot.core.templatetags.perms import can_add, can_change, can_delete
 from nautobot.core.utils import lookup
 from nautobot.core.views import utils as views_utils
 from nautobot.extras import models
@@ -13,11 +16,43 @@ register = template.Library()
 #
 
 
+@register.simple_tag()
+def action_url(instance, action):
+    """
+    URL to the <action> view for the instance.
+
+    Helper to `edit_button`, `delete_button` and `consolidated_detail_view_action_buttons` tags,
+    but can be used separately if needed.
+
+    Args:
+        instance (BaseModel): Model record.
+        action (str): Action (add/edit/delete) to link to.
+    """
+    viewname = lookup.get_route_for_model(instance, action)
+    if action == "add":
+        try:
+            return reverse(viewname)
+        except NoReverseMatch:
+            return None
+
+    # We try different lookups to get a valid reverse url
+    lookup_keys = ["pk", "slug", "key"]
+
+    for lookup_key in lookup_keys:
+        if hasattr(instance, lookup_key):
+            kwargs = {lookup_key: getattr(instance, lookup_key)}
+            try:
+                return reverse(viewname, kwargs=kwargs)
+            except NoReverseMatch:
+                continue
+
+    return None
+
+
 @register.inclusion_tag("buttons/clone.html")
 def clone_button(instance):
-    try:
-        url = reverse(lookup.get_route_for_model(instance, "add"))
-    except NoReverseMatch:
+    url = action_url(instance, "add")
+    if not url:
         return {"url": None}
 
     # Populate cloned field values
@@ -40,21 +75,7 @@ def edit_button(instance, use_pk=False, key="slug"):
         use_pk (bool): Used for backwards compatibility, no-op in this function.
         key (str): Used for backwards compatibility, no-op in this function.
     """
-    viewname = lookup.get_route_for_model(instance, "edit")
-
-    # We try different lookups to get a valid reverse url
-    lookup_keys = ["pk", "slug", "key"]
-
-    for lookup_key in lookup_keys:
-        if hasattr(instance, lookup_key):
-            kwargs = {lookup_key: getattr(instance, lookup_key)}
-            try:
-                url = reverse(viewname, kwargs=kwargs)
-                return {"url": url}
-            except NoReverseMatch:
-                continue
-
-    return {"url": None}
+    return {"url": action_url(instance, "edit")}
 
 
 @register.inclusion_tag("buttons/delete.html")
@@ -67,21 +88,7 @@ def delete_button(instance, use_pk=False, key="slug"):
         use_pk (bool): Used for backwards compatibility, no-op in this function.
         key (str): Used for backwards compatibility, no-op in this function.
     """
-    viewname = lookup.get_route_for_model(instance, "delete")
-
-    # We try different lookups to get a valid reverse url
-    lookup_keys = ["pk", "slug", "key"]
-
-    for lookup_key in lookup_keys:
-        if hasattr(instance, lookup_key):
-            kwargs = {lookup_key: getattr(instance, lookup_key)}
-            try:
-                url = reverse(viewname, kwargs=kwargs)
-                return {"url": url}
-            except NoReverseMatch:
-                continue
-
-    return {"url": None}
+    return {"url": action_url(instance, "delete")}
 
 
 #
@@ -90,14 +97,24 @@ def delete_button(instance, use_pk=False, key="slug"):
 
 
 @register.inclusion_tag("buttons/add.html")
-def add_button(url):
+def add_button(url, verbose_name=None, list_element=False):
+    """Display an Add Button/List Element on the page.
+
+    This allows an Add Button to either be displayed on a page or within a Button Group.
+    Args:
+        url (str): URL for the object's create page.
+        verbose_name (str, optional): Append the verbose_name to the button text.
+        list_element (bool, optional): Render as a <li> element instead of a button. Defaults to False.
+    """
     try:
         url = reverse(url)
     except NoReverseMatch:
-        return {"add_url": None}
+        return {"add_url": None, "list_element": list_element, "verbose_name": verbose_name}
 
     return {
         "add_url": url,
+        "list_element": list_element,
+        "verbose_name": verbose_name,
     }
 
 
@@ -124,9 +141,281 @@ def job_import_url(content_type):
     return import_url
 
 
+def render_tag_attrs(attrs_dict):
+    """Converts tag attributes from a dictionary to a string format suitable for HTML rendering."""
+    return format_html_join(" ", '{}="{}"', list(attrs_dict.items()))
+
+
+@register.inclusion_tag("buttons/consolidated_bulk_action_buttons.html", takes_context=True)
+def consolidate_bulk_action_buttons(context):
+    """
+    Generates a list of action buttons for bulk operations (edit, update group assignment, delete) based on the
+    model capabilities and user permissions.
+
+    Context must include the following keys:
+        request (HttpRequest): The HTTP request object.
+        model (Model): The model class for the list view.
+        user (User): The current user.
+        bulk_edit_url (str): The URL for the bulk edit action.
+        bulk_delete_url (str): The URL for the bulk delete action.
+        permissions (dict): A dictionary of specific permissions for the view.
+    """
+
+    bulk_action_buttons = []
+
+    render_edit_button = bool(context["bulk_edit_url"] and context["permissions"]["change"])
+    render_static_group_assign_button = bool(
+        context["model"].is_dynamic_group_associable_model
+        and context["user"].has_perms(["extras.add_staticgroupassociation"])
+    )
+    render_delete_button = bool(context["bulk_delete_url"] and context["permissions"]["delete"])
+    bulk_action_button_count = sum([render_edit_button, render_static_group_assign_button, render_delete_button])
+
+    if bulk_action_button_count == 0:
+        return {
+            "bulk_action_buttons": bulk_action_buttons,
+        }
+
+    params = ("?" + context["request"].GET.urlencode()) if context["request"].GET else ""
+
+    primary_button_fragment = child_button_fragment = """
+        <button {attrs}>
+            <span class="{icon}" aria-hidden="true"></span> {label}
+        </button>
+    """
+
+    edit_button_classes = "btn btn-sm btn-warning"
+    delete_button_classes = "btn btn-sm btn-danger"
+    static_group_button_classes = "btn btn-sm btn-primary"
+    static_group_icon = "mdi mdi-group"
+
+    if bulk_action_button_count > 1:
+        child_button_fragment = f"<li>{primary_button_fragment}</li>"
+        delete_button_classes = "text-danger"
+        static_group_button_classes = "text"
+        static_group_icon += " text-muted"
+
+    if render_edit_button:
+        bulk_action_buttons.append(
+            format_html(
+                primary_button_fragment,
+                label="Edit Selected",
+                attrs=render_tag_attrs(
+                    {
+                        "class": edit_button_classes,
+                        "formaction": reverse(context["bulk_edit_url"]) + params,
+                        "type": "submit",
+                    }
+                ),
+                icon="mdi mdi-pencil",
+            ),
+        )
+        if bulk_action_button_count > 1:
+            bulk_action_buttons[0] += format_html(
+                f"""
+                <button type="button" data-toggle="dropdown" class="{edit_button_classes} dropdown-toggle" aria-haspopup="true">
+                    <span class="caret"></span>
+                    <span class="sr-only">Toggle Dropdown</span>
+                </button>
+                """
+            )
+
+    # Render a generic "Bulk Actions" dropup button if the edit button is not present
+    elif bulk_action_button_count > 1:
+        bulk_action_buttons.append(
+            format_html(
+                """
+                <button type="button" class="btn btn-sm btn-primary dropdown-toggle" data-toggle="dropdown" aria-haspopup="true">
+                    Bulk Actions <span class="caret"></span>
+                </button>
+                """
+            )
+        )
+
+    if render_delete_button:
+        bulk_action_buttons.append(
+            format_html(
+                child_button_fragment,
+                label="Delete Selected",
+                attrs=render_tag_attrs(
+                    {
+                        "class": delete_button_classes,
+                        "type": "submit",
+                        "name": "_delete",
+                        "formaction": reverse(context["bulk_delete_url"]) + params,
+                    }
+                ),
+                icon="mdi mdi-trash-can-outline",
+            )
+        )
+
+    if render_delete_button and render_static_group_assign_button:
+        bulk_action_buttons.append(format_html('<li role="separator" class="divider"></li>'))
+
+    if render_static_group_assign_button:
+        bulk_action_buttons.append(
+            format_html(
+                child_button_fragment,
+                label="Update Group Assignment",
+                attrs=render_tag_attrs(
+                    {
+                        "class": static_group_button_classes,
+                        "id": "update_dynamic_groups_for_selected",
+                        "data-toggle": "modal",
+                        "data-target": "#dynamic_group_assignment_modal",
+                        "data-objects": "selected",
+                        "type": "button",
+                    }
+                ),
+                icon=static_group_icon,
+            )
+        )
+
+    return {
+        "bulk_action_buttons": bulk_action_buttons,
+    }
+
+
+@register.inclusion_tag("buttons/consolidated_detail_view_action_buttons.html", takes_context=True)
+def consolidate_detail_view_action_buttons(context):
+    """
+    Generates a list of action buttons for detail view operations (edit, clone, delete) based on the
+    model capabilities and user permissions.
+
+    Context must include the following keys:
+        request (HttpRequest): The HTTP request object.
+        object (Model): The object in the detail view.
+        user (User): The current user.
+    """
+    instance = context["object"]
+    detail_view_action_buttons = []
+    object_edit_url = action_url(instance, "edit")
+    object_delete_url = action_url(instance, "delete")
+    object_clone_url = action_url(instance, "add")
+    render_edit_button = bool(object_edit_url and can_change(context["user"], instance))
+    render_delete_button = bool(object_delete_url and can_delete(context["user"], instance))
+    render_clone_button = bool(
+        hasattr(instance, "clone_fields") and object_clone_url and can_add(context["user"], instance)
+    )
+
+    detail_view_action_button_count = sum([render_edit_button, render_delete_button, render_clone_button])
+
+    if detail_view_action_button_count == 0:
+        return {
+            "detail_view_action_buttons": detail_view_action_buttons,
+        }
+
+    child_button_fragment = primary_button_fragment = """
+        <a {attrs}>
+            <span class="{icon}" aria-hidden="true"></span> {label}
+        </a>
+    """
+
+    delete_button_fragment = """
+        <button class="{button_class}">
+            <a {attrs}>
+                <span class="{icon}" aria-hidden="true"></span> {label}
+            </a>
+        </button>
+    """
+
+    edit_button_classes = "btn btn-warning"
+    delete_button_classes = "text-danger"
+    clone_button_classes = "text"
+    clone_icon = "mdi mdi-plus-thick text-muted"
+    child_button_fragment = f"<li>{primary_button_fragment}</li>"
+    delete_button_fragment = f"<li>{delete_button_fragment}</li>"
+
+    if render_edit_button:
+        detail_view_action_buttons.append(
+            format_html(
+                primary_button_fragment,
+                label=f"Edit {bettertitle(context['verbose_name'])}",
+                attrs=render_tag_attrs(
+                    {
+                        "id": "edit-button",
+                        "class": edit_button_classes,
+                        "href": object_edit_url,
+                    }
+                ),
+                button_class=edit_button_classes,
+                icon="mdi mdi-pencil",
+            ),
+        )
+        if detail_view_action_button_count > 1:
+            detail_view_action_buttons[0] += format_html(
+                f"""
+                <button type="button" id="actions-dropdown" data-toggle="dropdown" class="{edit_button_classes} dropdown-toggle">
+                    <span class="caret"></span>
+                    <span class="sr-only">Toggle Dropdown</span>
+                </button>
+                """
+            )
+
+    # Render a generic "Actions" dropdown button if the edit button is not present
+    elif detail_view_action_button_count >= 1:
+        detail_view_action_buttons.append(
+            format_html(
+                """
+                <button type="button" id="actions-dropdown" class="btn btn-warning dropdown-toggle" data-toggle="dropdown">
+                    Actions <span class="caret"></span>
+                </button>
+                """
+            )
+        )
+    if render_clone_button:
+        param_string = views_utils.prepare_cloned_fields(instance)
+        if param_string:
+            object_clone_url = f"{object_clone_url}?{param_string}"
+        detail_view_action_buttons.append(
+            format_html(
+                child_button_fragment,
+                label=f"Clone {bettertitle(context['verbose_name'])}",
+                attrs=render_tag_attrs(
+                    {
+                        "id": "clone-button",
+                        "class": clone_button_classes,
+                        "href": object_clone_url,
+                    }
+                ),
+                icon=clone_icon,
+                button_class=clone_button_classes,
+            )
+        )
+    if render_delete_button:
+        if render_clone_button:
+            detail_view_action_buttons.append(format_html('<li role="separator" class="divider"></li>'))
+        detail_view_action_buttons.append(
+            format_html(
+                delete_button_fragment,
+                label=f"Delete {bettertitle(context['verbose_name'])}",
+                attrs=render_tag_attrs(
+                    {
+                        "id": "delete-button",
+                        "class": delete_button_classes,
+                        "href": object_delete_url,
+                    }
+                ),
+                icon="mdi mdi-trash-can-outline",
+                button_class=delete_button_classes,
+            )
+        )
+
+    return {
+        "detail_view_action_buttons": detail_view_action_buttons,
+    }
+
+
 @register.inclusion_tag("buttons/job_import.html")
-def job_import_button(content_type):
-    return {"import_url": job_import_url(content_type)}
+def job_import_button(content_type, list_element=False):
+    """Display an Import Button/List Element on the page.
+
+    This allows an Import Button to either be displayed on a page or within a Button Group.
+    Args:
+        content_type (str): Django.contrib.ContentType for the model.
+        list_element (bool, optional): Render as a <li> element instead of a button. Defaults to False.
+    """
+    return {"import_url": job_import_url(content_type), "list_element": list_element}
 
 
 @register.simple_tag
@@ -146,7 +435,14 @@ def job_export_url():
 
 
 @register.inclusion_tag("buttons/export.html", takes_context=True)
-def export_button(context, content_type=None):
+def export_button(context, content_type=None, list_element=False):
+    """Display an Export Button/List Element on the page.
+
+    Args:
+        context (dict): current Django Template context
+        content_type (content_type, optional): Django Content Type for the model. Defaults to None.
+        list_element (bool, optional): Render as a <li> element instead of a button. Defaults to False.
+    """
     if content_type is not None:
         user = context["request"].user
         export_templates = models.ExportTemplate.objects.restrict(user, "view").filter(content_type=content_type)
@@ -163,4 +459,5 @@ def export_button(context, content_type=None):
         "content_type": content_type,
         "export_templates": export_templates,
         "include_yaml_option": include_yaml_option,
+        "list_element": list_element,
     }