pywebexec 1.9.1__py3-none-any.whl → 1.9.2__py3-none-any.whl

pywebexec/pywebexec.py

@@ -306,10 +306,10 @@ def print_urls(command_id=None):
     if token:
         url_params = f"?token={token}"
     if command_id:
-        print(f"web popup: {protocol}://{hostname}:{args.port}/dopopup/{command_id}{url_params}", flush=True)
-        print(f"web popup: {protocol}://{ip}:{args.port}/dopopup/{command_id}{url_params}", flush=True)
-        print(f"raw output: {protocol}://{hostname}:{args.port}/command_output_raw/{command_id}{url_params}", flush=True)
-        print(f"raw output: {protocol}://{ip}:{args.port}/command_output_raw/{command_id}{url_params}", flush=True)
+        print(f"web popup: {protocol}://{hostname}:{args.port}/commands/{command_id}/dopopup{url_params}", flush=True)
+        print(f"web popup: {protocol}://{ip}:{args.port}/commands/{command_id}/dopopup{url_params}", flush=True)
+        print(f"raw output: {protocol}://{hostname}:{args.port}/commands/{command_id}/output_raw{url_params}", flush=True)
+        print(f"raw output: {protocol}://{ip}:{args.port}/commands/{command_id}/output_raw{url_params}", flush=True)
     else:
         print(f"web commands: {protocol}://{hostname}:{args.port}{url_params}", flush=True)
         print(f"web commands: {protocol}://{ip}:{args.port}{url_params}", flush=True)
@@ -619,7 +619,7 @@ def log_error(fromip, user, message):
 def log_request(message):
     log_info(request.remote_addr, session.get('username', '-'), message)
 
-@app.route('/stop_command/<command_id>', methods=['POST'])
+@app.route('/commands/<command_id>/stop', methods=['PATCH'])
 def stop_command(command_id):
     log_request(f"stop_command {command_id}")
     status = read_command_status(command_id)
@@ -629,7 +629,6 @@ def stop_command(command_id):
     pid = status['pid']
     end_time = datetime.now(timezone.utc).isoformat()
     try:
-        #update_command_status(command_id, 'aborted', end_time=end_time, exit_code=-15)
         os.killpg(os.getpgid(pid), 15)  # Send SIGTERM to the process group
         return jsonify({'message': 'Command aborted'})
     except Exception as e:
@@ -704,7 +703,7 @@ def verify_ldap(username, password):
         print(f"LDAP authentication failed: {e}")
         return False
 
-@app.route('/run_command', methods=['POST'])
+@app.route('/commands', methods=['POST'])
 def run_command_endpoint():
     data = request.json
     command = data.get('command')
@@ -745,7 +744,7 @@ def run_command_endpoint():
 
     return jsonify({'message': 'Command is running', 'command_id': command_id})
 
-@app.route('/command_status/<command_id>', methods=['GET'])
+@app.route('/commands/<command_id>', methods=['GET'])
 def get_command_status(command_id):
     status = read_command_status(command_id)
     if not status:
@@ -763,7 +762,7 @@ def list_commands():
     commands.sort(key=lambda x: x['start_time'], reverse=True)
     return jsonify(commands)
 
-@app.route('/command_output/<command_id>', methods=['GET'])
+@app.route('/commands/<command_id>/output', methods=['GET'])
 def get_command_output(command_id):
     offset = int(request.args.get('offset', 0))
     maxsize = int(request.args.get('maxsize', 10485760))
@@ -787,7 +786,7 @@ def get_command_output(command_id):
             'cols': status_data.get("cols"),
             'rows': status_data.get("rows"),
             'links': {
-                'next': f'{request.url_root}command_output/{command_id}?offset={new_offset}&maxsize={maxsize}{token_param}'
+                'next': f'{request.url_root}commands/{command_id}/output?offset={new_offset}&maxsize={maxsize}{token_param}'
             }
         }
         if request.headers.get('Accept') == 'text/plain':
@@ -795,7 +794,7 @@ def get_command_output(command_id):
         return jsonify(response)
     return jsonify({'error': 'Invalid command_id'}), 404
 
-@app.route('/command_output_raw/<command_id>', methods=['GET'])
+@app.route('/commands/<command_id>/output_raw', methods=['GET'])
 def get_command_output_raw(command_id):
     offset = int(request.args.get('offset', 0))
     @stream_with_context
@@ -825,11 +824,11 @@ def list_executables():
     executables.sort()  # Sort the list of executables alphabetically
     return jsonify(executables)
 
-@app.route('/popup/<command_id>')
+@app.route('/commands/<command_id>/popup')
 def popup(command_id):
     return render_template('popup.html', command_id=command_id)
 
