lanscape 2.3.0b1__tar.gz → 2.4.0b1__tar.gz

{lanscape-2.3.0b1/lanscape.egg-info → lanscape-2.4.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lanscape
-Version: 2.3.0b1
+Version: 2.4.0b1
 Summary: A python based local network scanner
 Author-email: Michael Dennis <michael@dipduo.com>
 License-Expression: MIT
@@ -26,10 +26,12 @@ Requires-Dist: tabulate==0.9.0
 Requires-Dist: pydantic
 Requires-Dist: icmplib
 Requires-Dist: pwa-launcher>=1.1.0
+Requires-Dist: websockets<14.0,>=12.0
 Provides-Extra: dev
 Requires-Dist: pytest>=8.0; extra == "dev"
 Requires-Dist: pytest-cov>=5.0; extra == "dev"
 Requires-Dist: pytest-xdist>=3.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
 Requires-Dist: openai>=1.0.0; extra == "dev"
 Requires-Dist: pylint>=3.0; extra == "dev"
 Requires-Dist: autopep8>=2.0; extra == "dev"

{lanscape-2.3.0b1 → lanscape-2.4.0b1}/lanscape/core/net_tools.py

@@ -98,6 +98,10 @@ class Device(BaseModel):
         if self.alive:
             self.hostname = self._get_hostname()
             self._get_mac_addresses()
+            if not self.manufacturer:
+                self.manufacturer = self._get_manufacturer(
+                    self.get_mac()
+                )
 
     # Fallback for pydantic v1: use dict() and enrich output
     if not _PYD_V2:

{lanscape-2.3.0b1 → lanscape-2.4.0b1}/lanscape/core/runtime_args.py

@@ -14,6 +14,8 @@ class RuntimeArgs:
     loglevel: str = 'INFO'
     flask_logging: bool = False
     persistent: bool = False
+    ws_server: bool = False
+    ws_port: int = 8766
 
 
 def parse_args() -> RuntimeArgs:
@@ -35,6 +37,10 @@ def parse_args() -> RuntimeArgs:
                         help='Don\'t exit after browser is closed')
     parser.add_argument('--debug', action='store_true',
                         help='Shorthand debug mode (equivalent to "--loglevel DEBUG --reloader")')
+    parser.add_argument('--ws-server', action='store_true',
+                        help='Start WebSocket server instead of Flask UI')
+    parser.add_argument('--ws-port', type=int, default=8766,
+                        help='Port for WebSocket server (default: 8766)')
 
     # Parse the arguments
     args = parser.parse_args()

{lanscape-2.3.0b1 → lanscape-2.4.0b1}/lanscape/ui/main.py

@@ -16,6 +16,7 @@ from lanscape.core.logger import configure_logging
 from lanscape.core.runtime_args import parse_args
 from lanscape.core.version_manager import get_installed_version, is_update_available
 from lanscape.ui.app import start_webserver_daemon, start_webserver
+from lanscape.ui.ws.server import run_server
 # do this so any logs generated on import are displayed
 args = parse_args()
 configure_logging(args.loglevel, args.logfile, args.flask_logging)
@@ -48,6 +49,11 @@ def _main():
     else:
         log.info('Flask reloaded app.')
 
+    # Check if WebSocket server mode is requested
+    if args.ws_server:
+        start_websocket_server()
+        return
+
     args.port = get_valid_port(args.port)
 
     try:
@@ -72,6 +78,22 @@ def try_check_update():
         log.warning('Unable to check for updates.')
 
 
