lanscape 1.3.4__py3-none-any.whl → 1.3.5a2__py3-none-any.whl

lanscape/ui/blueprints/web/routes.py

@@ -1,3 +1,7 @@
+"""
+Web blueprint routes for the LANscape application.
+Handles UI views including the main dashboard, scan results, error display, and exports.
+"""
 from flask import render_template, request, redirect
 from lanscape.ui.blueprints.web import web_bp
 from lanscape.libraries.net_tools import (
@@ -12,16 +16,20 @@ from lanscape.ui.blueprints import scan_manager, log
 
 @web_bp.route('/', methods=['GET'])
 def index():
+    """
+    Render the main application interface.
+
+    Displays the primary network subnet selection interface and existing scan results.
+    If a scan_id is provided, it loads the configuration from that scan.
+    """
     subnets = get_all_network_subnets()
     subnet = smart_select_primary_subnet(subnets)
 
     port_list = 'medium'
-    parallelism = 1
     if scan_id := request.args.get('scan_id'):
         if scan := scan_manager.get_scan(scan_id):
             subnet = scan.cfg.subnet
             port_list = scan.cfg.port_list
-            parallelism = scan.cfg.t_multiplier
 
         else:
             log.debug(f'Redirecting, scan {scan_id} doesnt exist in memory')
@@ -30,7 +38,6 @@ def index():
         'main.html',
         subnet=subnet,
         port_list=port_list,
-        parallelism=parallelism,
         alternate_subnets=subnets
     )
 
@@ -38,16 +45,35 @@ def index():
 @web_bp.route('/scan/<scan_id>', methods=['GET'])
 @web_bp.route('/scan/<scan_id>/<section>', methods=['GET'])
 def render_scan(scan_id, section='all'):
+    """
+    Render a specific scan result.
+
+    Args:
+        scan_id: Unique identifier for the scan
+        section: Section of the scan results to display (default: 'all')
+
+    Returns:
+        Rendered scan template or redirect to home if scan not found
+    """
     if scanner := scan_manager.get_scan(scan_id):
         data = scanner.results.export()
-        filter = request.args.get('filter')
-        return render_template('scan.html', data=data, section=section, filter=filter)
+        filter_text = request.args.get('filter')
+        return render_template('scan.html', data=data, section=section, filter=filter_text)
     log.debug(f'Redirecting, scan {scan_id} doesnt exist in memory')
     return redirect('/')
 
 
 @web_bp.route('/errors/<scan_id>')
 def view_errors(scan_id):
+    """
+    Display errors that occurred during a scan.
+
+    Args:
+        scan_id: Unique identifier for the scan
+
+    Returns:
+        Rendered error template or redirect to home if scan not found
+    """
     if scanner := scan_manager.get_scan(scan_id):
         data = scanner.results.export()
         return render_template('scan/scan-error.html', data=data)
@@ -57,6 +83,15 @@ def view_errors(scan_id):
 
 @web_bp.route('/export/<scan_id>')
 def export_scan(scan_id):