-@app.route('/dopopup/<command_id>')
+@app.route('/commands/<command_id>/dopopup')
 def do_popup(command_id):
     token = request.args.get('token', '')
     token_param = f'?token={token}' if token else ''
@@ -838,7 +837,7 @@ def do_popup(command_id):
     <head>
         <script type="text/javascript">
             window.onload = function() {{
-                window.open('/popup/{command_id}{token_param}', '_blank', 'width=1000,height=600');
+                window.open('/commands/{command_id}/popup{token_param}', '_blank', 'width=1000,height=600');
                 window.close();
             }};
         </script>

pywebexec/static/js/popup.js

@@ -161,13 +161,14 @@ async function viewOutput(command_id) {
     slider.value = 1000;
     adjustOutputHeight();
     currentCommandId = command_id;
-    nextOutputLink = `/command_output/${command_id}${urlToken}`;
+    nextOutputLink = `/commands/${command_id}/output${urlToken}`;
     clearInterval(outputInterval);
     terminal.clear();
     terminal.reset();
     fullOutput = '';
     try {
-        const response = await fetch(`/command_status/${command_id}${urlToken}`);
+        // Updated endpoint below:
+        const response = await fetch(`/commands/${command_id}${urlToken}`);
         if (!response.ok) {
             return;
         }
@@ -256,7 +257,7 @@ window.addEventListener('load', () => {
     slider = document.getElementById('outputSlider');
     slider.addEventListener('input', sliderUpdateOutput);
     adjustOutputHeight();
-    const commandId = window.location.pathname.split('/').slice(-1)[0];
+    const commandId = window.location.pathname.split('/').slice(-2)[0];
     viewOutput(commandId);
 });
 

pywebexec/static/js/script.js

@@ -122,7 +122,7 @@ document.getElementById('launchForm').addEventListener('submit', async (event) =
     fitAddon.fit();
     terminal.clear();
     try {
-        const response = await fetch(`/run_command${urlToken}`, {
+        const response = await fetch(`/commands${urlToken}`, {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json'
@@ -133,7 +133,6 @@ document.getElementById('launchForm').addEventListener('submit', async (event) =
             throw new Error('Failed to launch command');
         }
         const data = await response.json();
-        //await new Promise(r => setTimeout(r, 300));// not ok
         viewOutput(data.command_id);
         fetchCommands();
         commandInput.focus()
@@ -253,13 +252,13 @@ async function viewOutput(command_id) {
     outputPercentage.innerText = '100%';
     adjustOutputHeight();
     currentCommandId = command_id;
-    nextOutputLink = `/command_output/${command_id}${urlToken}`;
+    nextOutputLink = `/commands/${command_id}/output${urlToken}`; // updated URL
     clearInterval(outputInterval);
     terminal.clear();
     terminal.reset();
     fullOutput = '';
     try {
-        const response = await fetch(`/command_status/${command_id}${urlToken}`);
+        const response = await fetch(`/commands/${command_id}${urlToken}`);
         if (!response.ok) {
             outputInterval = setInterval(() => fetchOutput(nextOutputLink), 500);
         }
@@ -290,7 +289,7 @@ async function viewOutput(command_id) {
 async function openPopup(command_id, event) {
     event.stopPropagation();
     event.stopImmediatePropagation();
-    const popupUrl = `/popup/${command_id}${urlToken}`;
+    const popupUrl = `/commands/${command_id}/popup${urlToken}`;
     window.open(popupUrl, '_blank', 'width=1000,height=600');
 }
 
@@ -298,7 +297,7 @@ async function relaunchCommand(command_id, event) {
     event.stopPropagation();
     event.stopImmediatePropagation();
     try {
-        const response = await fetch(`/command_status/${command_id}${urlToken}`);
+        const response = await fetch(`/commands/${command_id}${urlToken}`);
         if (!response.ok) {
             throw new Error('Failed to fetch command status');
         }
@@ -309,7 +308,7 @@ async function relaunchCommand(command_id, event) {
         }
         fitAddon.fit();
         terminal.clear();
-        const relaunchResponse = await fetch(`/run_command${urlToken}`, {
+        const relaunchResponse = await fetch(`/commands${urlToken}`, {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json'
@@ -337,8 +336,8 @@ async function stopCommand(command_id, event) {
     event.stopPropagation();
     event.stopImmediatePropagation();
     try {
-        const response = await fetch(`/stop_command/${command_id}${urlToken}`, {
-            method: 'POST'
+        const response = await fetch(`/commands/${command_id}/stop${urlToken}`, {
+            method: 'PATCH'
         });
         if (!response.ok) {
             throw new Error('Failed to stop command');

pywebexec/swagger.yaml

@@ -3,7 +3,12 @@ info:
   title: PyWebExec API
   version: "1.0"
 paths:
-  /run_command:
+  /commands:
+    get:
+      summary: "List commands status"
+      responses:
+        "200":
+          description: "List of all commands status"
     post:
       summary: "Run a command"
       consumes:
@@ -29,7 +34,7 @@ paths:
       responses:
         "200":
           description: "Command started"
-  /command_status/{command_id}:
+  /commands/{command_id}:
     get:
       summary: "Get command status"
       parameters:
@@ -40,15 +45,39 @@ paths:
       responses:
         "200":
           description: "Command status returned"
-  /commands:
+  /commands/{command_id}/output:
     get:
-      summary: "List commands"
+      summary: "Get command output"
+      parameters:
+        - in: path
+          name: command_id
+          required: true
+          type: string
+        - in: query
+          name: offset
+          type: integer
+          default: 0
+        - in: query
+          name: maxsize
+          type: integer
+          default: 10485760
+      responses:
+        "200":
+          description: "Command output returned"
+  /commands/{command_id}/stop:
+    patch:
+      summary: "Stop a running command"
+      parameters:
+        - in: path
+          name: command_id
+          required: true
+          type: string
       responses:
         "200":
-          description: "List of all commands"
+          description: "Command stopped successfully"
   /executables:
     get:
-      summary: "List executables"
+      summary: "List available executable commands"
       responses:
         "200":
           description: "List of executables returned as an array of executable names"

pywebexec/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.9.1'
-__version_tuple__ = version_tuple = (1, 9, 1)
+__version__ = version = '1.9.2'
+__version_tuple__ = version_tuple = (1, 9, 2)

{pywebexec-1.9.1.dist-info → pywebexec-1.9.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pywebexec
-Version: 1.9.1
+Version: 1.9.2
 Summary: Simple Python HTTP Exec Server
 Home-page: https://github.com/joknarf/pywebexec
 Author: Franck Jouvanceau
@@ -200,10 +200,10 @@ $ curl http://myhost:8080/command_output/<command_id> -H "Accept: text/plain"
 
 | method    | route                       | params/payload     | returns
 |-----------|-----------------------------|--------------------|---------------------|
-| POST      | /run_command                | command: str<br>params: array[str]<br>rows: int<br>cols: int       | command_id: uuid<br>message: str    |
-| POST      | /stop_command/command_id    |                    | message: str        |
-| GET       | /command_status/command_id  |                    | command_id: uuid<br>command: str<br>params: array[str]<br>start_time: isotime<br>end_time: isotime<br>status: str<br>exit_code: int<br>last_output_line: str      |
-| GET       | /commands                   |                    | array of<br>command_id: uuid<br>command: str<br>start_time: isotime<br>end_time: isotime<br>status: str<br>exit_code: int<br>last_output_line: str      |
 | GET       | /executables                |                    | array of str        |
-| GET       | /command_output/command_id  | offset: int        | output: str<br>status: str<br>links: { next: str }         |
-| GET       | /command_output_raw/command_id  | offset: int        | output: stream raw output until end of command<br>curl -Ns http://srv/command_output_raw/command_id|
+| GET       | /commands                   |                    | array of<br>command_id: uuid<br>command: str<br>start_time: isotime<br>end_time: isotime<br>status: str<br>exit_code: int<br>last_output_line: str      |
+| GET       | /commands/{id}  |                    | command_id: uuid<br>command: str<br>params: array[str]<br>start_time: isotime<br>end_time: isotime<br>status: str<br>exit_code: int<br>last_output_line: str      |
+| GET       | /commands/{id}/output    | offset: int        | output: str<br>status: str<br>links: { next: str }         |
+| GET       | /commands/{id}/output_raw  | offset: int        | output: stream raw output until end of command<br>curl -Ns http://srv/commands/{id}/output_raw|
+| POST      | /commands                | command: str<br>params: array[str]<br>rows: int<br>cols: int       | command_id: uuid<br>message: str    |
+| PATCH      | /commands/{id}/stop    |                    | message: str        |

{pywebexec-1.9.1.dist-info → pywebexec-1.9.2.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=VJH7C8MI18Ybx0KHrPiBsVy17xpO4pfd_KXoNIkVBxg,33724
-pywebexec/swagger.yaml,sha256=0AI4KfQI5ezTF8PP4E_ER6dfiseBi3SiOk6OUj5DjcA,1253
-pywebexec/version.py,sha256=0TTXzdumH9yE7lSKUOdvHb1HJBaZX7fxyxuZNWj70Cg,511
+pywebexec/pywebexec.py,sha256=uGOdA0nQ4Na9F12vZYXVBr11Uk9XoYuhdM8lJxEUC0Y,33679
+pywebexec/swagger.yaml,sha256=-uafngZxQFHLdnWY-9SFCdgotO5wynFN2sTEyuBpQ_Q,1998
+pywebexec/version.py,sha256=Bx58trLhK_vl5EzDfK18POHZa_BoHwqv52T5hR9tbaA,511
 pywebexec/static/css/style.css,sha256=SuOU_USRh8BiAxEJ1LDYIx3asf3lETu_evWzA54gsBo,8145
 pywebexec/static/css/xterm.css,sha256=uo5phWaUiJgcz0DAzv46uoByLLbJLeetYosL1xf68rY,5559
 pywebexec/static/fonts/CommitMonoNerdFontMono-Regular.ttf,sha256=v6nZdSx5cs_TIic8Fujrjzg9u9glWjorDIr7RlwNceM,2370228
@@ -24,8 +24,8 @@ 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/js/commands.js,sha256=TmfcauQlfIeAeC8pwQvKspc4PA_VYLbPTnVCDVBZ87I,8420
-pywebexec/static/js/popup.js,sha256=pYBwMuGnOCz4O1O-LmxHNlqHiZCn55ozbYchQraJp6Q,9222
-pywebexec/static/js/script.js,sha256=iQcl-22b4GmGLw8lY2aviC-yd8dTYZKi8cN-KoaYwvE,18216
+pywebexec/static/js/popup.js,sha256=2Ku0h8vtM4hw4wyd_agKgf8vMFf-hQBKueREV8Y0Sio,9252
+pywebexec/static/js/script.js,sha256=D7pPWiLv3ki_V4o4k0bE1wdBQrx0I2W39EmEJu-T_10,18162
 pywebexec/static/js/xterm/LICENSE,sha256=EU1P4eXTull-_T9I80VuwnJXubB-zLzUl3xpEYj2T1M,1083
 pywebexec/static/js/xterm/addon-canvas.js,sha256=ez6QTVvsmLVNJmdJlM-ZQ5bErwlxAQ_9DUmDIptl2TM,94607
 pywebexec/static/js/xterm/addon-canvas.js.map,sha256=ECBA4B-BqUpdFeRzlsEWLSQnudnhLP-yPQJ8_hKquMo,379537
@@ -40,9 +40,9 @@ pywebexec/static/js/xterm/xterm.js.map,sha256=Y7O2Pb-fIS7Z8AC1D5s04_aiW_Jf1f4mCf
 pywebexec/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pywebexec/templates/index.html,sha256=VLcuC0RUkwefDugXWcXsjd5C3owKk5wCJoYIo48xbgk,3106
 pywebexec/templates/popup.html,sha256=3kpMccKD_OLLhJ4Y9KRw6Ny8wQWjVaRrUfV9y5-bDiQ,1580
-pywebexec-1.9.1.dist-info/LICENSE,sha256=gRJf0JPT_wsZJsUGlWPTS8Vypfl9vQ1qjp6sNbKykuA,1064
-pywebexec-1.9.1.dist-info/METADATA,sha256=xo0Wz-wbREaii01oK9ro9ObeOWIIV4Zf40_5a74EGkI,8186
-pywebexec-1.9.1.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-pywebexec-1.9.1.dist-info/entry_points.txt,sha256=l52GBkPCXRkmlHfEyoVauyfBdg8o-CAtC8qQpOIjJK0,55
-pywebexec-1.9.1.dist-info/top_level.txt,sha256=vHoHyzngrfGdm_nM7Xn_5iLmaCrf10XO1EhldgNLEQ8,10
-pywebexec-1.9.1.dist-info/RECORD,,
+pywebexec-1.9.2.dist-info/LICENSE,sha256=gRJf0JPT_wsZJsUGlWPTS8Vypfl9vQ1qjp6sNbKykuA,1064
+pywebexec-1.9.2.dist-info/METADATA,sha256=-y8vqPEpfH7uCerUz2wdRlB2GTpJThP0HmFNEfrvKKo,8154
+pywebexec-1.9.2.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+pywebexec-1.9.2.dist-info/entry_points.txt,sha256=l52GBkPCXRkmlHfEyoVauyfBdg8o-CAtC8qQpOIjJK0,55
+pywebexec-1.9.2.dist-info/top_level.txt,sha256=vHoHyzngrfGdm_nM7Xn_5iLmaCrf10XO1EhldgNLEQ8,10
+pywebexec-1.9.2.dist-info/RECORD,,