meerschaum 2.9.0rc2__py3-none-any.whl → 2.9.1__py3-none-any.whl

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

@@ -11,12 +11,12 @@ 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.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.
     """
@@ -32,29 +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():
-        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]
-        page_key = (
-            ' '.join(
-                [
-                    word.capitalize()
-                    for word in (
-                        _endpoint.replace('/dash', '').lstrip('/').rstrip('/').strip()
-                        .replace('-', ' ').replace('_', ' ').split(' ')
-                    )
-                ]
-            )
-        )
-        _pages[page_key] = _endpoint
-        _paths[_endpoint] = page_layout
-        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
@@ -1093,26 +1096,7 @@ def toggle_pages_offcanvas(n_clicks: Optional[int], is_open: bool):
     """
     Toggle the pages sidebar.
     """
-    pages_children = dbc.Card(
-        dbc.ListGroup(
-            [
-                dbc.ListGroupItem(
-                    dbc.Button(
-                        html.P(
-                            ' '.join([word.capitalize() for word in page_key.split(' ')]),
-                            style={'text-decoration': 'none', 'fontSize': '18px'},
-                        ),
-                        style={'width': '100%', 'text-align': 'left'},
-                        href=page_href,
-                        color='dark',
-                    )
-                )
-                for page_key, page_href in _pages.items()
-            ],
-            flush=True,
-        ),
-        outline=True,
-    )
+    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

@@ -110,6 +110,13 @@ 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(
@@ -128,7 +135,30 @@ logo_row = dbc.Row(
 pages_navbar = html.Div(
     [
         pages_offcanvas,
-        dbc.Navbar(dbc.Container(logo_row), dark=True, color='dark'),
+        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',
 )
@@ -143,12 +173,7 @@ navbar = dbc.Navbar(
                     [
                         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",
                         ),
                     ],
@@ -207,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/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",
+            ),
+        ]),
+    ])

meerschaum/api/resources/static/css/dash.css

@@ -73,3 +73,10 @@ a {
 .input-text {
   font-family: Consolas, Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, Bitstream Vera Sans Mono, Courier New, monospace, serif !important;
 }
+.pages-offcanvas-accordion button {
+  background-color: var(--bs-dark) !important;
+  color: white !important;
+}
+.pages-offcanvas-accordion div {
+  padding: 0 !important;
+}

meerschaum/api/routes/_pipes.py

@@ -383,8 +383,10 @@ def get_pipe_data(
     params: Optional[str] = None,
     limit: int = MAX_RESPONSE_ROW_LIMIT,
     order: str = 'asc', 
-    as_chunks: bool = False,
-    chunk_interval: Optional[int] = None,
+    date_format: str = 'iso',
+    date_unit: str = 'us',
+    double_precision: int = 15,
+    geometry_format: str = 'wkb_hex',
     curr_user = (
         fastapi.Depends(manager) if not no_auth else None
     ),
@@ -401,8 +403,20 @@ def get_pipe_data(
         The connector key to the instance on which the pipe is registered.
         Defaults to the configured value for `meerschaum:api_instance`.
 
-    as_chunks: bool, default False
-        If `True`, return a chunk token to be consumed by the `/chunks` endpoint.
+    date_format: str, default 'iso'
+        Serialzation format for datetime values.
+        Accepted values are `'iso`' (ISO8601) and `'epoch'` (epoch milliseconds).
+
+    date_unit: str, default 'us'
+        Timestamp precision for serialization. Accepted values are `'s'` (seconds),
+        `'ms'` (milliseconds), `'us'` (microseconds), and `'ns'`.
+
+    double_precision: int, default 15
+        The number of decimal places to use when encoding floating point values (maximum `15`).
+
+    geometry_format: str, default 'wkb_hex'
+        The serialization format for geometry data.
+        Accepted values are `geojson`, `wkb_hex`, and `wkt`.
     """
     if limit > MAX_RESPONSE_ROW_LIMIT:
         raise fastapi.HTTPException(
@@ -469,25 +483,6 @@ def get_pipe_data(
             detail=f"Cannot retrieve data from protected table '{pipe.target}'.",
         )
 
-    if as_chunks:
-        chunks_cursor_token = generate_chunks_cursor_token(
-            pipe,
-            select_columns=_select_columns,
-            omit_columns=_omit_columns,
-            begin=begin,
-            end=end,
-            params=_params,
-            limit=limit,
-            order=order,
-            debug=debug,
-        )
-        return fastapi.Response(
-            json.dumps({
-                'chunks_cursor': chunks_cursor,
-            }),
-            media_type='application/json',
-        )
-
     df = pipe.get_data(
         select_columns=_select_columns,
         omit_columns=_omit_columns,
@@ -504,7 +499,13 @@ def get_pipe_data(
             detail="Could not fetch data with the given parameters.",
         )
 
-    json_content = to_json(df)
+    json_content = to_json(
+        df,
+        date_format=date_format,
+        date_unit=date_unit,
+        geometry_format=geometry_format,
+        double_precision=double_precision,
+    )
     return fastapi.Response(
         json_content,
         media_type='application/json',
@@ -554,37 +555,70 @@ def get_pipe_chunk_bounds(
     )
 
 
-@app.get(
-    pipes_endpoint + '/{connector_keys}/{metric_key}/{location_key}/chunk/{chunk_token}',
+@app.delete(
+    pipes_endpoint + '/{connector_keys}/{metric_key}/{location_key}/drop',
     tags=['Pipes: Data'],
 )
-def get_pipe_chunk(
+def drop_pipe(
     connector_keys: str,
     metric_key: str,
     location_key: str,
-    chunk_token: str
-) -> Dict[str, Any]:
+    instance_keys: Optional[str] = None,
+    curr_user = (
+        fastapi.Depends(manager) if not no_auth else None
+    ),
+):
     """
-    Consume a chunk token, returning the dataframe.
+    Drop a pipe's target table.
     """
+    allow_actions = mrsm.get_config('system', 'api', 'permissions', 'actions', 'non_admin')
+    if not allow_actions:
+        return False, (
+            "The administrator for this server has not allowed actions.\n\n"
+            "Please contact the system administrator, or if you are running this server, "
+            "open the configuration file with `edit config system` and search for 'permissions'."
+            " Under the keys `api:permissions:actions`, " +
+            "you can toggle non-admin actions."
+        )
+    pipe_object = get_pipe(connector_keys, metric_key, location_key, instance_keys)
+    results = get_api_connector(instance_keys=instance_keys).drop_pipe(pipe_object, debug=debug)
+    pipes(instance_keys, refresh=True)
+    return results
 
 
 @app.delete(
-    pipes_endpoint + '/{connector_keys}/{metric_key}/{location_key}/drop',
+    pipes_endpoint + '/{connector_keys}/{metric_key}/{location_key}/clear',
     tags=['Pipes: Data'],
 )
-def drop_pipe(
+def clear_pipe(
     connector_keys: str,
     metric_key: str,
     location_key: str,
     instance_keys: Optional[str] = None,
+    begin: Union[str, int, None] = None,
+    end: Union[str, int, None] = None,
+    params: Optional[str] = None,
     curr_user = (
         fastapi.Depends(manager) if not no_auth else None
     ),
 ):
     """
-    Drop a pipes' underlying target table.
+    Delete rows from a pipe's target table.
     """
+    _params = {}
+    if params == 'null':
+        params = None
+    if params is not None:
+        try:
+            _params = json.loads(params)
+        except Exception:
+            _params = None
+    if not isinstance(_params, dict):
+        raise fastapi.HTTPException(
+            status_code=409,
+            detail="Params must be a valid JSON-encoded dictionary.",
+        )
+
     allow_actions = mrsm.get_config('system', 'api', 'permissions', 'actions', 'non_admin')
     if not allow_actions:
         return False, (
@@ -594,13 +628,19 @@ def drop_pipe(
             " Under the keys `api:permissions:actions`, " +
             "you can toggle non-admin actions."
         )
-    pipe_object = get_pipe(connector_keys, metric_key, location_key, instance_keys)
-    results = get_api_connector(instance_keys=instance_keys).drop_pipe(pipe_object, debug=debug)
+    pipe = get_pipe(connector_keys, metric_key, location_key, instance_keys)
+    begin, end = pipe.parse_date_bounds(begin, end)
+    results = get_api_connector(instance_keys=instance_keys).clear_pipe(
+        pipe,
+        begin=begin,
+        end=end,
+        params=_params,
+        debug=debug,
+    )
     pipes(instance_keys, refresh=True)
     return results
 
 
-
 @app.get(
     pipes_endpoint + '/{connector_keys}/{metric_key}/{location_key}/csv',
     tags=['Pipes: Data'],

meerschaum/config/_version.py

@@ -2,4 +2,4 @@
 Specify the Meerschaum release version.
 """
 
-__version__ = "2.9.0rc2"
+__version__ = "2.9.1"

meerschaum/connectors/__init__.py

@@ -34,6 +34,7 @@ __all__ = (
     "api",
     "sql",
     "valkey",
+    "parse",
 )
 
 ### store connectors partitioned by