+    """
+    Provide an exportable view of scan results.
+
+    Args:
+        scan_id: Unique identifier for the scan
+
+    Returns:
+        Rendered export template or redirect to home if scan not found
+    """
     if scanner := scan_manager.get_scan(scan_id):
         export_json = scanner.results.export(str)
         return render_template(
@@ -70,9 +105,21 @@ def export_scan(scan_id):
 
 @web_bp.route('/shutdown-ui')
 def shutdown_ui():
+    """
+    Display the shutdown confirmation page.
+
+    Returns:
+        Rendered shutdown template
+    """
     return render_template('shutdown.html')
 
 
 @web_bp.route('/info')
 def app_info():
+    """
+    Display application information and version details.
+
+    Returns:
+        Rendered info template
+    """
     return render_template('info.html')

lanscape/ui/main.py

@@ -1,4 +1,4 @@
-
+"""Main entry point for the LANscape application when running as a module."""
 import socket
 
 
@@ -7,8 +7,10 @@ import time
 import logging
 import traceback
 import os
+import requests
+
 from lanscape.libraries.logger import configure_logging
-from lanscape.libraries.runtime_args import parse_args, RuntimeArgs
+from lanscape.libraries.runtime_args import parse_args
 from lanscape.libraries.web_browser import open_webapp
 from lanscape.libraries.net_tools import is_arp_supported
 from lanscape.libraries.version_manager import get_installed_version, is_update_available
@@ -25,6 +27,7 @@ IS_FLASK_RELOAD = os.environ.get("WERKZEUG_RUN_MAIN")
 
 
 def main():
+    """core entry point for running lanscape as a module."""
     try:
         _main()
     except KeyboardInterrupt:
@@ -47,10 +50,15 @@ def _main():
     args.port = get_valid_port(args.port)
 
     if not is_arp_supported():
-        log.warning('ARP is not supported, device discovery is degraded. For more information, see the help guide: https://github.com/mdennis281/LANscape/blob/main/support/arp-issues.md')
+        warn = (
+            'ARP is not supported, device discovery is degraded. ',
+            'For more information, see the help guide: ',
+            'https://github.com/mdennis281/LANscape/blob/main/support/arp-issues.md'
+        )
+        log.warning(''.join(warn))
 
     try:
-        start_webserver_ui(args)
+        start_webserver_ui()
         log.info('Exiting...')
     except Exception as e:
         # showing error in debug only because this is handled gracefully
@@ -60,6 +68,7 @@ def _main():
 
 
 def try_check_update():
+    """Check for updates and log if available."""
     try:
         if is_update_available():
             log.info('An update is available!')
@@ -86,7 +95,8 @@ def open_browser(url: str, wait=2) -> bool:
     return False
 
 
-def start_webserver_ui(args: RuntimeArgs):
+def start_webserver_ui():
+    """Start the web server and open the UI in a browser."""
     uri = f'http://127.0.0.1:{args.port}'
 
     # running reloader requires flask to run in main thread
@@ -128,9 +138,9 @@ def get_valid_port(port: int):
 
 
 def terminate():
-    import requests
+    """send a request to the shutdown flask"""
     log.info('Attempting flask shutdown')
-    requests.get(f'http://127.0.0.1:{args.port}/shutdown?type=core')
+    requests.get(f'http://127.0.0.1:{args.port}/shutdown?type=core', timeout=2)
 
 
 if __name__ == "__main__":

lanscape/ui/shutdown_handler.py

@@ -0,0 +1,57 @@
+"""Logic for handling shutdown requests in a Flask application."""
+
+import logging
+import os
+from flask import request
+
+
+from lanscape.libraries.runtime_args import parse_args
+
+
+log = logging.getLogger('shutdown_handler')
+
+
+class FlaskShutdownHandler:
+    """Handles shutdown requests for the Flask application.
+    """
+
+    def __init__(self, app):
+        self.app = app
+        self._exiting = False
+
+    def register_endpoints(self):
+        """Register shutdown endpoints to the Flask app."""
+
+        @self.app.route('/shutdown', methods=['POST', 'GET'])
+        def shutdown():
+            req_type = request.args.get('type')
+            self.shutdown_request(req_type)
+            return "Done"
+
+        @self.app.teardown_request
+        def teardown(_):
+            self.exit_if_requested()
+
+    def shutdown_request(self, req_type: str):
+        """Handles shutdown requests based on the type of request.
+        Args:
+            req_type (str): The type of shutdown request.
+        """
+        if req_type == 'browser-close':
+            args = parse_args()
+            if args.persistent:
+                log.info('Detected browser close, not exiting flask.')
+                return "Ignored"
+            log.info(
+                'Web browser closed, terminating flask. (disable with --persistent)')
+        elif req_type == 'core':
+            log.info('Core requested exit, terminating flask.')
+        else:
+            log.info('Received external exit request. Terminating flask.')
+        self._exiting = True
+        return "Done"
+
+    def exit_if_requested(self):
+        """Exits the application if a shutdown request has been made."""
+        if self._exiting:
+            os._exit(0)

lanscape/ui/static/css/style.css

@@ -117,6 +117,7 @@ hr {
 }
 h1.title{
     cursor: pointer;
+    margin: 0;
 }
 .title span {
     color: var(--text-accent-color);
@@ -163,18 +164,21 @@ details {
     border-radius: 5px !important; /* override bootstrap stuff */
     padding-right: 34px;
     margin-right: -34px;
+    margin-left: -41px;
+    padding-left: calc(41px + 5px);
 }
 
 
 #scan-form .input-group button {
     background-color: var(--primary-bg-accent);
     border: 0;
-    border-left: 1px var(--border-color) solid;
+    
     transition: all .2s ease-in-out;
     height: 40px;
-    border-radius: 0 5px 5px 0;
     margin-top: 1px;
     transform: translateX(.5px);
+    z-index: 3;
+    margin-left: 0;
 }
 #scan-form .input-group button:hover {
     background-color: var(--primary-bg-accent-hover);
@@ -182,6 +186,15 @@ details {
 #scan-form .input-group button:active {
     background-color: var(--primary-accent);
 }
+#scan-form .input-group button.start {
+    border-radius: 5px 0 0 5px;
+    border-right: 1px var(--border-color) solid;
+    width: 40px; /* added because it looks gross on icon load */
+}
+#scan-form .input-group button.end {
+    border-radius: 0 5px 5px 0;
+    border-left: 1px var(--border-color) solid;
+}
 
 .label-container {
     display: flex;
@@ -256,8 +269,69 @@ details {
     }
 }
 
