pywebexec 2.2.8__py3-none-any.whl → 2.3.0__py3-none-any.whl

pywebexec/pywebexec.py

@@ -12,17 +12,23 @@ import string
 from datetime import datetime, timezone, timedelta
 import time
 import shlex
-from gunicorn.app.base import Application
+import platform
+import pexpect
+
+if platform.system() != 'Windows':
+    from gunicorn.app.base import Application
+    import pwd
+    import fcntl
+    import termios
+else:
+    from waitress import serve
+    import winpty
 import ipaddress
 from socket import socket, AF_INET, SOCK_STREAM
 import ssl
 import re
-import pwd
 from secrets import token_urlsafe
-import pexpect
 import signal
-import fcntl
-import termios
 import struct
 import subprocess
 import logging
@@ -138,24 +144,24 @@ def generate_selfsigned_cert(hostname, ip_addresses=None, key=None):
 
     return cert_pem, key_pem
 
+if platform.system() != 'Windows':
+    class PyWebExec(Application):
 
-class PyWebExec(Application):
-
-    def __init__(self, app, options=None):
-        self.options = options or {}
-        self.application = app
-        super().__init__()
+        def __init__(self, app, options=None):
+            self.options = options or {}
+            self.application = app
+            super().__init__()
 
-    def load_config(self):
-        config = {
-            key: value for key, value in self.options.items()
-            if key in self.cfg.settings and value is not None
-        }
-        for key, value in config.items():
-            self.cfg.set(key.lower(), value)
+        def load_config(self):
+            config = {
+                key: value for key, value in self.options.items()
+                if key in self.cfg.settings and value is not None
+            }
+            for key, value in config.items():
+                self.cfg.set(key.lower(), value)
 
-    def load(self):
-        return self.application
+        def load(self):
+            return self.application
                                                                                                     #38;2;66;59;165m
 ANSI_ESCAPE = re.compile(br'(?:\x1B[@-Z\\-_]|\x1B([(]B|>)|(?:\x1B\[|\x9B)[0-?]*[ -/]*[@-~]|\x1B\[([0-9]{1,2};){0,4}[0-9]{1,3}[m|K]|\x1B\[[0-9;]*[mGKHF]|[\x00-\x1F\x7F])')
 ANSI_ESCAPE = re.compile(br'(?:\x1B[@-Z\\-_]|\x1B([(]B|>)|(?:\x1B\[|\x9B)[0-?]*[ -/]*[@-~]|\x1B\[([0-9]{1,2};){0,4}[0-9]{1,3}[m|K]|\x1B\[[0-9;]*[mGKHF])')
@@ -455,7 +461,7 @@ def update_command_status(command_id, updates):
         del status['last_read']
     with open(status_file_path, 'w') as f:
         json.dump(status, f)
-    os.sync()
+        os.fsync(f)
     status_cache[command_id] = status
 
 
@@ -507,7 +513,6 @@ def script(output_file):
 
 
 def run_command(fromip, user, command, params, command_id, rows, cols):
-    # app.logger.info(f'{fromip} run_command {command_id} {user}: {command} {params}')
     log_info(fromip, user, f'run_command {command_id}: {command_str(command, params)}')
     start_time = datetime.now(timezone.utc).isoformat()
     if user:
@@ -524,41 +529,68 @@ def run_command(fromip, user, command, params, command_id, rows, cols):
     })
     output_file_path = get_output_file_path(command_id)
     try:
-        with open(output_file_path, 'wb') as fd:
-            p = pexpect.spawn(command, params, ignore_sighup=True, timeout=None, dimensions=(rows, cols))
+        if platform.system() == 'Windows':
+            # On Windows, use winpty
+            cmdline = f"{sys.executable} -u {command} " + " ".join(shlex.quote(p) for p in params)
+            with open(output_file_path, 'wb', buffering=0) as fd:
+                p = winpty.PTY(cols, rows)
+                p.spawn(cmdline)
+                pid = p.pid
+                update_command_status(command_id, {
+                    'pid': pid,
+                })
+                while True:
+                    try:
+                        if not p.isalive():
+                            time.sleep(1)
+                        data = p.read(10485760, blocking=False)
+                        fd.write(data.encode())
+                        if not p.isalive():
+                            break
+                        time.sleep(0.1)
+                    except (EOFError, winpty.WinptyError):
+                        break
+                status = p.get_exitstatus()
+                del p
+                print("end", status)
+        else:
+            # On Unix, use pexpect
+            with open(output_file_path, 'wb') as fd:
+                p = pexpect.spawn(command, params, ignore_sighup=True, timeout=None, dimensions=(rows, cols))
+                update_command_status(command_id, {
+                    'pid': p.pid,
+                })
+                p.logfile = fd
+                p.expect(pexpect.EOF)
+                fd.flush()
+                status = p.wait()
+
+        end_time = datetime.now(timezone.utc).isoformat()
+        # Update the status based on the result
+        if status is None:
+            exit_code = -15
             update_command_status(command_id, {
-                'pid': p.pid,
+                'status': 'aborted',
+                'end_time': end_time,
+                'exit_code': exit_code,
             })
