meerschaum 2.9.5__py3-none-any.whl → 3.0.0rc2__py3-none-any.whl

meerschaum/api/dash/callbacks/settings/tokens.py

@@ -0,0 +1,388 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Define the callbacks for the tokens page.
+"""
+
+import json
+from typing import Optional, List, Dict, Any, Tuple
+from datetime import datetime, timezone
+
+import dash
+from dash.dependencies import Input, Output, State, MATCH, ALL
+from dash.exceptions import PreventUpdate
+import dash_bootstrap_components as dbc
+import dash.html as html
+import dash.dcc as dcc
+
+import meerschaum as mrsm
+from meerschaum.api import get_api_connector, debug
+from meerschaum.api.dash import dash_app
+from meerschaum.api.dash.sessions import get_user_from_session
+from meerschaum.api.dash.components import alert_from_success_tuple, build_cards_grid
+from meerschaum.api.dash.tokens import (
+    get_tokens_cards,
+    get_tokens_table,
+    build_tokens_register_input_modal,
+    build_tokens_register_output_modal,
+)
+from meerschaum._internal.static import STATIC_CONFIG
+from meerschaum.utils.daemon import get_new_daemon_name
+from meerschaum.core import Token
+
+
+@dash_app.callback(
+    Output('tokens-output-div', 'children'),
+    Output('tokens-register-input-modal', 'children'),
+    Output('tokens-alert-div', 'children'),
+    Input('tokens-refresh-button', 'n_clicks'),
+    State('session-store', 'data'),
+)
+def refresh_tokens_button_click(
+    n_clicks: Optional[int],
+    session_data: Optional[Dict[str, Any]] = None,
+):
+    """
+    Build the tokens cards on load or refresh.
+    """
+    session_id = (session_data or {}).get('session-id', None)
+    tokens_table, alerts = get_tokens_table(session_id)
+    if not tokens_table:
+        return (
+            [
+                html.H4('No tokens registered.'),
+                html.P('Click the `+` button to register a new token.'),
+            ],
+            alerts
+        )
+
+    return tokens_table, build_tokens_register_input_modal(), alerts
+
+
+@dash_app.callback(
+    Output('tokens-register-input-modal', 'is_open'),
+    Input('tokens-create-button', 'n_clicks'),
+    prevent_initial_call=True,
+)
+def create_tokens_button_click(n_clicks: Optional[int]):
+    """
+    Open the tokens registration modal when the plus button is clicked.
+    """
+    if not n_clicks:
+        raise PreventUpdate
+
+    return True
+
+
+@dash_app.callback(
+    Output("tokens-scopes-checklist-div", 'style'),
+    Input("tokens-toggle-scopes-switch", 'value'),
+    prevent_initial_call=True,
+)
+def toggle_token_scopes_checklist(value: bool):
+    """
+    Toggle the scopes checklist.
+    """
+    return {'display': 'none'} if value else {}
+
+
+@dash_app.callback(
+    Output('tokens-scopes-checklist', 'value'),
+    Output('tokens-deselect-scopes-button', 'children'),
+    Input('tokens-deselect-scopes-button', 'n_clicks'),
+    State('tokens-deselect-scopes-button', 'children'),
+    prevent_initial_call=True,
+)
+def deselect_scopes_click(n_clicks: Optional[int], name: str):
+    """
+    Set the value of the scopes checklist to an empty list.
+    """
+    if not n_clicks:
+        raise PreventUpdate
+
+    new_name = 'Select all' if name == 'Deselect all' else 'Deselect all'
+    value = (
+        []
+        if name == 'Deselect all'
+        else list(STATIC_CONFIG['tokens']['scopes'])
+    )
+
+    return value, new_name
+
+
+@dash_app.callback(
+    Output({'type': 'tokens-scopes-checklist', 'index': MATCH}, 'value'),
+    Output({'type': 'tokens-deselect-scopes-button', 'index': MATCH}, 'children'),
+    Input({'type': 'tokens-deselect-scopes-button', 'index': MATCH}, 'n_clicks'),
+    State({'type': 'tokens-deselect-scopes-button', 'index': MATCH}, 'children'),
+    prevent_initial_call=True,
+)
+def edit_token_deselect_scopes_click(n_clicks: Optional[int], name: str):
+    """
+    Set the value of the scopes checklist to an empty list.
+    """
+    if not n_clicks:
+        raise PreventUpdate
+
+    new_name = 'Select all' if name == 'Deselect all' else 'Deselect all'
+    value = (
+        []
+        if name == 'Deselect all'
+        else list(STATIC_CONFIG['tokens']['scopes'])
+    )
+
+    return value, new_name
+
+
+@dash_app.callback(
+    Output('tokens-register-input-modal', 'is_open'),
+    Output('tokens-register-output-modal', 'is_open'),
+    Output('tokens-register-output-modal', 'children'),
+    Input('tokens-register-button', 'n_clicks'),
+    State('tokens-name-input', 'value'),
+    State('tokens-scopes-checklist', 'value'),
+    State('tokens-expiration-datepickersingle', 'date'),
+    State('session-store', 'data'),
+    prevent_initial_call=True,
+)
+def register_token_click(
+    n_clicks: Optional[int],
+    name: str,
+    scopes: List[str],
+    expiration: Optional[datetime] = None,
+    session_data: Optional[Dict[str, Any]] = None,
+):
+    """
+    Register the token.
+    """
+    if not n_clicks:
+        raise PreventUpdate
+
+    session_id = (session_data or {}).get('session-id', None)
+    token = Token(
+        label=(name or None),
+        user=get_user_from_session(session_id),
+        expiration=(datetime.fromisoformat(f"{expiration}T00:00:00Z") if expiration is not None else None),
+    )
+    return False, True, build_tokens_register_output_modal(token)
+
+
+@dash_app.callback(
+    Output("tokens-refresh-button", "n_clicks"),
+    Input("tokens-register-output-modal", "is_open"),
+    Input({'type': 'tokens-edit-modal', 'index': ALL}, 'is_open'),
+    Input({'type': 'tokens-invalidate-modal', 'index': ALL}, 'is_open'),
+    Input({'type': 'tokens-delete-modal', 'index': ALL}, 'is_open'),
+    State("tokens-refresh-button", "n_clicks"),
+    prevent_initial_call=True,
+)
+def register_token_modal_close_refresh(
+    register_is_open: bool,
+    edit_is_open_list,
+    invalidate_is_open_list,
+    delete_is_open_list,
+    n_clicks: int,
+):
+    """
+    Refresh the cards when the registration, edit, invalidate, or delete modals changes visibility.
+    """
+    if any(
+        edit_is_open_list
+        + invalidate_is_open_list
+        + delete_is_open_list
+    ):
+        raise PreventUpdate
+
+    return (n_clicks or 0) + 1
+
+
+@dash_app.callback(
+    Output('tokens-register-clipboard', 'content'),
+    Output('tokens-register-clipboard', 'n_clicks'),
+    Output('tokens-register-copy-button', 'children'),
+    Input('tokens-register-copy-button', 'n_clicks'),
+    State('tokens-register-clipboard', 'n_clicks'),
+    State('token-id-pre', 'children'),
+    State('token-secret-pre', 'children'),
+    prevent_initial_call=True,
+)
+def copy_token_button_click(
+    n_clicks: int,
+    clipboard_n_clicks: Optional[int],
+    token_id: str,
+    token_secret: str,
+) -> Tuple[str, int, str]:
+    """
+    Copy the token's ID and secret to the clipboard.
+    """
+    if not n_clicks:
+        raise PreventUpdate
+    return (
+        f"Client ID: {token_id}\nClient Secret: {token_secret}",
+        (clipboard_n_clicks or 0) + 1,
+        "Copied!",
+    )
+
+
+@dash_app.callback(
+    Output('tokens-close-register-output-modal-button', 'disabled'),
+    Output('tokens-register-output-modal', 'backdrop'),
+    Input('tokens-register-clipboard', 'n_clicks'),
+    prevent_initial_call=True,
+)
+def enable_close_button(n_clicks):
+    """
+    Enable the close button once the token has been copied.
+    """
+    if not n_clicks:
+        raise PreventUpdate
+    return False, True
+
+
+@dash_app.callback(
+    Output('tokens-register-output-modal', 'is_open'),
+    Input('tokens-close-register-output-modal-button', 'n_clicks'),
+    prevent_initial_call=True,
+)
+def close_register_output_modal(n_clicks: int) -> bool:
+    """
+    Close the register output modal when the Close button is clicked.
+    """
+    if not n_clicks:
+        raise PreventUpdate
+    return False
+
+
+@dash_app.callback(
+    Output({'type': 'tokens-edit-modal', 'index': MATCH}, 'is_open'),
+    Input({'type': 'tokens-edit-button', 'index': MATCH}, 'n_clicks'),
+    prevent_initial_call=True,
+)
+def edit_token_button_click(n_clicks: int):
+    if not n_clicks:
+        raise PreventUpdate
+    return True
+
+
+@dash_app.callback(
+    Output({'type': 'tokens-edit-modal', 'index': MATCH}, 'is_open'),
+    Output({'type': 'tokens-edit-alerts-div', 'index': MATCH}, 'children'),
+    Input({'type': 'tokens-edit-submit-button', 'index': MATCH}, 'n_clicks'),
+    State({'type': 'tokens-expiration-datepickersingle', 'index': MATCH}, 'date'),
+    State({'type': 'tokens-scopes-checklist', 'index': MATCH}, 'value'),
+    State({'type': 'tokens-name-input', 'index': MATCH}, 'value'),
+    prevent_initial_call=True,
+)
+def edit_token_submit_button_click(
+    n_clicks: int,
+    expiration: Optional[datetime],
+    scopes: List[str],
+    label: str,
+):
+    if not n_clicks:
+        raise PreventUpdate
+
+    ctx = dash.callback_context.triggered
+    if ctx[0]['value'] is None:
+        raise PreventUpdate
+
+    component_dict = json.loads(ctx[0]['prop_id'].split('.' + 'n_clicks')[0])
+    token_id = component_dict['index']
+
+    token = Token(
+        id=token_id,
+        label=label,
+        expiration=(datetime.fromisoformat(f"{expiration}T00:00:00Z") if expiration is not None else None),
+        scopes=scopes,
+        instance=get_api_connector(),
+    )
+
+    success, msg = token.edit(debug=debug)
+    if not success:
+        return dash.no_update, alert_from_success_tuple((success, msg))
+
+    return False, dash.no_update
+
+
+@dash_app.callback(
+    Output({'type': 'tokens-invalidate-modal', 'index': MATCH}, 'is_open'),
+    Input({'type': 'tokens-invalidate-button', 'index': MATCH}, 'n_clicks'),
+    prevent_initial_call=True,
+)
+def invalidate_token_click(n_clicks: int):
+    if not n_clicks:
+        raise PreventUpdate
+    return True
+
+
+@dash_app.callback(
+    Output({'type': 'tokens-delete-modal', 'index': MATCH}, 'is_open'),
+    Input({'type': 'tokens-delete-button', 'index': MATCH}, 'n_clicks'),
+    prevent_initial_call=True,
+)
+def invalidate_token_click(n_clicks: int):
+    if not n_clicks:
+        raise PreventUpdate
+    return True
+
+
+
+@dash_app.callback(
+    Output({'type': 'tokens-edit-modal', 'index': MATCH}, 'is_open'),
+    Output({'type': 'tokens-invalidate-modal', 'index': MATCH}, 'is_open'),
+    Output({'type': 'tokens-invalidate-alerts-div', 'index': MATCH}, 'children'),
+    Input({'type': 'tokens-invalidate-confirm-button', 'index': MATCH}, 'n_clicks'),
+    prevent_initial_call=True,
+)
+def invalidate_token_confirm_click(n_clicks: int):
+    if not n_clicks:
+        raise PreventUpdate
+
+    ctx = dash.callback_context.triggered
+    if ctx[0]['value'] is None:
+        raise PreventUpdate
+
+    component_dict = json.loads(ctx[0]['prop_id'].split('.' + 'n_clicks')[0])
+    token_id = component_dict['index']
+
+    token = Token(
+        id=token_id,
+        instance=get_api_connector(),
+    )
+
+    success, msg = token.invalidate(debug=debug)
+    if not success:
+        return dash.no_update, dash.no_update, alert_from_success_tuple((success, msg))
+
+    return False, False, dash.no_update
+
+
+@dash_app.callback(
+    Output({'type': 'tokens-edit-modal', 'index': MATCH}, 'is_open'),
+    Output({'type': 'tokens-delete-modal', 'index': MATCH}, 'is_open'),
+    Output({'type': 'tokens-delete-alerts-div', 'index': MATCH}, 'children'),
+    Input({'type': 'tokens-delete-confirm-button', 'index': MATCH}, 'n_clicks'),
+    prevent_initial_call=True,
+)
+def delete_token_confirm_click(n_clicks: int):
+    if not n_clicks:
+        raise PreventUpdate
+
+    ctx = dash.callback_context.triggered
+    if ctx[0]['value'] is None:
+        raise PreventUpdate
+
+    component_dict = json.loads(ctx[0]['prop_id'].split('.' + 'n_clicks')[0])
+    token_id = component_dict['index']
+
+    token = Token(
+        id=token_id,
+        instance=get_api_connector(),
+    )
+
+    success, msg = token.delete(debug=debug)
+    if not success:
+        return dash.no_update, dash.no_update, alert_from_success_tuple((success, msg))
+
+    return False, False, []

meerschaum/api/dash/components.py

@@ -10,7 +10,7 @@ from __future__ import annotations
 
 from meerschaum.utils.packages import attempt_import, import_dcc, import_html
 from meerschaum.utils.typing import SuccessTuple, List
-from meerschaum.config.static import STATIC_CONFIG
+from meerschaum._internal.static import STATIC_CONFIG
 from meerschaum.utils.misc import remove_ansi
 from meerschaum._internal.shell.Shell import get_shell_intro
 from meerschaum.api import endpoints, CHECK_UPDATE, docs_enabled
@@ -267,6 +267,26 @@ def build_pages_offcanvas_children():
 
     plugins_accordion_items = []
     for page_group, pages_dicts in _plugin_endpoints_to_pages.items():
+        if len(pages_dicts) == 1:
+            page_href, page_dict = list(pages_dicts.items())[0]
+            if page_dict['page_key'].lower() == page_group.lower():
+                pages_listgroup_items.append(
+                    dbc.ListGroupItem(
+                        dbc.Button(
+                            ' '.join([word.capitalize() for word in page_dict['page_key'].split(' ')]),
+                            style={
+                                'width': '100%',
+                                'text-align': 'left',
+                                'text-decoration': 'none',
+                                'padding-left': '0',
+                            },
+                            href=page_href,
+                            color='dark',
+                        )
+                    )
+                )
+                continue
+
         plugin_listgroup_items = [
             dbc.ListGroupItem(
                 dbc.Button(
@@ -294,13 +314,15 @@ def build_pages_offcanvas_children():
             class_name='pages-offcanvas-accordion',
         )
         plugins_accordion_items.append(plugin_accordion_item)
-    plugins_accordion = dbc.Accordion(
-        plugins_accordion_items,
-        start_collapsed=True,
-        flush=True,
-        always_open=True,
-    )
-    pages_listgroup_items.append(plugins_accordion)
+
+    if plugins_accordion_items:
+        plugins_accordion = dbc.Accordion(
+            plugins_accordion_items,
+            start_collapsed=True,
+            flush=True,
+            always_open=True,
+        )
+        pages_listgroup_items.append(plugins_accordion)
 
     pages_children = dbc.Card(
         dbc.ListGroup(

meerschaum/api/dash/keys.py

@@ -16,13 +16,10 @@ dbc = attempt_import('dash_bootstrap_components', lazy=False, check_update=CHECK
 html, dcc = import_html(check_update=CHECK_UPDATE), import_dcc(check_update=CHECK_UPDATE)
 
 placeholders = {
-    'ck' : 'Connectors',
-    'mk' : 'Metrics',
-    'lk' : 'Locations',
-    'params' : (
-        'Additional search parameters. ' +
-        'Simple dictionary format or JSON accepted.'
-    ),
+    'ck': 'Connectors',
+    'mk': 'Metrics',
+    'lk': 'Locations',
+    'tags': 'Tags',
 }
 widths = {
     'flags' : {'size' : 12},
@@ -212,11 +209,25 @@ dropdown_keys_row = dbc.Row(
         ),
     ] ### end of filters row children
 )
+tags_dropdown = html.Div(
+    dcc.Dropdown(
+        id='tags-dropdown',
+        options=[],
+        placeholder=placeholders['tags'],
+        multi=True,
+        searchable=True,
+    ),
+    className="dbc_dark",
+    id="tags-dropdown-div",
+)
+
 dropdown_tab_content = html.Div([
     dbc.Card(
         dbc.CardBody(
             [
                 dropdown_keys_row,
+                html.Br(),
+                tags_dropdown,
             ], ### end of card children
             className='card-text',
         )
@@ -232,94 +243,9 @@ dropdown_tab_content = html.Div([
     ),
 ])
 
-text_tab_content = dbc.Card(
-    dbc.CardBody(
-        [
-            dbc.Row(
-                [
-                    dbc.Col(html.Div(className='dbc_dark', children=[
-                        dbc.InputGroup(
-                            [
-                                    dbc.Button(
-                                        'Clear',
-                                        id='clear-connector-keys-input-button',
-                                        color='link',
-                                        size='sm',
-                                    ),
-                                dbc.Input(
-                                    id='connector-keys-input',
-                                    placeholder=placeholders['ck'],
-                                    type='text',
-                                    value='',
-                                    list='connector-keys-list',
-                                    className='dbc_dark'
-                                ),
-                            ],
-                            size=input_group_sizes['ck'],
-                        )]),
-                        width=4,
-                    ),
-                    dbc.Col(
-                        dbc.InputGroup(
-                            [
-                                    dbc.Button(
-                                        'Clear',
-                                        id='clear-metric-keys-input-button',
-                                        color='link',
-                                        size='sm',
-                                    ),
-                                dbc.Input(
-                                    id='metric-keys-input',
-                                    placeholder=placeholders['mk'],
-                                    type='text',
-                                    value='',
-                                    list='metric-keys-list',
-                                ),
-                            ],
-                            size=input_group_sizes['mk'],
-                        ),
-                        width=4,
-                    ),
-                    dbc.Col(
-                        dbc.InputGroup(
-                            [
-                                    dbc.Button(
-                                        'Clear',
-                                        id='clear-location-keys-input-button',
-                                        color='link',
-                                        size='sm',
-                                    ),
-                                dbc.Input(
-                                    id='location-keys-input',
-                                    placeholder=placeholders['lk'],
-                                    type='text',
-                                    value='',
-                                    list='location-keys-list',
-                                ),
-                            ],
-                            size=input_group_sizes['lk'],
-                        ),
-                        width=4,
-                    ),
-                ]
-            ),
-            html.Br(),
-            dbc.Row(
-                dbc.Col(
-                    dbc.InputGroup(
-                        [
-                            search_parameters_editor,
-                        ],
-                        size=input_group_sizes['params'],
-                    )
-                )
-            ),
-        ]
-    )
-)
-
 keys_lists_content = html.Div([
     html.Datalist(id='connector-keys-list'),
     html.Datalist(id='metric-keys-list'),
     html.Datalist(id='location-keys-list'),
+    html.Datalist(id='tags-list'),
 ], hidden=True)

meerschaum/api/dash/pages/dashboard.py

@@ -6,7 +6,6 @@
 The main dashboard layout.
 """
 