+#advanced-modal {
+    --bs-modal-width: 750px;
+}
+#advanced-modal .modal-content {
+    background-color: var(--primary-bg);
+}
+#advanced-modal .descriptor {
+    align-content: end;
+    text-align: center;
+    color: var(--text-placeholder);
+    padding-bottom: 10px;
+}
+#advanced-modal .col-2-percent {
+    flex: 0 0 auto;
+    width: 2%;
+}
+#advanced-modal label {
+    font-size: 12px;
+}
+#advanced-modal .form-check {
+    width: fit-content;
+}
+#advanced-modal h6 {
+    color: var(--primary-accent);
+}
+#advanced-modal .config-option {
+    background-color: var(--primary-bg-accent);
+    border: 1px solid var(--border-color);
+    border-radius: 5px;
+    cursor: pointer;
+    text-align: center;
+    margin: 0 5px;
+    transition: all .2s ease-in-out;
+}
 
-
+#advanced-modal .config-option.active {
+    border-color: var(--primary-accent);
+    box-shadow: 0 0 5px var(--primary-accent);
+    background-color: var(--primary-bg);
+}
+#advanced-modal .config-option:hover {
+    background-color: var(--primary-bg);
+    box-shadow: 0 0 5px var(--primary-accent);
+}
+#advanced-modal .config-option.active:hover {
+    background-color: var(--primary-bg-accent);
+    box-shadow: 0 0 5px var(--primary-accent);
+}
+#advanced-modal .config-option h5 {
+    flex-wrap: wrap;
+}
+#advanced-modal .config-option h5 span {
+    display: block; /* "waaaah span shouldnt be block" bite me. */
+    width: 100%;
+    padding: 5px;
+    font-size: 2em;
+}
+#advanced-modal .config-option p {
+    font-size: 0.8em;
+    color: var(--text-placeholder);
+    margin: 0;
+    padding: 5px;
+}
 
 
 /* Card Styles */