-            p.logfile = fd
-            p.expect(pexpect.EOF)
-            fd.flush()
-            status = p.wait()
-            end_time = datetime.now(timezone.utc).isoformat()
-            # Update the status based on the result
-            if status is None:
-                exit_code = -15
+            log_info(fromip, user, f'run_command {command_id}: {command_str(command, params)}: command aborted')
+        else:
+            exit_code = status
+            if exit_code == 0:
                 update_command_status(command_id, {
-                    'status': 'aborted',
+                    'status': 'success',
                     'end_time': end_time,
                     'exit_code': exit_code,
                 })
-                log_info(fromip, user, f'run_command {command_id}: {command_str(command, params)}: command aborted')
+                log_info(fromip, user, f'run_command {command_id}: {command_str(command, params)}: completed successfully')
             else:
-                exit_code = status
-                if exit_code == 0:
-                    update_command_status(command_id, {
-                        'status': 'success',
-                        'end_time': end_time,
-                        'exit_code': exit_code,
-                    })
-                    log_info(fromip, user, f'run_command {command_id}: {command_str(command, params)}: completed successfully')
-                else:
-                    update_command_status(command_id, {
-                        'status': 'failed',
-                        'end_time': end_time,
-                        'exit_code': exit_code,
-                    })
-                    log_info(fromip, user, f'run_command {command_id}: {command_str(command, params)}: exit code {exit_code}')
+                update_command_status(command_id, {
+                    'status': 'failed',
+                    'end_time': end_time,
+                    'exit_code': exit_code,
+                })
+                log_info(fromip, user, f'run_command {command_id}: {command_str(command, params)}: exit code {exit_code}')
 
     except Exception as e:
         end_time = datetime.now(timezone.utc).isoformat()
@@ -661,7 +693,7 @@ app.config['TITLE'] = f"{args.title} API"
 
 
 def get_executable(cmd):
-    if os.path.isfile(cmd) and os.access(cmd, os.X_OK):
+    if os.path.isfile(cmd) and os.access(cmd, os.X_OK) and Path(cmd).suffix not in [".help", ".yaml", ".env", ".swp"]:
         help_file = f"{cmd}.help"
         help_text = ""
         if os.path.exists(help_file) and os.path.isfile(help_file):
@@ -688,14 +720,17 @@ def get_executables():
 def stop_command(command_id):
     log_request(f"stop_command {command_id}")
     status = read_command_status(command_id)
+    user = session.get('username', '-')
     if not status or 'pid' not in status:
         return jsonify({'error': 'Invalid command_id or command not running'}), 400
 
     pid = status['pid']
     end_time = datetime.now(timezone.utc).isoformat()
     try:
-        os.killpg(os.getpgid(pid), 15)  # Send SIGTERM to the process group
-        return jsonify({'message': 'Command aborted'})
+        try:
+            os.killpg(os.getpgid(pid), signal.SIGTERM)  # Send SIGTERM to the process group
+        except:
+            os.kill(pid, signal.SIGINT)  # Send SIGTERM to the process
     except Exception as e:
         update_command_status(command_id, {
             'status': 'aborted',
@@ -703,6 +738,10 @@ def stop_command(command_id):
             'exit_code': -15,
         })
         return jsonify({'error': 'Failed to terminate command'}), 500
+    output_file = get_output_file_path(command_id)
+    with open(output_file, 'a') as f:
+        f.write(f"\n\nCommand aborted by user {user} at {end_time}\n")
+    return jsonify({'message': 'Command aborted'})
 
 
 @app.before_request
@@ -846,6 +885,8 @@ def run_dynamic_command(cmd):
         if isinstance(data_params, dict):
             params = ""
             for param in schema_params.keys():
+                if not data_params.get(param, None) and schema_params[param].get("type", None) == "object":
+                    data_params[param] = '{}'
                 if not param in data_params:
                     continue
                 value = data_params[param]
@@ -1160,6 +1201,15 @@ def main():
             pywebexec.terminate()
         sys.exit(res)
 
+    if platform.system() == 'Windows':
+        # Use waitress on Windows
+        ssl_context = None
+        if args.cert:
+            ssl_context = (args.cert, args.key)
+        serve(app, host=args.listen, port=args.port, url_scheme='https' if args.cert else 'http', threads=8)
+        return 0
+
+    # Use gunicorn on Unix-like systems
     if args.action == "start":
         return start_gunicorn(daemonized=True, baselog=basef)
     if args.action:

