diff --git a/README.rst b/README.rst index bebedfc3..34706881 100644 --- a/README.rst +++ b/README.rst @@ -285,10 +285,10 @@ Sorting method can be changed under the ``[howitz]``-section by adding:: Valid sorting methods are: -* *raw* - Unchanged order in which Zino server sends events (by ID ascending). +* *raw* - The same order in which Zino server sends events (by ID, ascending). * *lasttrans* - Newest transaction first, all IGNORED at the bottom. Default sorting in curitz. -* *severity* - Events of same color grouped together. The most severe (red) at the top and ignored at the bottom. Existing method in Ritz TK, but it is called 'default' there. +* *severity* - Events with highest priority first, grouped by event type. Priority takes into account both whether event signifies any disturbance, event's administrative phase and event's type, so there might not be continuous blocks of color. Existing method in Ritz TK, but it is called 'default' there. * *down-rev* - Shortest/none downtime first. Identical to an existing method in Ritz TK. * *down* - Longest downtime first. Identical to an existing method in Ritz TK. * *upd-rev* - Events with the most recent update date first. Identical to an existing method in Ritz TK. diff --git a/src/howitz/config/models.py b/src/howitz/config/models.py index ed65a2a7..73ac3885 100644 --- a/src/howitz/config/models.py +++ b/src/howitz/config/models.py @@ -29,11 +29,11 @@ class HowitzConfig(ServerConfig, StorageConfig): devmode: bool = Literal[False] refresh_interval: int = 5 timezone: str = DEFAULT_TIMEZONE - sort_by: str = EventSort.DEFAULT + sort_by: str = str(EventSort.DEFAULT) class DevHowitzConfig(DevServerConfig, DevStorageConfig): devmode: bool = Literal[True] refresh_interval: int = 5 timezone: str = DEFAULT_TIMEZONE - sort_by: str = EventSort.DEFAULT + sort_by: str = str(EventSort.DEFAULT) diff --git a/src/howitz/endpoints.py b/src/howitz/endpoints.py index 04277930..128c4822 100644 --- a/src/howitz/endpoints.py +++ b/src/howitz/endpoints.py @@ -42,25 +42,29 @@ class EventColor(StrEnum): # Inspired by https://stackoverflow.com/a/54732120 class EventSort(Enum): - AGE = "age", "opened", True # Newest events first - AGE_REV = "age-rev", "opened", False # Oldest events first - UPD = "upd", "updated", False # Events with the oldest update date first - UPD_REV = "upd-rev", "updated", True # Events with the most recent update date first - DOWN = "down", "get_downtime", True # Longest downtime first - DOWN_REV = "down-rev", "get_downtime", False # Shortest/none downtime first - - LASTTRANS = "lasttrans", "updated", True # Newest transaction first, all IGNORED at the bottom. Default sorting at SSC - SEVERITY = "severity", "", True # Events of same color grouped together. The most severe (red) at the top and ignored at the bottom - DEFAULT = "raw", "", None # Unchanged order in which Zino server sends events (by ID ascending) + # Name, relevant event attribute, is_reversed, displayed name, description + AGE = "age", "opened", True, "Age", "Newest events first" + AGE_REV = "age-rev", "opened", False, "Age reversed", "Oldest events first" + UPD = "upd", "updated", False, "Activity", "Events with the oldest update date first" + UPD_REV = "upd-rev", "updated", True, "Activity reversed", "Events with the most recent update date first" + DOWN = "down", "get_downtime", True, "Downtime", "Events with longest downtime first" + DOWN_REV = "down-rev", "get_downtime", False, "Downtime reversed", "Events with shortest/none downtime first" + + LASTTRANS = ("lasttrans", "updated", True, "Last transaction", + "Events with the most recent update date first, all IGNORED events are at the bottom") + SEVERITY = "severity", "", True, "Severity", "Events with highest priority first, grouped by event type. Priority takes into account both whether event signifies any disturbance, event's administrative phase and event's type, so there might not be continuous blocks of color" + DEFAULT = "raw", "", None, "Raw", "The same order in which Zino server sends events (by ID, ascending)" def __new__(cls, *args, **kwds): obj = object.__new__(cls) obj._value_ = args[0] return obj - def __init__(self, _: str, attribute: str = None, reversed: bool = None): + def __init__(self, _: str, attribute: str = None, reversed: bool = None, display_name: str = None, description: str = None): self._attribute = attribute self._reversed = reversed + self._display_name = display_name + self._description = description def __str__(self): return self.value @@ -73,6 +77,14 @@ def attribute(self): def reversed(self): return self._reversed + @property + def display_name(self): + return self._display_name + + @property + def description(self): + return self._description + def auth_handler(username, password): # check user credentials in database @@ -91,7 +103,7 @@ def auth_handler(username, password): session["expanded_events"] = {} session["errors"] = {} session["event_ids"] = [] - session["sort_by"] = current_app.howitz_config.get("sort_by", "default") + session["sort_by"] = current_app.howitz_config.get("sort_by", "raw") session["events_last_refreshed"] = None return user @@ -758,6 +770,28 @@ def clear_flapping(i): raise MethodNotAllowed(description='Cant clear flapping on a non-port event.') +@main.route('/events/table/change_sort_by', methods=['GET', 'POST']) +def change_events_order(): + if request.method == 'POST': + # Get new sort method from the request + new_sort = request.form['sort-method'] + session["sort_by"] = new_sort + session.modified = True + + # Rerender whole events table + events = current_app.cache.get("events") + if events: + table_events = get_sorted_table_event_list(events) + else: + table_events = get_current_events() + + return render_template('/responses/resort-events.html', event_list=table_events) + + elif request.method == 'GET': + return render_template('/components/popups/modals/forms/sort-table-form.html', sort_methods=EventSort, + current_sort=EventSort(session["sort_by"])) + + @main.route('/navbar/show-user-menu', methods=["GET"]) def show_user_menu(): return render_template('/responses/show-user-menu.html') diff --git a/src/howitz/templates/components/popups/modals/forms/sort-table-form.html b/src/howitz/templates/components/popups/modals/forms/sort-table-form.html new file mode 100644 index 00000000..6bd3f8a1 --- /dev/null +++ b/src/howitz/templates/components/popups/modals/forms/sort-table-form.html @@ -0,0 +1,45 @@ +
+
+
+
+ Change the order in which events are displayed in the + table + +