-import uuid
 from meerschaum.config import __doc__ as doc, get_config
 from meerschaum.utils.misc import get_connector_labels
 from meerschaum.utils.packages import attempt_import, import_html, import_dcc, import_pandas
@@ -43,7 +42,6 @@ from meerschaum.api.dash.components import (
 )
 from meerschaum.api.dash.keys import (
     keys_lists_content,
-    text_tab_content,
     dropdown_tab_content,
 )
 
@@ -62,24 +60,7 @@ layout = html.Div(
                 children=[
                     dbc.Col(
                         children=[
-                            dbc.Tabs(
-                                id='pipes-filter-tabs',
-                                children=[
-                                    dbc.Tab(
-                                        dropdown_tab_content,
-                                        label='Filters',
-                                        id='pipes-filter-dropdown-tab',
-                                        tab_id='dropdown',
-                                    ),
-                                    dbc.Tab(
-                                        text_tab_content,
-                                        label='Text',
-                                        id='pipes-filter-input-tab',
-                                        tab_id='input',
-                                        tab_style={"display": "none"},
-                                    ),
-                                ]
-                            ),
+                            dropdown_tab_content,
                             html.Br(),
                             bottom_buttons_content,
                             test_button,

meerschaum/api/dash/pages/settings/__init__.py

@@ -6,3 +6,4 @@ Define the layouts for the `settings` pages.
 """
 
 import meerschaum.api.dash.pages.settings.password_reset
+import meerschaum.api.dash.pages.settings.tokens

meerschaum/api/dash/pages/settings/password_reset.py

@@ -14,7 +14,7 @@ from meerschaum.plugins import web_page
 @web_page('password-reset', login_required=True, page_group='Settings')
 def page_layout():
     """
-    Return the layout for this page.
+    Return the layout for the password reset page.
     """
     return dbc.Container([
         html.Br(),

meerschaum/api/dash/pages/settings/tokens.py

@@ -0,0 +1,55 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Define the tokens page layout.
+"""
+
+import dash_bootstrap_components as dbc
+import dash.html as html
+import dash.dcc as dcc
+from meerschaum.plugins import web_page
+from meerschaum._internal.static import STATIC_CONFIG
+
+
+@web_page('tokens', login_required=True, page_group='Settings')
+def page_layout():
+    """
+    Return the layout for the tokens page.
+    """
+    return dbc.Container([
+        html.Br(), 
+        html.H3('Tokens'),
+        html.Div(id="tokens-alert-div"),
+        dbc.Modal(
+            id="tokens-register-input-modal",
+            size='lg',
+            is_open=False,
+        ),
+        dbc.Modal(
+            id="tokens-register-output-modal",
+            size='lg',
+            is_open=False,
+            backdrop='static',
+        ),
+        html.Div(id='tokens-register-output-modal-div'),
+        html.Div(
+            [
+                dbc.Button(
+                    "⟳",
+                    color='black',
+                    size='sm',
+                    id='tokens-refresh-button',
+                ),
+                dbc.Button(
+                    html.B('+'),
+                    color='black',
+                    size='sm',
+                    id='tokens-create-button',
+                ),
+            ],
+            id='tokens-controls-div',
+            style={'text-align': 'right'},
+        ),
+        html.Div(id='tokens-output-div'),
+    ])