pywebexec/static/js/executables.js

@@ -260,12 +260,13 @@ paramsInput.addEventListener('focus', () => {
     const currentCmd = commandInput.value;
     paramsInput.name = currentCmd;
     if (gExecutables[currentCmd] && gExecutables[currentCmd].schema && gExecutables[currentCmd].schema.properties && paramsContainer.style.display == 'none') {
+        const schema = gExecutables[currentCmd].schema;
         jsForm = createSchemaForm($('#schemaForm'), gExecutables[currentCmd].schema, async function (errors, values) {
             const commandName = commandInput.value;
             fitAddon.fit();
             terminal.clear();
             payload = { params: values, rows: terminal.rows, cols: terminal.cols }
-            if ('parallel' in values) {
+            if (schema.schema_options && schema.schema_options.batch_param && 'parallel' in values) {
                 payload['parallel'] = values['parallel'];
                 payload['delay'] = values['delay'];
                 delete payload['params']['parallel'];
@@ -301,7 +302,6 @@ paramsInput.addEventListener('focus', () => {
             input1.focus();
         }
         schemaFormPW.addEventListener('submit', (event) => {
-            console.log('Form submitted');
             paramsContainer.style.display = 'none';
             event.preventDefault();
         });

pywebexec/static/js/schemaform.js

@@ -251,7 +251,7 @@ function createSchemaForm($form, schema, onSubmit, schemaName) {
   err.classList.add('alert');
   err.style.display = 'none';
   schemaForm.appendChild(err);
-  validateSchemaForm(schemaForm, formDesc, schema, value, schemaName);
+  validateSchemaForm(schemaForm, formDesc, schema, jsform.root.getFormValues(), schemaName);
   schemaForm.querySelectorAll('textarea').forEach(txt => {
     txt.style.height = "0";  
     setTimeout(() => adjustTxtHeight(txt), 1);

pywebexec/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.2.8'
-__version_tuple__ = version_tuple = (2, 2, 8)
+__version__ = version = '2.3.0'
+__version_tuple__ = version_tuple = (2, 3, 0)

{pywebexec-2.2.8.dist-info → pywebexec-2.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pywebexec
-Version: 2.2.8
+Version: 2.3.0
 Summary: Simple Python HTTP Exec Server
 Home-page: https://github.com/joknarf/pywebexec
 Author: Franck Jouvanceau
@@ -52,16 +52,18 @@ Classifier: Topic :: System :: Systems Administration
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: python-daemon>=2.3.2
+Requires-Dist: python-daemon>=2.3.2; platform_system != "Windows"
 Requires-Dist: cryptography>=40.0.2
 Requires-Dist: Flask>=2.0.3
 Requires-Dist: Flask-HTTPAuth>=4.8.0
 Requires-Dist: pexpect>=4.9.0
-Requires-Dist: gunicorn>=21.2.0
+Requires-Dist: gunicorn>=21.2.0; platform_system != "Windows"
 Requires-Dist: ldap3>=2.9.1
 Requires-Dist: pyte>=0.8.1
 Requires-Dist: PyYAML>=6.0.1
 Requires-Dist: run-para>=1.0.2
+Requires-Dist: waitress>=3.0.2; platform_system == "Windows"
+Requires-Dist: pywinpty>=2.0.15; platform_system == "Windows"
 Dynamic: license-file
 
 [![Pypi version](https://img.shields.io/pypi/v/pywebexec.svg)](https://pypi.org/project/pywebexec/)

{pywebexec-2.2.8.dist-info → pywebexec-2.3.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
 pywebexec/__init__.py,sha256=197fHJy0UDBwTTpGCGortZRr-w2kTaD7MxqdbVmTEi0,61
 pywebexec/host_ip.py,sha256=Ud_HTflWVQ8789aoQ2RZdT1wGI-ccvrwSWGz_c7T3TI,1241
-pywebexec/pywebexec.py,sha256=R-jp9BiUMJZW7m9N9kQC6dpIueUgFVDo4n9_GFb1rOs,45734
+pywebexec/pywebexec.py,sha256=q2q4NVgWeMmAegM-iK8J9B175snHyHkW45WYPlHYJpQ,47727
 pywebexec/swagger.yaml,sha256=I_oLpp7Hqel8SDEEykvpmCT-Gv3ytGlziq9bvQOrtZY,7598
-pywebexec/version.py,sha256=IzlbUXKZ3t6SO6-P3X0oVBlXDGkJ-oDKEhIOPY9IVKQ,511
+pywebexec/version.py,sha256=U--yqU7RFo8hQQm8oopUGYLkafj4phNIVfkf5HFEal8,511
 pywebexec/static/css/form.css,sha256=XC_0ES5yMHYz0S2OHR0RAboQN7fBUmg5ZIq8Qm5rHP0,5806
 pywebexec/static/css/markdown.css,sha256=br4-iK9wigTs54N2KHtjgZ4KLH0THVSvJo-XZAdMHiE,1970
 pywebexec/static/css/style.css,sha256=R1VOPNV2ztROKy9Fgf3tvUrtuKagY027tFJ8C866yWU,9991
@@ -33,9 +33,9 @@ pywebexec/static/images/resume.svg,sha256=99LP1Ya2JXakRCO9kW8JMuT_4a_CannF65Eiuw
 pywebexec/static/images/running.svg,sha256=fBCYwYb2O9K4N3waC2nURP25NRwZlqR4PbDZy6JQMww,610
 pywebexec/static/images/success.svg,sha256=NVwezvVMplt46ElW798vqGfrL21Mw_DWHUp_qiD_FU8,489
 pywebexec/static/images/swagger-ui.svg,sha256=FR0yeOVwe4zCYKZAjCGcT_m0Mf25NexIVaSXifIkoU0,2117
-pywebexec/static/js/executables.js,sha256=jB4QqWi4Qeq1uJflTSqqjsZy-ec9iy5ZmFvfNWMzXq4,11913
+pywebexec/static/js/executables.js,sha256=cTgCFHr_F9bFCirtfG_uR32vOY3vNUr4Ih3Wglj5lFc,11988
 pywebexec/static/js/popup.js,sha256=O3DEWnyb5yGW9tjODYycc-ujWndyAfnJMxulaQeogtc,9700
-pywebexec/static/js/schemaform.js,sha256=VEI6itnu9SKltIpfnCDDQKYglsAa8z1xvUP0FpSGe3E,9602
+pywebexec/static/js/schemaform.js,sha256=NlFXFKJI53izxPXct3a5XiB1RhWGt0_EIp6o1HfsryU,9624
 pywebexec/static/js/script.js,sha256=yQP2dWwTObWbg6ROeKFxwYi1NfDd2gxEn2e3oL-FWL8,18379
 pywebexec/static/js/swagger-form.js,sha256=CLcSHMhk5P4-_2MIRBoJLgEnIj_9keDDSzUugXHZjio,4565
 pywebexec/static/js/js-yaml/LICENSE,sha256=oHvCRGi5ZUznalR9R6LbKC0HcztxXbTHOpi9Y5YflVA,1084
@@ -67,9 +67,9 @@ pywebexec/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
 pywebexec/templates/index.html,sha256=w18O2plH_yS8bqlPsu5hwFFmCj9H2hWLSV8B6ADcSwU,3900
 pywebexec/templates/popup.html,sha256=3kpMccKD_OLLhJ4Y9KRw6Ny8wQWjVaRrUfV9y5-bDiQ,1580
 pywebexec/templates/swagger_ui.html,sha256=MAPr-z96VERAecDvX37V8q2Nxph-O0fNDBul1x2w9SI,1147
-pywebexec-2.2.8.dist-info/licenses/LICENSE,sha256=gRJf0JPT_wsZJsUGlWPTS8Vypfl9vQ1qjp6sNbKykuA,1064
-pywebexec-2.2.8.dist-info/METADATA,sha256=Dr-b4gxKWPpV0us8pkVqOdFsitPKbGHMFQcZYgzkSYA,12832
-pywebexec-2.2.8.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-pywebexec-2.2.8.dist-info/entry_points.txt,sha256=l52GBkPCXRkmlHfEyoVauyfBdg8o-CAtC8qQpOIjJK0,55
-pywebexec-2.2.8.dist-info/top_level.txt,sha256=vHoHyzngrfGdm_nM7Xn_5iLmaCrf10XO1EhldgNLEQ8,10
-pywebexec-2.2.8.dist-info/RECORD,,
+pywebexec-2.3.0.dist-info/licenses/LICENSE,sha256=gRJf0JPT_wsZJsUGlWPTS8Vypfl9vQ1qjp6sNbKykuA,1064
+pywebexec-2.3.0.dist-info/METADATA,sha256=y1F2WI5mfVSDdt_GznPWBmK07NrToa8qOjSqls1r0kM,13015
+pywebexec-2.3.0.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+pywebexec-2.3.0.dist-info/entry_points.txt,sha256=l52GBkPCXRkmlHfEyoVauyfBdg8o-CAtC8qQpOIjJK0,55
+pywebexec-2.3.0.dist-info/top_level.txt,sha256=vHoHyzngrfGdm_nM7Xn_5iLmaCrf10XO1EhldgNLEQ8,10
+pywebexec-2.3.0.dist-info/RECORD,,