+def start_websocket_server():
+    """Start the WebSocket server."""
+    args.ws_port = get_valid_port(args.ws_port)
+    log.info(f'Starting WebSocket server on port {args.ws_port}')
+    log.info(f'React UI should connect to ws://localhost:{args.ws_port}')
+    
+    try:
+        run_server(host='0.0.0.0', port=args.ws_port)
+    except KeyboardInterrupt:
+        log.info('WebSocket server stopped by user')
+    except Exception as e:
+        log.critical(f'WebSocket server failed: {e}')
+        log.debug(traceback.format_exc())
+        raise
+
+
 def open_browser(url: str, wait=2) -> Popen | None:
     """
     Open a browser window to the specified

{lanscape-2.3.0b1 → lanscape-2.4.0b1}/lanscape/ui/static/css/style.css

@@ -66,13 +66,16 @@ body:has(.submodule) footer {
 
 #header {
     background-color: var(--primary-bg);
-    padding: 8px 20px;
+    padding: 8px 2%;
     margin: 0;
     display: block;
     position: relative;
     box-shadow: 0 0 10px var(--box-shadow);
     width: 100vw;
 }
+#header .title {
+    font-size: 36px;
+}
 
 footer {
     position: sticky;
@@ -163,7 +166,12 @@ details {
 
 
 #scan-form {
-    width: 500px;
+    width: 60vw;
+    margin: 0;
+    min-width: 300px;
+    max-width: 700px;
+}
+#scan-form .form-group {
     margin: 0;
 }
 #scan-form label {
@@ -304,6 +312,9 @@ details {
 }
 #advanced-modal label {
     font-size: 12px;
+    text-overflow: ellipsis;
+    overflow: hidden;
+    white-space: nowrap;
 }
 #advanced-modal .form-check {
     width: fit-content;
@@ -447,8 +458,10 @@ button {
 
 #scan-form #scan-submit {
     border: none;
-    padding: 10px 20px;
-    margin-top: 15px;
+    padding: 10px 3%;
+    margin: 0 15px;
+    min-width: 55px;
+    height: 42px;
 }
 
 /* Button Styling */
@@ -657,10 +670,6 @@ input[type="range"] {
 .table thead tr th.detail-col
 {
     width: 30px;
-    /*
-    background-color: var(--body-bg);
-    border: 1px solid var(--text-almost-hidden);
-    */
 }
 .table td:has(.info-icon-container) {
     width: 30px;
@@ -709,6 +718,12 @@ input[type="range"] {
 span.alt {
     color: var(--text-accent-color);
 }
+span.no-wrap {
+    white-space: nowrap;
+    overflow: hidden;
+    text-overflow: ellipsis;
+    display: block;
+}
 .colorful-buttons a{
     margin:2px;
     color: var(--text-color);

{lanscape-2.3.0b1 → lanscape-2.4.0b1}/lanscape/ui/static/js/core.js

@@ -1,10 +1,12 @@
 $(document).ready(function() {
     rightSizeDocLayout(0,showFooter);
     initTooltips();
+    adjustNoWrap();
 })
 
 $(window).on('resize', function() {
     rightSizeDocLayout();
+    adjustNoWrap();
 });
 
 
@@ -36,4 +38,16 @@ function initTooltips() {
     tooltipTriggerList.map(function (tooltipTriggerEl) {
     return new bootstrap.Tooltip(tooltipTriggerEl)
     })
+}
+
+/*
+    An imperfect approach to adjusting 
+    text field width within a table
+*/
+function adjustNoWrap() {
+    $('.no-wrap').width(0);
+    $('.no-wrap').each(function() {
+        var parentWidth = $(this).parent().width();
+        $(this).width(parseInt(parentWidth));
+    });
 }

{lanscape-2.3.0b1 → lanscape-2.4.0b1}/lanscape/ui/static/js/quietReload.js

@@ -8,6 +8,9 @@ function quietReload() {
             var newDoc = new DOMParser().parseFromString(data, 'text/html');
             // replace current body with the new body content
             $('body').html($(newDoc.body).html());
+            if (typeof adjustNoWrap === 'function') {
+                adjustNoWrap();
+            }
         });
     }
     setTimeout(function() {

{lanscape-2.3.0b1 → lanscape-2.4.0b1}/lanscape/ui/templates/main.html

@@ -3,45 +3,43 @@
 {% block content %}
 <div id="header">
       <!-- Header and Scan Submission Inline -->
-    <div class="d-flex justify-content-between align-items-center flex-nowrap">
+    <div class="d-flex justify-content-between align-items-center flex-wrap">
         <a href="/" class="text-decoration-none" aria-label="Go to homepage">
             <h1 class="title">
                 <span>LAN</span>scape 
             </h1>
         </a>
         <!-- Right side: settings + form -->
-        <div class="d-flex align-items-center justify-content-end ms-auto">
-            <form id="scan-form" class="d-flex align-items-center">
-                <div class="form-group me-2">
-                    <!-- Above subnet input -->
-                    <div class="label-container">
-                        <label for="subnet">Subnet:</label>
-                        <div id="subnet-info"></div>
-                    </div>
-                    <!-- Subnet input with dropdown -->
-                    <div class="input-group">
-                        <button
-                            type="button"
-                            id="settings-btn"
-                            class="btn btn-secondary start"
-                            data-bs-toggle="tooltip"
-                            data-bs-placement="bottom"
-                            title="Advanced scan settings"
-                        >
-                            <i class="fa-solid fa-gear"></i>
-                        </button>
-                        <input type="text" id="subnet" name="subnet" class="form-control" value="{{ subnet }}" placeholder="Enter subnet">
-                        <button class="btn btn-secondary dropdown-toggle end" type="button" id="subnet-dropdown" data-bs-toggle="dropdown" aria-expanded="false"></button>
-                        <ul class="dropdown-menu" aria-labelledby="subnet-dropdown" id="dropdown-list">
-                            {% for subnet_option in alternate_subnets %}
-                            <li><a class="dropdown-item" href="#">{{ subnet_option['subnet'] }}</a></li>
-                            {% endfor %}
-                        </ul>
-                    </div>
+        <form id="scan-form" class="d-flex align-items-end">
+            <div class="form-group me-2">
+                <!-- Above subnet input -->
+                <div class="label-container">
+                    <label for="subnet">Subnet:</label>
+                    <div id="subnet-info"></div>
                 </div>
-                <button type="submit" id="scan-submit" class="btn btn-primary">Scan</button>
-            </form>
-        </div>
+                <!-- Subnet input with dropdown -->
+                <div class="input-group">
+                    <button
+                        type="button"
+                        id="settings-btn"
+                        class="btn btn-secondary start"
+                        data-bs-toggle="tooltip"
+                        data-bs-placement="bottom"
+                        title="Advanced scan settings"
+                    >
+                        <i class="fa-solid fa-gear"></i>
+                    </button>
+                    <input type="text" id="subnet" name="subnet" class="form-control" value="{{ subnet }}" placeholder="Enter subnet">
+                    <button class="btn btn-secondary dropdown-toggle end" type="button" id="subnet-dropdown" data-bs-toggle="dropdown" aria-expanded="false"></button>
+                    <ul class="dropdown-menu" aria-labelledby="subnet-dropdown" id="dropdown-list">
+                        {% for subnet_option in alternate_subnets %}
+                        <li><a class="dropdown-item" href="#">{{ subnet_option['subnet'] }}</a></li>
+                        {% endfor %}
+                    </ul>
+                </div>
+            </div>
+            <button type="submit" id="scan-submit" class="btn btn-primary">Scan</button>
+        </form>
     </div>
 
     <div id="scan-progress-bar"></div>

{lanscape-2.3.0b1 → lanscape-2.4.0b1}/lanscape/ui/templates/scan/config.html

@@ -94,7 +94,7 @@
                     </div>
                     <div class="col-1 descriptor">=</div>
                     <div class="col-3">
-                        <label for="total-ping-attempts">Max pings per device</label>
+                        <label for="total-ping-attempts" id="tpa-label">Max pings per device</label>
                         <input type="number" id="total-ping-attempts" class="form-control" readonly>
                     </div>
                 </div>

{lanscape-2.3.0b1 → lanscape-2.4.0b1}/lanscape/ui/templates/scan/ip-table-row.html

@@ -7,20 +7,20 @@
             ></i>
         </div>
     </td>
-    <td>
+    <td class="ip">
         <div>{{ device.ip }}</div>
         {% if device.hostname %} 
-            <div><span class=alt>{{device.hostname}}</span></div>
+            <span class="alt no-wrap">{{device.hostname}}</span>
         {% endif %}
     </td>
-    <td>
+    <td class="mac">
         <div>{{ device.mac_addr or 'Unknown' }}</div>
         {% if device.manufacturer %} 
-            <div><span class="alt">{{device.manufacturer}}</span></div>
+            <span class="alt no-wrap">{{device.manufacturer}}</span>
         {% endif %}
     </td>
-    <td>{{ device.ports | join(", ") }}</td>
-    <td>
+    <td class="ports">{{ device.ports | join(", ") }}</td>
+    <td class="stage">
         {% if device.stage == 'complete' %}
             <span class="badge badge-success">complete</span>
         {% elif device.stage == 'found' %}

{lanscape-2.3.0b1 → lanscape-2.4.0b1}/lanscape/ui/templates/scan/ip-table.html

@@ -9,10 +9,10 @@
         <thead>
             <tr>
                 <th class="detail-col" scope="col"></th>
-                <th scope="col">IP / <span class="alt">Host</span></th>
-                <th scope="col">MAC / <span class="alt">Manufacturer</span></th>
-                <th scope="col">Open Ports</th>
-                <th scope="col">Stage</th>
+                <th class="ip" scope="col">IP / <span class="alt">Host</span></th>
+                <th class="mac" scope="col">MAC / <span class="alt">Manufacturer</span></th>
+                <th class="ports" scope="col">Open Ports</th>
+                <th class="stage" scope="col">Stage</th>
             </tr>
         </thead>
         <tbody>

lanscape-2.4.0b1/lanscape/ui/ws/__init__.py

@@ -0,0 +1,31 @@
+"""
+WebSocket interface for LANscape.
+
+Provides a standalone WebSocket server that exposes all LANscape functionality,
+allowing clients to initiate scans, manage port lists, and receive real-time
+scan results with delta updates.
+"""
+
+from lanscape.ui.ws.server import WebSocketServer, run_server
+from lanscape.ui.ws.protocol import (
+    WSMessage,
+    WSRequest,
+    WSResponse,
+    WSError,
+    WSEvent,
+    MessageType
+)
+from lanscape.ui.ws.delta import DeltaTracker, ScanDeltaTracker
+
+__all__ = [
+    'WebSocketServer',
+    'run_server',
+    'WSMessage',
+    'WSRequest',
+    'WSResponse',
+    'WSError',
+    'WSEvent',
+    'MessageType',
+    'DeltaTracker',
+    'ScanDeltaTracker'
+]

lanscape-2.4.0b1/lanscape/ui/ws/delta.py

@@ -0,0 +1,170 @@
+"""
+Delta tracking for efficient scan result updates.
+
+Uses content hashing to detect changes and only send updated data
+to clients, reducing bandwidth and improving performance.
+"""
+
+import json
+import hashlib
+from typing import Any, Optional
+
+from pydantic import BaseModel
+
+
+class DeltaState(BaseModel):
+    """
+    Represents the state of a tracked item.
+
+    Attributes:
+        hash: Content hash of the serialized data
+        data: The actual data being tracked
+    """
+    hash: str
+    data: Any
+
+
+class DeltaTracker:
+    """
+    Tracks changes to scan results and provides delta updates.
+
+    Uses MD5 hashing to detect changes in device data and scan state.
+    Clients receive only the changed portions of scan results.
+    """
+
+    def __init__(self):
+        """Initialize the delta tracker with empty state."""
+        self._states: dict[str, DeltaState] = {}
+
+    @staticmethod
+    def compute_hash(data: Any) -> str:
+        """
+        Compute MD5 hash of serialized data.
+
+        Args:
+            data: Any JSON-serializable data
+
+        Returns:
+            Hex string of the MD5 hash
+        """
+        serialized = json.dumps(data, sort_keys=True, default=str)
+        return hashlib.md5(serialized.encode()).hexdigest()
+
+    def update(self, key: str, data: Any) -> Optional[Any]:
+        """
+        Update tracked state and return data if changed.
+
+        Args:
+            key: Unique identifier for the tracked item
+            data: Current data for the item
+
+        Returns:
+            The data if it has changed, None otherwise
+        """
+        new_hash = self.compute_hash(data)
+        current_state = self._states.get(key)
+
+        if current_state is None or current_state.hash != new_hash:
+            self._states[key] = DeltaState(hash=new_hash, data=data)
+            return data
+        return None
+
+    def get_changes(self, items: dict[str, Any]) -> dict[str, Any]:
+        """
+        Get only changed items from a dictionary.
+
+        Args:
+            items: Dictionary of key -> data to check for changes
+
+        Returns:
+            Dictionary containing only the changed items
+        """
+        changes = {}
+        for key, data in items.items():
+            result = self.update(key, data)
+            if result is not None:
+                changes[key] = result
+        return changes
+
+    def reset(self, key: Optional[str] = None) -> None:
+        """
+        Reset tracked state.
+
+        Args:
+            key: Specific key to reset, or None to reset all
+        """
+        if key is not None:
+            self._states.pop(key, None)
+        else:
+            self._states.clear()
+
+    def has_key(self, key: str) -> bool:
+        """
+        Check if a key is being tracked.
+
+        Args:
+            key: The key to check
+
+        Returns:
+            True if the key is tracked, False otherwise
+        """
+        return key in self._states
+
+    def get_hash(self, key: str) -> Optional[str]:
+        """
+        Get the current hash for a tracked key.
+
+        Args:
+            key: The key to get the hash for
+
+        Returns:
+            The current hash, or None if not tracked
+        """
+        state = self._states.get(key)
+        return state.hash if state else None
+
+
+class ScanDeltaTracker(DeltaTracker):
+    """
+    Specialized delta tracker for scan results.
+
+    Tracks individual devices and overall scan metadata,
+    providing efficient delta updates for real-time scan monitoring.
+    """
+
+    def get_scan_delta(self, scan_results: dict) -> dict:
+        """
+        Get delta update for scan results.
+
+        Args:
+            scan_results: Full scan results dictionary
+
+        Returns:
+            Dictionary containing only changed fields:
+            - 'devices': List of changed device data
+            - 'metadata': Changed scan metadata (if any)
+            - 'has_changes': Boolean indicating if there are any changes
+        """
+        delta = {
+            'devices': [],
+            'metadata': None,
+            'has_changes': False
+        }
+
+        # Track metadata changes (everything except devices)
+        metadata = {k: v for k, v in scan_results.items() if k != 'devices'}
+        metadata_change = self.update('_metadata', metadata)
+        if metadata_change is not None:
+            delta['metadata'] = metadata_change
+            delta['has_changes'] = True
+
+        # Track individual device changes
+        devices = scan_results.get('devices', [])
+        for device in devices:
+            device_ip = device.get('ip', str(id(device)))
+            device_change = self.update(f'device_{device_ip}', device)
+            if device_change is not None:
+                delta['devices'].append(device_change)
+                delta['has_changes'] = True
+
+        return delta

lanscape-2.4.0b1/lanscape/ui/ws/handlers/__init__.py

@@ -0,0 +1,20 @@
+"""
+WebSocket handlers for LANscape.
+
+Provides handler classes for different functional areas:
+- ScanHandler: Network scanning operations
+- PortHandler: Port list management
+- ToolsHandler: Utility functions (subnet validation, etc.)
+"""
+
+from lanscape.ui.ws.handlers.base import BaseHandler
+from lanscape.ui.ws.handlers.scan import ScanHandler
+from lanscape.ui.ws.handlers.port import PortHandler
+from lanscape.ui.ws.handlers.tools import ToolsHandler
+
+__all__ = [
+    'BaseHandler',
+    'ScanHandler',
+    'PortHandler',
+    'ToolsHandler'
+]