@@ -286,7 +360,7 @@ form {
     flex-grow: 1;
     display: flex;
     flex-direction: column;
-    margin-bottom: 15px;
+    margin-bottom: 5px;
 }
 
 label {
@@ -310,6 +384,12 @@ input[type="text"]:focus, select:focus, .form-control:focus {
     border-color: var(--primary-accent);
     outline: none;
 }
+input[type="text"]:read-only, .form-control:read-only {
+    background-color: var(--secondary-bg);
+    color: var(--text-placeholder);
+    border-color: var(--secondary-accent);
+    outline: none;
+}
 
 input::placeholder {
     color: var(--text-placeholder) !important;
@@ -326,6 +406,7 @@ button {
 #scan-form #scan-submit {
     border: none;
     padding: 10px 20px;
+    margin-top: 15px;
 }
 
 /* Button Styling */
@@ -378,20 +459,6 @@ input[type="range"] {
     margin: 5px 0;
 }
 
-input[type="range"]::-webkit-slider-thumb,
-input[type="range"]::-moz-range-thumb {
-    -webkit-appearance: none;
-    appearance: none;
-    width: 16px;
-    height: 16px;
-    border-radius: 50%;
-    background: var(--primary-accent);
-    cursor: pointer;
-}
-#parallelism-value span {
-    color: var(--text-danger-color);
-    font-weight: 500;
-}
 .port-list-wrapper {
     position: relative;
     display: inline-block;
@@ -400,12 +467,13 @@ input[type="range"]::-moz-range-thumb {
 
 .port-list {
     position: relative;
-    background-color: var(--body-bg);
+    background-color: var(--secondary-bg);
     border: 1px solid var(--border-color);
     color: var(--text-color);
     padding: 10px;
     cursor: pointer;
     width: 100%;
+    height: 42px;
     user-select: none;
     appearance: none;  /* Hide default arrow */
     transition: all .2s ease-in-out;
@@ -419,7 +487,7 @@ input[type="range"]::-moz-range-thumb {
 .port-list-wrapper::after {
     content: '▼';
     position: absolute;
-    top: 14px;
+    top: 10px;
     right: 10px;
     pointer-events: none;
     color: var(--text-color);
@@ -451,6 +519,12 @@ input[type="range"]::-moz-range-thumb {
     color: var(--text-color);
 }
 
+
+
+.text-color {
+    color: var(--text-color) !important;
+}
+
 .text-secondary {
     color: var(--secondary-accent) !important;
 }

lanscape/ui/static/js/main.js

@@ -2,21 +2,15 @@
 
 $(document).ready(function() {
     // Load port lists into the dropdown
-    getPortLists();
-    
-    $('#parallelism').on('input', function() {
-        const val = $('#parallelism').val();
-        let ans = val;
-
-        if (parseFloat(val) > 1) {
-            ans += ' <span>Warning: Increased parallelism may have inaccurate results<span>'
-        }
-        $('#parallelism-value').html(ans);
-    });
     const scanId = getActiveScanId();
     if (scanId) {
         showScan(scanId);
     }
+
+    // this prevents the browser from
+    // triggering the shutdown beacon
+    // when user clicks the logo
+    setUrlParam('loaded', 'true')
     
 
     // Handle form submission
@@ -39,18 +33,19 @@ $(document).ready(function() {
         $('#ip-table-frame').attr('src', newSrc);
     });
 
+    $('#settings-btn').on('click', function() {
+        $('#advanced-modal').modal('show');
+    });
+
 });
 
 function submitNewScan() {
-    const formData = {
-        subnet: $('#subnet').val(),
-        port_list: $('#port-list').text(),
-        parallelism: $('#parallelism').val()
-    };
+    const config = getScanConfig();
+    config.subnet = $('#subnet').val();
     $.ajax('/api/scan', {
-        data : JSON.stringify(formData),
-        contentType : 'application/json',
-        type : 'POST',
+        data: JSON.stringify(config),
+        contentType: 'application/json',
+        type: 'POST',
         success: function(response) {
             if (response.status === 'running') {
                 showScan(response.scan_id);
@@ -75,37 +70,9 @@ function showScan(scanId) {
     //$('#overview-frame').attr('src', '/scan/' + scanId + '/overview');
     $('#ip-table-frame').attr('src', '/scan/' + scanId + '/table');
     
-    // set url query string 'scan_id' to the scan_id
-    const url = new URL(window.location.href);
-    url.searchParams.set('scan_id', scanId);
-    // set url to the new url
-    window.history.pushState({}, '', url);
+    setUrlParam('scan_id', scanId);
 }
 
-function getPortLists() {
-    $.get('/api/port/list', function(data) {
-        const customSelect = $('#port-list');
-        const customSelectDropdown = $('#port-list-dropdown');
-        customSelectDropdown.empty();
-    
-        // Populate the dropdown with the options
-        data.forEach(function(portList) {
-            customSelectDropdown.append('<div>' + portList + '</div>');
-        });
-    
-        // Handle dropdown click
-        customSelect.on('click', function() {
-            customSelectDropdown.toggleClass('open');
-        });
-    
-        // Handle option selection
-        customSelectDropdown.on('click', 'div', function() {
-            const selectedOption = $(this).text();
-            customSelect.text(selectedOption);
-            customSelectDropdown.removeClass('open');
-        });
-    });
-}
 
 $(document).on('click', function(event) {
     if (!$(event.target).closest('.port-list-wrapper').length) {
@@ -234,6 +201,16 @@ $('#ip-table-frame').on('load', function() {
     observeIframeContent(this); // Start observing for dynamic changes
 });
 
+function setUrlParam(param, value) {
+    const url = new URL(window.location.href);
+    if (value === null || value === undefined) {
+        url.searchParams.delete(param);
+    } else {
+        url.searchParams.set(param, value);
+    }
+    window.history.pushState({}, '', url);
+}
+
 
 
 $(window).on('resize', function() {

lanscape/ui/static/js/scan-config.js

@@ -0,0 +1,107 @@
+let defaultScanConfigs = {};
+let activeConfigName = 'balanced';
+
+$(document).ready(function() {
+    // load port lists
+    getPortLists(function() {
+        // THEN get scan config defaults
+        getScanDefaults(function() {
+            // THEN set the default scan config
+            setScanConfig('balanced');
+        })
+    });
+    
+    $('#t_cnt_port_scan, #t_cnt_port_test').on('input', updatePortTotals);
+    $('#ping_attempts, #ping_ping_count').on('input', updatePingTotals);
+});
+
+function getScanDefaults(callback=null) {
+    $.getJSON('/api/tools/config/defaults', (data) => {
+        defaultScanConfigs = data;
+        if (callback) callback();
+    });
+}
+
+function setScanConfig(configName) {
+    const config = defaultScanConfigs[configName];
+    if (!config) return;
+    activeConfigName = configName;
+
+    // highlight selected preset
+    $('.config-option').removeClass('active');
+    $(`#config-${configName}`).addClass('active');
+
+    // basic settings
+    $('#port_list').val(config.port_list);
+    $('#t_multiplier').val(config.t_multiplier);
+    $('#t_cnt_port_scan').val(config.t_cnt_port_scan);
+    $('#t_cnt_port_test').val(config.t_cnt_port_test);
+    $('#t_cnt_isalive').val(config.t_cnt_isalive);
+    $('#task_scan_ports').prop('checked', config.task_scan_ports);
+    $('#task_scan_port_services').prop('checked', config.task_scan_port_services);
+    $('#lookup_type').val(config.lookup_type);
+
+    // ping config
+    $('#ping_attempts').val(config.ping_config.attempts);
+    $('#ping_ping_count').val(config.ping_config.ping_count);
+    $('#ping_retry_delay').val(config.ping_config.retry_delay);
+    $('#ping_timeout').val(config.ping_config.timeout);
+
+    // arp config
+    $('#arp_attempts').val(config.arp_config.attempts);
+    $('#arp_timeout').val(config.arp_config.timeout);
+
+    updatePortTotals();
+    updatePingTotals();
+}
+
+function getScanConfig() {
+    return {
+        port_list: $('#port_list').val(),
+        t_cnt_port_scan: parseInt($('#t_cnt_port_scan').val()),
+        t_cnt_port_test: parseInt($('#t_cnt_port_test').val()),
+        t_cnt_isalive: parseInt($('#t_cnt_isalive').val()),
+        task_scan_ports: $('#task_scan_ports').is(':checked'),
+        task_scan_port_services: $('#task_scan_port_services').is(':checked'),
+        lookup_type: $('#lookup_type').val(),
+        ping_config: {
+            attempts: parseInt($('#ping_attempts').val()),
+            ping_count: parseInt($('#ping_ping_count').val()),
+            retry_delay: parseFloat($('#ping_retry_delay').val()),
+            timeout: parseFloat($('#ping_timeout').val())
+        },
+        arp_config: {
+            attempts: parseInt($('#arp_attempts').val()),
+            timeout: parseFloat($('#arp_timeout').val())
+        }
+    };
+}
+
+function getPortLists(callback=null) {
+    $.get('/api/port/list', function(data) {
+        const customSelectDropdown = $('#port_list');
+        customSelectDropdown.empty();
+    
+        // Populate the dropdown with the options
+        data.forEach(function(portList) {
+            customSelectDropdown.append('<option>' + portList + '</option>');
+        });
+        if (callback) callback();
+    });
+}
+
+function updatePortTotals() {
+    const scan = parseInt($('#t_cnt_port_scan').val()) || 0;
+    const test = parseInt($('#t_cnt_port_test').val()) || 0;
+    $('#total-port-tests').val(scan * test);
+}
+
+function updatePingTotals() {
+    const attempts = parseInt($('#ping_attempts').val()) || 0;
+    const count = parseInt($('#ping_ping_count').val()) || 0;
+    $('#total-ping-attempts').val(attempts * count);
+}
+
+// expose functions globally
+window.setScanConfig = setScanConfig;
+window.getScanConfig = getScanConfig;

lanscape/ui/static/lanscape.webmanifest

@@ -13,7 +13,8 @@
         "type": "image/png"
       }
     ],
-    "theme_color": "#0856a9",
-    "background_color": "#1e1e1e",
-    "display": "standalone"
+    "theme_color": "#0a84ff",
+    "background_color": "#262626",
+    "display": "minimal-ui"
+    
   }