meerschaum 2.8.4__py3-none-any.whl → 2.9.0__py3-none-any.whl

meerschaum/api/_chunks.py

@@ -0,0 +1,67 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Utility functions for the retrieval, caching, and response of chunk data.
+"""
+
+import random
+from datetime import datetime, timedelta, timezone
+from typing import Dict, Generator, Any, Union, Optional, List
+
+import meerschaum as mrsm
+from meerschaum.api import get_cache_connector
+from meerschaum.utils.misc import generate_password
+
+CHUNKS_TOKENS_GENERATORS: Dict[str, Dict[str, Union[Generator[Any, None, None], datetime, int]]]
+DEFAULT_TTL_SECONDS = mrsm.get_config('system', 'api', 'data', 'chunks', 'ttl_seconds')
+
+
+def generate_chunks_cursor_token(
+    pipe: mrsm.Pipe,
+    select_columns: Optional[List[str]] = None,
+    omit_columns: Optional[List[str]] = None,
+    begin: Union[datetime, int, None] = None,
+    end: Union[datetime, int, None] = None,
+    params: Optional[Dict[str, Any]] = None,
+    limit: Optional[int] = None,
+    order: Optional[str] = 'asc',
+    ttl_seconds: Optional[int] = None,
+    debug: bool = False,
+) -> str:
+    """
+    Store a generator in the `CHUNKS_TOKENS_GENERATORS`
+    """
+    now = datetime.now(timezone.utc)
+    cache_connector = get_cache_connector()
+    if cache_connector is None:
+        pass
+
+    ttl_seconds = ttl_seconds or DEFAULT_TTL_SECONDS
+    chunk_bounds = pipe.get_chunk_bounds(
+        begin=begin,
+        end=end,
+        bounded=True,
+    )
+
+    while True:
+        chunk_token = prefix + generate_password(random.randint(6, 12))
+        if chunk_token in CHUNKS_TOKENS_GENERATORS:
+            continue
+        break
+
+    CHUNKS_TOKENS_GENERATORS[chunk_token] = {
+        'generator': chunk_generator,
+        'created': now,
+        'ttl': ttl_seconds,
+        'last_accessed': now,
+    }
+
+    return chunk_token
+
+
+def deallocate_expired_generators():
+    """
+    Periodically delete chunk tokens with an expired ttl timestamp.
+    """
+    chunk_tokens = list(CHUNKS_TOKENS_GENERATORS)

meerschaum/api/dash/callbacks/__init__.py

@@ -6,13 +6,16 @@
 Define callbacks for pages.
 """
 
+from meerschaum.api import debug as _debug
 import meerschaum.api.dash.callbacks.dashboard
 import meerschaum.api.dash.callbacks.login
 import meerschaum.api.dash.callbacks.plugins
 import meerschaum.api.dash.callbacks.jobs
 import meerschaum.api.dash.callbacks.register
 import meerschaum.api.dash.callbacks.pipes
+import meerschaum.api.dash.callbacks.settings
 from meerschaum.api.dash.callbacks.custom import init_dash_plugins, add_plugin_pages
 
-init_dash_plugins()
-add_plugin_pages()
+init_dash_plugins(debug=_debug)
+add_plugin_pages(debug=_debug)
+

meerschaum/api/dash/callbacks/custom.py