Sort events by:

+
+ {% for sort in sort_methods %} +
+
+ +
+
+ +

{{ sort.description }}

+
+
+ {% endfor %} +
+
+
+
+ +
+ + +

+ Updating events order... +

+
+
diff --git a/src/howitz/templates/components/popups/modals/table-operation-modal.html b/src/howitz/templates/components/popups/modals/table-operation-modal.html index f39c2f08..b5332225 100644 --- a/src/howitz/templates/components/popups/modals/table-operation-modal.html +++ b/src/howitz/templates/components/popups/modals/table-operation-modal.html @@ -4,6 +4,7 @@ role="dialog" aria-modal="true" hx-target-error="body" + hx-swap-oob="true" > -
- {% if path_to_content %} - {% include path_to_content %} - {% else %} -

- Nothing to display -

- {% endif %} - +
+
+
+
+ {% if path_to_content %} + {% include path_to_content %} + {% else %} +

+ Nothing to display +

+ {% endif %} +
+
+
diff --git a/src/howitz/templates/components/toolbar/table-sort-btn.html b/src/howitz/templates/components/toolbar/table-sort-btn.html index 702d8224..b0589f0f 100644 --- a/src/howitz/templates/components/toolbar/table-sort-btn.html +++ b/src/howitz/templates/components/toolbar/table-sort-btn.html @@ -3,6 +3,10 @@ hx-on:mouseenter="htmx.removeClass(htmx.find('#sort-popover'), 'invisible')" hx-on:mouseleave="htmx.addClass(htmx.find('#sort-popover'), 'invisible')" hx-on:click="htmx.removeClass(htmx.find('#sort-menu-dropdown'), 'invisible')" + hx-get="/events/table/change_sort_by" + hx-target="#sort-menu-dropdown-content" + hx-swap="innerHTML" + hx-trigger="click" aria-describedby="sort-popover" >