meerschaum 2.7.8__py3-none-any.whl → 2.7.10__py3-none-any.whl

meerschaum/_internal/term/TermPageHandler.py

@@ -7,14 +7,64 @@ Define the terminal page handler class.
 """
 
 from __future__ import annotations
-from meerschaum.utils.packages import attempt_import
-tornado_web = attempt_import('tornado.web', lazy=False)
+from typing import Any
+
+import meerschaum as mrsm
+from meerschaum.utils.warnings import warn
+tornado_web = mrsm.attempt_import('tornado.web', lazy=False)
+terminado = mrsm.attempt_import('terminado', lazy=False)
+
+tmux_suffix = mrsm.get_config('system', 'webterm', 'tmux', 'session_suffix')
+
 
 class TermPageHandler(tornado_web.RequestHandler):
-    def get(self):
+
+    def get(self, term_name):
+        term_manager = self.application.settings['term_manager']
+        shell_command = [
+            cmd.replace('MRSM_SESSION', term_name + tmux_suffix)
+            for cmd in term_manager.shell_command
+        ]
+        terminal = term_manager.new_terminal(shell_command=shell_command)
+        terminal.term_name = term_name
+        term_manager.terminals[term_name] = terminal
+        term_manager.start_reading(terminal)
         return self.render(
             "termpage.html",
             static=self.static_url,
-            ws_url_path="/websocket",
+            ws_url_path=f"/websocket/{term_name}",
         )
 
+
+class CustomTermSocket(terminado.TermSocket):
+
+    def open(self, url_component: Any = None) -> None:
+        super(terminado.TermSocket, self).open(url_component)
+        url_component = (
+            url_component.decode("utf-8")
+            if isinstance(url_component, bytes)
+            else url_component
+        )
+        self.term_name = url_component
+        shell_command = [
+            cmd.replace('MRSM_SESSION', self.term_name + tmux_suffix)
+            for cmd in self.term_manager.shell_command
+        ]
+        if self.term_name not in self.term_manager.terminals:
+            self.terminal = self.term_manager.new_terminal(shell_command=shell_command)
+            self.terminal.term_name = self.term_name
+            self.term_manager.terminals[self.term_name] = self.terminal
+            self.term_manager.start_reading(self.terminal)
+        else:
+            self.terminal = self.term_manager.terminals[self.term_name]
+        self.terminal.clients.append(self)
+        self.send_json_message(["setup", {}])
+        buffered = ""
+        preopen_buffer = self.terminal.read_buffer.copy()
+        while True:
+            if not preopen_buffer:
+                break
+            s = preopen_buffer.popleft()
+            buffered += s
+        if buffered:
+            self.on_pty_read(buffered)

meerschaum/_internal/term/__init__.py

@@ -9,10 +9,14 @@ Build the web console virtual terminal using Tornado and xterm.js.
 from __future__ import annotations
 
 from typing import Optional, Tuple
+
+import meerschaum as mrsm
 from meerschaum.utils.packages import attempt_import
-from meerschaum._internal.term.TermPageHandler import TermPageHandler
+from meerschaum._internal.term.TermPageHandler import TermPageHandler, CustomTermSocket
 from meerschaum.config._paths import API_TEMPLATES_PATH, API_STATIC_PATH
 from meerschaum.utils.venv import venv_executable
+from meerschaum.utils.misc import is_tmux_available
+from meerschaum.utils.daemon._names import get_new_daemon_name
 
 tornado, tornado_ioloop, terminado = attempt_import(
     'tornado', 'tornado.ioloop', 'terminado', lazy=False,
@@ -40,16 +44,19 @@ def get_webterm_app_and_manager(
         "from meerschaum._internal.entry import get_shell; "
         f"get_shell({shell_kwargs_str}).cmdloop()"
     ]
+    webterm_cf = mrsm.get_config('system', 'webterm')
+    if webterm_cf.get('tmux', {}).get('enabled', False) and is_tmux_available():
+        commands = ['tmux', 'new-session', '-A', '-s', 'MRSM_SESSION'] + commands
 
-    term_manager = terminado.UniqueTermManager(shell_command=commands)
+    term_manager = terminado.NamedTermManager(shell_command=commands)
     handlers = [
         (
-            r"/websocket",
-            terminado.TermSocket,
+            r"/websocket/(.+)/?",
+            CustomTermSocket,
             {'term_manager': term_manager}
         ),
         (
-            r"/",
+            r"/webterm/(.+)/?",
             TermPageHandler
         ),
     ]
@@ -57,5 +64,6 @@ def get_webterm_app_and_manager(
         handlers,
         static_path=API_STATIC_PATH,
         template_path=API_TEMPLATES_PATH,
+        term_manager=term_manager,
     )
     return tornado_app, term_manager

meerschaum/_internal/term/tools.py

@@ -6,16 +6,21 @@
 Utility functions regarding the webterm.
 """
 