@@ -7,13 +7,16 @@ Import custom callbacks created by plugins.
 """
 
 import traceback
+from typing import Any, Dict
+
 from meerschaum.api.dash import dash_app
 from meerschaum.plugins import _dash_plugins, _plugin_endpoints_to_pages
-from meerschaum.utils.warnings import warn
-from meerschaum.api.dash.callbacks.dashboard import _paths, _required_login
+from meerschaum.utils.warnings import warn, dprint
+from meerschaum.api.dash.callbacks.dashboard import _paths, _required_login, _pages
+from meerschaum.api.dash.components import pages_navbar
 
 
-def init_dash_plugins():
+def init_dash_plugins(debug: bool = False):
     """
     Fire the initial callbacks for Dash plugins.
     """
@@ -29,11 +32,21 @@ def init_dash_plugins():
                 )
 
 
-def add_plugin_pages():
+def add_plugin_pages(debug: bool = False):
     """
     Allow users to add pages via the `@web_page` decorator.
     """
-    for _endpoint, _page_dict in _plugin_endpoints_to_pages.items():
-        _paths[_endpoint] = _page_dict['function']()
-        if _page_dict['login_required']:
-            _required_login.add(_endpoint)
+    for plugin_name, pages_dicts in _plugin_endpoints_to_pages.items():
+        if debug:
+            dprint(f"Adding pages from plugin '{plugin_name}'...")
+        for _endpoint, _page_dict in pages_dicts.items():
+            page_layout = _page_dict['function']()
+            if not _page_dict['skip_navbar']:
+                if isinstance(page_layout, list):
+                    page_layout = [pages_navbar] + page_layout
+                else:
+                    page_layout = [pages_navbar, page_layout]
+            _pages[_page_dict['page_key']] = _endpoint
+            _paths[_endpoint] = page_layout
+            if _page_dict['login_required']:
+                _required_login.add(_endpoint)

meerschaum/api/dash/callbacks/dashboard.py

@@ -33,7 +33,10 @@ from meerschaum.api.dash.users import get_users_cards
 from meerschaum.api.dash.graphs import get_graphs_cards
 from meerschaum.api.dash.webterm import get_webterm
 from meerschaum.api.dash.components import (
-    alert_from_success_tuple, console_div, build_cards_grid,
+    alert_from_success_tuple,
+    console_div,
+    build_cards_grid,
+    build_pages_offcanvas_children,
 )
 from meerschaum.api.dash import pages
 from meerschaum.utils.typing import Dict
@@ -103,6 +106,10 @@ _paths = {
     'job'     : pages.job.layout,
 }
 _required_login = {''}
+_pages = {
+    'Web Console': '/dash/',
+    'Plugins': '/dash/plugins',
+}
 
 
 @dash_app.callback(
@@ -696,7 +703,6 @@ dash_app.clientside_callback(
 dash_app.clientside_callback(
     """
     function(n_clicks){
-        console.log('fullscreen');
         if (!n_clicks) { return dash_clientside.no_update; }
         iframe = document.getElementById('webterm-iframe');
         if (!iframe){ return dash_clientside.no_update; }
@@ -707,11 +713,11 @@ dash_app.clientside_callback(
         if (leftCol.style.display === 'none') {
             leftCol.style.display = '';
             rightCol.className = 'col-6';
-            button.innerHTML = "Full View";
+            button.innerHTML = "⛶";
         } else {
             leftCol.style.display = 'none';
             rightCol.className = 'col-12';
-            button.innerHTML = "Side-by-side View";
+            button.innerHTML = "🀲";
         }
 
         return dash_clientside.no_update;
@@ -1078,3 +1084,19 @@ def parameters_as_yaml_or_json_click(
     if as_yaml:
         return yaml.dump(pipe.parameters)
     return json.dumps(pipe.parameters, indent=4, separators=(',', ': '), sort_keys=True)
+
+
+@dash_app.callback(
+    Output('pages-offcanvas', 'is_open'),
+    Output('pages-offcanvas', 'children'),
+    Input('logo-img', 'n_clicks'),
+    State('pages-offcanvas', 'is_open'),
+)
+def toggle_pages_offcanvas(n_clicks: Optional[int], is_open: bool):
+    """
+    Toggle the pages sidebar.
+    """
+    pages_children = build_pages_offcanvas_children()
+    if n_clicks:
+        return not is_open, pages_children
+    return is_open, pages_children

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

@@ -0,0 +1,8 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Define the callbacks for the settings pages.
+"""
+
+import meerschaum.api.dash.callbacks.settings.password_reset

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

@@ -0,0 +1,76 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Define the callbacks for the password reset page.
+"""
+
+import dash
+from dash.exceptions import PreventUpdate
+from dash.dependencies import Input, Output, State
+import dash_bootstrap_components as dbc
+
+from meerschaum.core.User import User
+from meerschaum.config.static import STATIC_CONFIG
+from meerschaum.api import get_api_connector, debug
+from meerschaum.api.dash import dash_app
+from meerschaum.api.dash.components import alert_from_success_tuple
+from meerschaum.api.dash.sessions import get_username_from_session
+
+
+@dash_app.callback(
+    Output('password-reset-alert-div', 'children'),
+    Input('password-reset-button', 'n_clicks'),
+    State('password-reset-input', 'value',),
+    State('session-store', 'data'),
+)
+def password_reset_button_click(n_clicks, new_password_value, session_store_data):
+    """
+    Attempt the password reset with the form data.
+    """
+    if not n_clicks:
+        raise PreventUpdate
+
+    session_id = session_store_data.get('session-id', None)
+    username = get_username_from_session(session_id)
+    if not username:
+        return alert_from_success_tuple(
+            (False, "Invalid session. Are you logged in correctly?")
+        )
+
+    instance_connector = get_api_connector()
+    user = User(username, new_password_value)
+    success, msg = instance_connector.edit_user(user, debug=debug)
+    return alert_from_success_tuple((success, msg))
+
+
+@dash_app.callback(
+    Output('password-reset-input', 'valid'),
+    Output('password-reset-input', 'invalid'),
+    Input('password-reset-input', 'value'),
+)
+def validate_new_password(new_password_value):
+    if not new_password_value:
+        raise PreventUpdate
+
+    valid = (len(new_password_value) >= STATIC_CONFIG['users']['min_password_length'])
+    return valid, not valid
+ 
+
+@dash_app.callback(
+    Output("password-reset-confirm-input", "valid"),
+    Output("password-reset-confirm-input", "invalid"),
+    Output("password-reset-button", 'disabled'),
+    Input("password-reset-confirm-input", "value"),
+    State("password-reset-input", "value"),
+)
+def validate_new_passwords_match(confirm_password_value, new_password_value):
+    if not confirm_password_value:
+        raise PreventUpdate
+
+    new_password_is_valid, _ = validate_new_password(new_password_value)
+    if not new_password_is_valid:
+        raise PreventUpdate
+
+    valid = confirm_password_value == new_password_value
+    return valid, not valid, not valid

meerschaum/api/dash/components.py

@@ -92,9 +92,9 @@ search_parameters_editor = dash_ace.DashAceEditor(
     style={'height': 100},
 )
 
-sidebar = dbc.Offcanvas(
-    children=[],
-    title='Pages',
+pages_offcanvas = dbc.Offcanvas(
+    title='',
+    id='pages-offcanvas',
 )
 
 download_dataframe = dcc.Download(id='download-dataframe-csv')
@@ -110,38 +110,71 @@ instance_select = dbc.Select(
     class_name='dbc_dark custom-select custom-select-sm',
 )
 
+sign_out_button = dbc.Button(
+    "Sign out",
+    color='link',
+    style={'margin-left': '30px'},
+    id='sign-out-button',
+)
+
+logo_row = dbc.Row(
+    [
+        dbc.Col(
+            html.Img(
+                src=endpoints['dash'] + "/assets/logo_48x48.png",
+                title=doc,
+                id="logo-img",
+                style={'cursor': 'pointer'},
+            ),
+        ),
+    ],
+    align='center',
+    className='g-0 navbar-logo-row',
+)
+
+pages_navbar = html.Div(
+    [
+        pages_offcanvas,
+        dbc.Navbar(
+            dbc.Container(
+                [
+                    logo_row,
+                    dbc.NavbarToggler(id="navbar-toggler", n_clicks=0),
+                    dbc.Collapse(
+                        dbc.Row(
+                            [
+                                dbc.Col(
+                                    sign_out_button,
+                                    className="ms-auto",
+                                ),
+                            ],
+                            className="g-0 ms-auto flex-nowrap mt-3 mt-md-0",
+                        ),
+                        id='navbar-collapse',
+                        is_open=False,
+                        navbar=True,
+                    ),
+                ]
+            ),
+            dark=True,
+            color='dark'
+        ),
+    ],
+    id='pages-navbar-div',
+)
 
 navbar = dbc.Navbar(
     dbc.Container(
         [
-            html.A(
-                dbc.Row(
-                    [
-                        dbc.Col(
-                            html.Img(
-                                src=endpoints['dash'] + "/assets/logo_48x48.png",
-                                title=doc,
-                            ),
-                        ),
-                    ],
-                    align='center',
-                    className='g-0 navbar-logo-row',
-                ),
-                href=('/docs' if docs_enabled else '#'),
-                style={"textDecoration": "none"},
-            ),
+            logo_row,
             dbc.NavbarToggler(id="navbar-toggler", n_clicks=0),
             dbc.Collapse(
                 dbc.Row(
                     [
                         dbc.Col(instance_select),
                         dbc.Col(
-                            dbc.Button(
-                                "Sign out",
-                                color='link',
-                                style={'margin-left': '30px'},
-                                id='sign-out-button',
-                            ),
+                            sign_out_button,
+                            className="ms-auto",
                         ),
                     ],
                     className="g-0 ms-auto flex-nowrap mt-3 mt-md-0",
@@ -199,3 +232,81 @@ def build_cards_grid(cards: List[dbc.Card], num_columns: int = 3) -> html.Div:
         rows.append(r)
         rows.append(html.Br())
     return html.Div(rows)
+
+
+def build_pages_offcanvas_children():
+    """
+    Return the contents of the pages offcanvas.
+    """
+    from meerschaum.api.dash.callbacks.dashboard import _pages
+    from meerschaum.api.dash.callbacks.custom import _plugin_endpoints_to_pages
+    pages_listgroup_items = []
+    custom_pages = []
+    for pages_dicts in _plugin_endpoints_to_pages.values():
+        for page_dict in pages_dicts.values():
+            custom_pages.append(page_dict['page_key'])
+
+    for page_key, page_href in _pages.items():
+        if page_key in custom_pages:
+            continue
+        pages_listgroup_items.append(
+            dbc.ListGroupItem(
+                dbc.Button(
+                    ' '.join([word.capitalize() for word in page_key.split(' ')]),
+                    style={
+                        'width': '100%',
+                        'text-align': 'left',
+                        'text-decoration': 'none',
+                        'padding-left': '0',
+                    },
+                    href=page_href,
+                    color='dark',
+                )
+            )
+        )
+
+    plugins_accordion_items = []
+    for page_group, pages_dicts in _plugin_endpoints_to_pages.items():
+        plugin_listgroup_items = [
+            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',
+                )
+            )
+            for page_href, page_dict in pages_dicts.items()
+        ]
+        plugin_listgroup = dbc.ListGroup(plugin_listgroup_items, flush=True)
+        plugin_accordion_item = dbc.AccordionItem(
+            plugin_listgroup,
+            title=(
+                page_group.capitalize()
+                if page_group and not page_group[0].isupper()
+                else page_group
+            ),
+            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)
+
+    pages_children = dbc.Card(
+        dbc.ListGroup(
+            pages_listgroup_items,
+            flush=True,
+        ),
+        outline=True,
+    )
+    return pages_children

meerschaum/api/dash/pages/__init__.py

@@ -12,3 +12,4 @@ import meerschaum.api.dash.pages.plugins
 import meerschaum.api.dash.pages.register
 import meerschaum.api.dash.pages.pipes
 import meerschaum.api.dash.pages.job
+import meerschaum.api.dash.pages.settings

meerschaum/api/dash/pages/dashboard.py

@@ -37,6 +37,7 @@ from meerschaum.api.dash.components import (
     console_div,
     download_dataframe,
     navbar,
+    pages_offcanvas,
     download_logs,
     refresh_jobs_interval,
 )
@@ -47,22 +48,23 @@ from meerschaum.api.dash.keys import (
 )
 
 layout = html.Div(
-    id = 'main-div',
-    children = [
+    id='main-div',
+    children=[
         keys_lists_content,
         download_dataframe,
         download_logs,
         refresh_jobs_interval,
         navbar,
+        pages_offcanvas,
         html.Div(
             dbc.Row(
-                id = 'content-row',
-                children = [
+                id='content-row',
+                children=[
                     dbc.Col(
-                        children = [
+                        children=[
                             dbc.Tabs(
-                                id = 'pipes-filter-tabs',
-                                children = [
+                                id='pipes-filter-tabs',
+                                children=[
                                     dbc.Tab(
                                         dropdown_tab_content,
                                         label='Filters',
@@ -107,9 +109,9 @@ layout = html.Div(
                         id='content-col-right',
                     ),
                 ],
-                style = {'max-width': '100%', 'padding': '15px'},
+                style={'max-width': '100%', 'padding': '15px'},
             ), ### end of Row
-            className = 'container-fluid',
+            className='container-fluid',
         ), ### end of Div
         html.P('', id='line-buffer', style={'display': 'none'}),
     ],

meerschaum/api/dash/pages/plugins.py

@@ -13,6 +13,7 @@ html, dcc = import_html(check_update=CHECK_UPDATE), import_dcc(check_update=CHEC
 import dash_bootstrap_components as dbc
 from meerschaum.core import Plugin
 from meerschaum.utils.typing import Optional
+from meerschaum.api.dash.components import pages_navbar
 
 search_box = dbc.Input(
     id = "search-plugins-input",
@@ -20,32 +21,35 @@ search_box = dbc.Input(
     type = "text",
 )
 
-layout = dbc.Container([
-    html.Div([
-        html.Br(),
-        html.Div(
-            dbc.Container([
-                html.H3('Plugins'),
-                html.P([
-                    (
-                        'Plugins extend the functionality of Meerschaum.'
-                        + ' To find out more, check out the '
-                    ),
-                    html.A(
-                        'plugins documentation',
-                        href = 'https://meerschaum.io/reference/plugins/',
-                        rel = "noreferrer noopener",
-                        target = "_blank",
-                    ),
-                    '.',
+layout = [
+    pages_navbar,
+    dbc.Container([
+        html.Div([
+            html.Br(),
+            html.Div(
+                dbc.Container([
+                    html.H3('Plugins'),
+                    html.P([
+                        (
+                            'Plugins extend the functionality of Meerschaum.'
+                            ' To find out more, check out the '
+                        ),
+                        html.A(
+                            'plugins documentation',
+                            href='https://meerschaum.io/reference/plugins/',
+                            rel="noreferrer noopener",
+                            target="_blank",
+                        ),
+                        '.',
+                    ]),
                 ]),
-            ]),
-            className = 'page-header',
-            style = {'background-color': 'var(--dark)', 'padding': '1em'},
-        ),
-        html.Br(),
-        search_box,
-        html.Br(),
-        html.Div([], id='plugins-cards-div'),
+                className='page-header',
+                style={'background-color': 'var(--dark)', 'padding': '1em'},
+            ),
+            html.Br(),
+            search_box,
+            html.Br(),
+            html.Div([], id='plugins-cards-div'),
+        ])
     ])
-])
+]

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

@@ -0,0 +1,8 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Define the layouts for the `settings` pages.
+"""
+
+import meerschaum.api.dash.pages.settings.password_reset

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

@@ -0,0 +1,63 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Define the password reset page layout.
+"""
+
+import dash_bootstrap_components as dbc
+import dash.html as html
+import dash.dcc as dcc
+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 dbc.Container([
+        html.Br(),
+        html.H3('Password Reset'),
+        html.Br(),
+        html.Div(id="password-reset-alert-div"),
+        dbc.Form([
+            dbc.Row(
+                [
+                    dbc.Label("New Password", html_for="password-reset-input", width=2),
+                    dbc.Col(
+                        dbc.Input(
+                            type="password",
+                            id="password-reset-input",
+                            placeholder="Enter new password",
+                        ),
+                        width=10,
+                    ),
+                ],
+                className="mb-3",
+            ),
+            dbc.Row(
+                [
+                    dbc.Label("Confirm Password", html_for="password-reset-confirm-input", width=2),
+                    dbc.Col(
+                        dbc.Input(
+                            type="password",
+                            id="password-reset-confirm-input",
+                            placeholder="Confirm new password",
+                        ),
+                        width=10,
+                    ),
+                ],
+                className="mb-3",
+            ),
+            dbc.Row(
+                [
+                    dbc.Col(
+                        dbc.Button("Submit", id="password-reset-button", disabled=True),
+                    ),
+                ],
+                justify="end",
+                className="mb-3",
+            ),
+        ]),
+    ])