-from __future__ import annotations
+import meerschaum as mrsm
+from meerschaum.utils.typing import List
 
-def is_webterm_running(host: str, port: int, protocol: str = 'http') -> int:
+
+def is_webterm_running(
+    host: str,
+    port: int,
+    protocol: str = 'http',
+    session_id: str = 'mrsm',
+) -> int:
     """
     Determine whether the webterm service is running on a given host and port.
     """
-    from meerschaum.utils.networking import find_open_ports, is_port_in_use
-    from meerschaum.utils.packages import attempt_import
-    requests = attempt_import('requests')
-    url = f'{protocol}://{host}:{port}'
+    requests = mrsm.attempt_import('requests', lazy=False)
+    url = f'{protocol}://{host}:{port}/webterm/{session_id}'
     try:
         r = requests.get(url, timeout=3)
     except Exception as e:
@@ -23,3 +28,33 @@ def is_webterm_running(host: str, port: int, protocol: str = 'http') -> int:
     if not r:
         return False
     return '<title>Meerschaum Shell</title>' in r.text
+
+
+def kill_tmux_session(session: str) -> bool:
+    """
+    Kill a tmux session if it exists.
+    """
+    from meerschaum.utils.process import run_process
+    command = ['tmux', 'kill-session', '-t', session]
+    return run_process(command, capture_output=True) == 0
+
+
+def get_mrsm_tmux_sessions() -> List[str]:
+    """
+    Return a list of tmux sessions created by Meerschaum.
+    """
+    from meerschaum.utils.process import run_process
+    tmux_suffix = mrsm.get_config('system', 'webterm', 'tmux', 'session_suffix')
+    command = ['tmux', 'ls']
+    proc = run_process(command, capture_output=True, as_proc=True)
+    if proc.returncode != 0:
+        return []
+    sessions = [
+        line.split(':', maxsplit=1)[0]
+        for line in proc.stdout.read().decode('utf-8').split('\n')
+    ]
+    return [
+        session
+        for session in sessions
+        if session.endswith(tmux_suffix)
+    ]

meerschaum/actions/api.py

@@ -140,16 +140,28 @@ def _api_start(
         If provided, serve over HTTPS with this certfile.
         Requires `--keyfile`.
     """
+    import json
+    import sys
+    import shutil
+    import pathlib
+    from copy import deepcopy
+
     from meerschaum.utils.packages import (
-        attempt_import, venv_contains_package, pip_install, run_python_package
+        attempt_import,
+        venv_contains_package,
+        pip_install,
+        run_python_package,
     )
     from meerschaum.utils.misc import is_int, filter_keywords
+    from meerschaum.utils.dtypes import json_serialize_value
     from meerschaum.utils.formatting import pprint, ANSI, _init
     from meerschaum.utils.debug import dprint
     from meerschaum.utils.warnings import error, warn
     from meerschaum.config import get_config, _config
     from meerschaum.config._paths import (
-        API_UVICORN_RESOURCES_PATH, API_UVICORN_CONFIG_PATH, CACHE_RESOURCES_PATH,
+        API_UVICORN_RESOURCES_PATH,
+        API_UVICORN_CONFIG_PATH,
+        CACHE_RESOURCES_PATH,
         PACKAGE_ROOT_PATH,
     )
     from meerschaum.config._patch import apply_patch_to_config
@@ -157,8 +169,6 @@ def _api_start(
     from meerschaum.config.static import STATIC_CONFIG, SERVER_ID
     from meerschaum.connectors.parse import parse_instance_keys
     from meerschaum.utils.pool import get_pool
-    import shutil
-    from copy import deepcopy
 
     if action is None:
         action = []
@@ -256,7 +266,6 @@ def _api_start(
     custom_keys = ['mrsm_instance', 'no_dash', 'no_auth', 'private', 'debug', 'production']
 
     ### write config to a temporary file to communicate with uvicorn threads
-    import json, sys
     try:
         if uvicorn_config_path.exists():
             os.remove(uvicorn_config_path)
@@ -275,12 +284,25 @@ def _api_start(
     MRSM_RUNTIME = STATIC_CONFIG['environment']['runtime']
     MRSM_PATCH = STATIC_CONFIG['environment']['patch']
     MRSM_ROOT_DIR = STATIC_CONFIG['environment']['root']
-    env_dict = {
+    env_dict = {}
+    env_dict.update({
         MRSM_SERVER_ID: SERVER_ID,
         MRSM_RUNTIME: 'api',
         MRSM_CONFIG: json.loads(os.environ.get(MRSM_CONFIG, '{}')),
         'FORWARDED_ALLOW_IPS': forwarded_allow_ips,
-    }
+        'TERM': os.environ.get('TERM', 'screen-256color'),
+        'SHELL': os.environ.get('SHELL', '/bin/bash'),
+        'LANG': os.environ.get('LANG', 'C.UTF-8'),
+        'HOME': os.environ.get('HOME', pathlib.Path.home().as_posix()),
+        'PATH': os.environ.get(
+            'PATH',
+            (
+                '/usr/local/bin:/usr/local/sbin:/usr/sbin:/usr/bin:/sbin:/bin:'
+                f'{pathlib.Path.home().as_posix().rstrip("/")}/.local/bin'
+            )
+        ),
+        'HOSTNAME': os.environ.get('HOSTNAME', 'api'),
+    })
     for env_var in get_env_vars():
         if env_var in env_dict:
             continue
@@ -294,10 +316,10 @@ def _api_start(
     env_text = ''
     for key, val in env_dict.items():
         value = str(
-            json.dumps(val)
+            json.dumps(val, default=json_serialize_value)
             if isinstance(val, (dict))
             else val
-        ).replace('\\', '\\\\')
+        ).replace('\\', '\\\\').replace("'", "'\\''")
         env_text += f"{key}='{value}'\n"
     with open(uvicorn_env_path, 'w+', encoding='utf-8') as f:
         if debug:
@@ -329,7 +351,11 @@ def _api_start(
         for key, val in env_dict.items():
             gunicorn_args += [
                 '--env', key + "="
-                + (json.dumps(val) if isinstance(val, (dict, list)) else val)
+                + (
+                    json.dumps(val, default=json_serialize_value)
+                    if isinstance(val, (dict, list))
+                    else val
+                )
             ]
         if workers is not None:
             gunicorn_args += ['--workers', str(workers)]

meerschaum/actions/start.py

@@ -314,6 +314,11 @@ def _start_gui(
     """
     Start the Meerschaum GUI application.
     """
+    import json
+    import time
+    import uuid
+    import platform
+
     from meerschaum.utils.venv import venv_exec
     from meerschaum.utils.packages import attempt_import
     from meerschaum.utils.warnings import warn
@@ -321,17 +326,14 @@ def _start_gui(
     from meerschaum.utils.networking import find_open_ports
     from meerschaum.connectors.parse import parse_instance_keys
     from meerschaum._internal.term.tools import is_webterm_running
-    import platform
     webview, requests = attempt_import('webview', 'requests')
-    import json
-    import time
 
     success, msg = True, "Success"
     host = '127.0.0.1'
     if port is None:
         port = 8765
 
-    if not is_webterm_running(host, port):
+    if not is_webterm_running(host, port, session_id='mrsm'):
         port = next(find_open_ports(port, 9000))
 
     api_kw = {
@@ -350,7 +352,7 @@ def _start_gui(
     )
     if debug:
         print(start_tornado_code)
-    base_url = 'http://' + api_kw['host'] + ':' + str(api_kw['port'])
+    base_url = 'http://' + api_kw['host'] + ':' + str(api_kw['port']) + '/webterm/mrsm'
 
     process = venv_exec(
         start_tornado_code, as_proc=True, debug=debug, capture_output=(not debug)
@@ -375,7 +377,7 @@ def _start_gui(
     try:
         webview.create_window(
             'Meerschaum Shell', 
-            f'http://127.0.0.1:{port}',
+            f'http://127.0.0.1:{port}/webterm/mrsm',
             height=650,
             width=1000
         )
@@ -415,8 +417,13 @@ def _start_webterm(
         - `-i`, '--instance'
             The default instance to use for the Webterm shell.
     """
+    import uuid
     from meerschaum._internal.term import get_webterm_app_and_manager, tornado_ioloop
-    from meerschaum._internal.term.tools import is_webterm_running
+    from meerschaum._internal.term.tools import (
+        is_webterm_running,
+        get_mrsm_tmux_sessions,
+        kill_tmux_session,
+    )
     from meerschaum.utils.networking import find_open_ports
     from meerschaum.utils.warnings import info
 
@@ -426,19 +433,23 @@ def _start_webterm(
         port = 8765
     if sysargs is None:
         sysargs = ['start', 'webterm']
+    session_id = 'mrsm'
     tornado_app, term_manager = get_webterm_app_and_manager(instance_keys=mrsm_instance)
 
-    if is_webterm_running(host, port):
+    if is_webterm_running(host, port, session_id=session_id):
         if force:
             port = next(find_open_ports(port + 1, 9000))
         else:
             return False, (
-                f"The webterm is already running at http://{host}:{port}\n\n"
+                f"The webterm is already running at http://{host}:{port}/webterm/{session_id}\n\n"
                 + "    Include `-f` to start another server on a new port\n"
                 + "    or specify a different port with `-p`."
             )
     if not nopretty:
-        info(f"Starting the webterm at http://{host}:{port} ...\n    Press CTRL+C to quit.")
+        info(
+            f"Starting the webterm at http://{host}:{port}/webterm/{session_id} ..."
+            "\n    Press CTRL+C to quit."
+        )
     tornado_app.listen(port, host)
     loop = tornado_ioloop.IOLoop.instance()
     try:
@@ -451,6 +462,10 @@ def _start_webterm(
         term_manager.shutdown()
         loop.close()
 
+    sessions = get_mrsm_tmux_sessions()
+    for session in sessions:
+        kill_tmux_session(session)
+
     return True, "Success"
 
 

meerschaum/api/dash/callbacks/dashboard.py

@@ -190,6 +190,7 @@ def update_page_layout_div(
     Input('go-button', 'n_clicks'),
     Input('get-pipes-button', 'n_clicks'),
     Input('get-jobs-button', 'n_clicks'),
+    Input('show-webterm-button', 'n_clicks'),
     Input('get-plugins-button', 'n_clicks'),
     Input('get-users-button', 'n_clicks'),
     Input('get-graphs-button', 'n_clicks'),
@@ -229,7 +230,7 @@ def update_content(*args):
     ### NOTE: functions MUST return a list of content and a list of alerts
     triggers = {
         'go-button': lambda x: ([], []),
-        'cancel-button': lambda x: ([], []),
+        'show-webterm-button': lambda x: ([], []),
         'get-pipes-button': get_pipes_cards,
         'get-jobs-button': get_jobs_cards,
         'get-plugins-button': get_plugins_cards,
@@ -251,7 +252,12 @@ def update_content(*args):
     webterm_style = {
         'display': (
             'none'
-            if trigger not in ('instance-select', 'cancel-button', 'go-button')
+            if trigger not in (
+                'instance-select',
+                'cancel-button',
+                'go-button',
+                'show-webterm-button',
+            )
             else 'block'
         )
     }
@@ -650,6 +656,41 @@ dash_app.clientside_callback(
     State('mrsm-location', 'href'),
 )
 
+dash_app.clientside_callback(
+    """
+    function(n_clicks, url){
+        if (!n_clicks) { return dash_clientside.no_update; }
+        iframe = document.getElementById('webterm-iframe');
+        if (!iframe){ return dash_clientside.no_update; }
+
+        iframe.contentWindow.postMessage(
+            {
+                action: "__TMUX_NEW_WINDOW"
+            },
+            url
+        );
+        return dash_clientside.no_update;
+    }
+    """,
+    Output('mrsm-location', 'href'),
+    Input('webterm-new-tab-button', 'n_clicks'),
+    State('mrsm-location', 'href'),
+)
+
+dash_app.clientside_callback(
+    """
+    function(n_clicks, url){
+        if (!n_clicks) { return dash_clientside.no_update; }
+        iframe = document.getElementById('webterm-iframe');
+        if (!iframe){ return dash_clientside.no_update; }
+        iframe.src = iframe.src;
+        return dash_clientside.no_update;
+    }
+    """,
+    Output('mrsm-location', 'href'),
+    Input('webterm-refresh-button', 'n_clicks'),
+    State('mrsm-location', 'href'),
+)
 
 @dash_app.callback(
     Output(component_id='connector-keys-input', component_property='value'),

meerschaum/api/dash/components.py

@@ -23,7 +23,7 @@ dex = attempt_import('dash_extensions', lazy=False, check_update=CHECK_UPDATE)
 dash_ace = attempt_import('dash_ace', lazy=False, check_update=CHECK_UPDATE)
 _load_builtin_custom_connectors()
 
-go_button = dbc.Button('Execute', id='go-button', color='primary', style={'width': '100%'})
+go_button = dbc.Button('Exec', id='go-button', color='primary', style={'width': '100%'})
 test_button = dbc.Button('Test', id='test-button', color='danger', style={'display': 'none'})
 get_items_menu = dbc.DropdownMenu(
     label='More', id='get-items-menu', children=[
@@ -50,19 +50,26 @@ show_jobs_button = dbc.Button(
     style={'width': '100%'},
 )
 cancel_button = dbc.Button(
-    'Terminal',
+    'Term',
     id='cancel-button',
     color='dark',
     style={'width': '100%', 'background-color': 'black', 'display': 'none'},
 )
+show_webterm_button = dbc.Button(
+    'Term',
+    id='show-webterm-button',
+    color='dark',
+    style={'width': '100%', 'background-color': 'black'},
+)
 bottom_buttons_content = dbc.Card(
     dbc.CardBody(
         dbc.Row([
-            dbc.Col(go_button, lg=3, md=4, sm=12),
-            dbc.Col(show_pipes_button, lg=3, md=4, sm=12),
-            dbc.Col(show_jobs_button, lg=3, md=4, sm=12),
+            dbc.Col(go_button, xl=2, lg=3, md=3, sm=12),
+            dbc.Col(show_pipes_button, xl=2, lg=3, md=3, sm=12),
+            dbc.Col(show_jobs_button, xl=2, lg=3, md=3, sm=12),
+            dbc.Col(show_webterm_button, xl=2, lg=3, md=3, sm=12),
             dbc.Col(lg=True, md=False, sm=False),
-            dbc.Col(get_items_menu, lg=2, md=12, sm=12),
+            dbc.Col(get_items_menu, xl=2, lg=12, md=12, sm=12),
         ])
     )
 )