lanscape 1.2.6a10__py3-none-any.whl → 1.2.6a12__py3-none-any.whl

lanscape/ui/static/js/core.js

@@ -0,0 +1,39 @@
+$(document).ready(function() {
+    rightSizeDocLayout(0,showFooter);
+    initTooltips();
+})
+
+$(window).on('resize', function() {
+    rightSizeDocLayout();
+});
+
+
+function rightSizeDocLayout(delay=20,callback=null) {
+    setTimeout(() => {
+        const content = $('#content');
+        if (content) {
+            const headerHeight = $('#header').outerHeight();
+            const footerHeight = $('footer').outerHeight();
+            const viewportHeight = $(window).height();
+
+            const newHeight = viewportHeight - headerHeight - footerHeight;
+            content.height(newHeight);
+            
+        }
+        if (callback) callback();
+    },delay);
+}
+
+function showFooter() {
+    const footer = $('footer');
+    footer.removeClass('div-hide');
+    setTimeout(() => {footer.css('transform','translateY(0px)')},1);
+}
+
+
+function initTooltips() {
+    var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]'))
+    tooltipTriggerList.map(function (tooltipTriggerEl) {
+    return new bootstrap.Tooltip(tooltipTriggerEl)
+    })
+}

lanscape/ui/static/js/layout-sizing.js

@@ -0,0 +1,31 @@
+$(document).ready(function() {
+    rightSizeDocLayout(0,showFooter);
+})
+
+$(window).on('resize', function() {
+    rightSizeDocLayout();
+});
+
+
+function rightSizeDocLayout(delay=20,callback=null) {
+    setTimeout(() => {
+        const content = $('#content');
+        if (content) {
+            const headerHeight = $('#header').outerHeight();
+            const footerHeight = $('footer').outerHeight();
+            const viewportHeight = $(window).height();
+
+            const newHeight = viewportHeight - headerHeight - footerHeight;
+            content.height(newHeight);
+            
+        }
+        if (callback) callback();
+    },delay);
+}
+
+function showFooter() {
+    const footer = $('footer');
+    footer.removeClass('div-hide');
+    setTimeout(() => {footer.css('transform','translateY(0px)')},1);
+}
+

lanscape/ui/static/js/main.js

@@ -0,0 +1,208 @@
+
+
+$(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);
+    }
+    
+
+    // Handle form submission
+    $('#scan-form').on('submit', function(event) {
+        event.preventDefault();
+        if ($('#scan-submit').text() == 'Scan') {
+            submitNewScan()
+        } else {
+            terminateScan();
+        }
+        
+
+    });
+
+    // Handle filter input
+    $('#filter').on('input', function() {
+        const filter = $(this).val();
+        const currentSrc = $('#ip-table-frame').attr('src');
+        const newSrc = currentSrc.split('?')[0] + '?filter=' + filter;
+        $('#ip-table-frame').attr('src', newSrc);
+    });
+
+});
+
+function submitNewScan() {
+    const formData = {
+        subnet: $('#subnet').val(),
+        port_list: $('#port-list').text(),
+        parallelism: $('#parallelism').val()
+    };
+    $.ajax('/api/scan', {
+        data : JSON.stringify(formData),
+        contentType : 'application/json',
+        type : 'POST',
+        success: function(response) {
+            if (response.status === 'running') {
+                showScan(response.scan_id);
+            }
+        }
+    });
+}
+
+function getActiveScanId() {
+    const url = new URL(window.location.href);
+    return url.searchParams.get('scan_id');
+}
+
+function showScan(scanId) {
+    pollScanSummary(scanId);
+    setScanState(false);
+
+    $('#no-scan').addClass('div-hide');
+    $('#scan-results').removeClass('div-hide');
+    
+    $('#export-link').attr('href','/export/' + 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);
+}
+
+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) {
+        $('#port-list-dropdown').removeClass('open');
+    }
+});
+
+function setScanState(scanEnabled) {
+    const button = $('#scan-submit');
+    console.log('set scan state- scanning',scanEnabled)
+
+    if (scanEnabled) {
+        button.text("Scan");
+        button.removeClass('btn-danger').addClass('btn-primary');
+    } else {
+        button.text("Stop");
+        button.removeClass('btn-primary').addClass('btn-danger');
+    }
+}
+
+
+function resizeIframe(iframe) {
+    // Adjust the height of the iframe to match the content
+    setTimeout( () => {
+        iframe.style.height = iframe.contentWindow.document.body.scrollHeight + 'px';
+    },100);
+}
+
+function observeIframeContent(iframe) {
+    const iframeDocument = iframe.contentDocument || iframe.contentWindow.document;
+
+    // Use MutationObserver to observe changes within the iframe
+    const observer = new MutationObserver(() => {
+        resizeIframe(iframe);
+    });
+
+    // Configure the observer to watch for changes in the subtree of the body
+    observer.observe(iframeDocument.body, {
+        childList: true,
+        subtree: true,
+        attributes: true,  // In case styles/attributes change height
+    });
+}
+function terminateScan() {
+    const button = $('#scan-submit');
+    button.prop('disabled', true); 
+    const scanId = getActiveScanId();
+    $.get(`/api/scan/${scanId}/terminate`, function(ans) {
+        setScanState(true);
+        button.prop('disabled', false); 
+    });
+}
+function pollScanSummary(id) {
+    $.get(`/api/scan/${id}/summary`, function(summary) {
+        let progress = $('#scan-progress-bar');
+        if (summary.running || summary.stage == 'terminating') {
+            progress.css('height','2px');
+            progress.css('width',`${summary.percent_complete}vw`);
+            // TODO: move overview here??
+            setTimeout(() => {pollScanSummary(id)},500);
+        } else {
+            progress.css('width','100vw');
+            progress.css('background-color','var(--success-accent)')
+            setTimeout(() => {progress.css('height','0px');},500);
+            setScanState(true);
+            
+            // wait to make the width smaller for animation to be clean
+            setTimeout(() => {
+                progress.css('width','0vw');
+                progress.css('background-color','var(--primary-accent)')
+            },1000);
+        }
+        updateOverviewUI(summary);
+    });
+}
+
+function updateOverviewUI(summary) {
+    $('#scan-devices-alive').text(summary.devices.alive);
+    $('#scan-devices-scanned').text(summary.devices.scanned);
+    $('#scan-devices-total').text(summary.devices.total);
+    $('#scan-run-time').text(summary.runtime);
+    $('#scan-stage').text(summary.stage);
+}
+
+// Bind the iframe's load event to initialize the observer
+$('#ip-table-frame').on('load', function() {
+    resizeIframe(this); // Initial resizing after iframe loads
+    observeIframeContent(this); // Start observing for dynamic changes
+});
+
+
+
+$(window).on('resize', function() {
+    resizeIframe($('#ip-table-frame')[0]);
+});
+
+
+
+
+

lanscape/ui/static/js/quietReload.js

@@ -0,0 +1,23 @@
+// Reload the page gracefully every second
+// Used in 'live' iframes
+
+function quietReload() {
+    function run() {
+        $.get(document.location.href, function(data) {
+            // create a new document from the fetched data
+            var newDoc = new DOMParser().parseFromString(data, 'text/html');
+            // replace current body with the new body content
+            $('body').html($(newDoc.body).html());
+        });
+    }
+    setTimeout(function() {
+        // get current page via ajax, and replace the current page with the new one
+        try {
+            run();
+        } catch (e) {
+            console.error(e);
+            quietReload();
+        }
+    }, 1000);
+}
+quietReload();

lanscape/ui/static/js/shutdown-server.js

@@ -0,0 +1,17 @@
+$(document).ready(function() {
+    setTimeout(() => shutdownApp(), 2000);
+});
+
+
+
+function shutdownApp() {
+    // will term server before response
+    $.get('/shutdown').always(() => serverDown());
+}
+
+function serverDown() {
+    $('#shutdown-message').html('Server down.');
+    $('#shutdown-sub').html('You can close this browser window.');
+    $('#shutdown-sub-sub').html('(since your browser wont let me)');
+    setTimeout(() => window.close(),2500);
+}

lanscape/ui/static/js/subnet-info.js

@@ -0,0 +1,19 @@
+// Validation for subnet input
+
+$(document).ready(function() {
+    $('#subnet').on('input', () => subnetUpdated($('#subnet').val()));
+    subnetUpdated($('#subnet').val());
+});
+
+function subnetUpdated(input) {
+    $.getJSON(`/api/tools/subnet/test?subnet=${input}`,(data) => {
+        setSubnetValidity(data.valid);
+        $('#subnet-info').html(data.msg);
+    })
+}
+
+function setSubnetValidity(valid) { //boolean
+    if (valid) $('#scan-form').removeClass('error');
+    else $('#scan-form').addClass('error');
+    $("#scan-submit").attr("disabled",!valid);
+}

lanscape/ui/static/js/subnet-selector.js

@@ -0,0 +1,9 @@
+$(document).ready(function () {
+    // Update input box when selecting a dropdown item
+    $('.dropdown-item').on('click', function (e) {
+        e.preventDefault();
+        let selectedSubnet = $(this).text();
+        $('#subnet').val(selectedSubnet);  // Update input with selection
+        subnetUpdated(selectedSubnet); // from subnet-info.js
+    });
+});

lanscape/ui/static/lanscape.webmanifest

@@ -0,0 +1,19 @@
+{
+    "name": "LANscape",
+    "short_name": "LANscape",
+    "icons": [
+      {
+        "src": "/static/img/ico/android-chrome-192x192.png",
+        "sizes": "192x192",
+        "type": "image/png"
+      },
+      {
+        "src": "/static/img/ico/android-chrome-512x512.png",
+        "sizes": "512x512",
+        "type": "image/png"
+      }
+    ],
+    "theme_color": "#0856a9",
+    "background_color": "#1e1e1e",
+    "display": "standalone"
+  }

lanscape/ui/templates/base.html

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    {% include 'core/head.html' %}
+    {% include 'core/scripts.html' %}
+</head>
+<body>
+    
+    {% block content %}{% endblock %}
+    <footer class="div-hide">
+        <div class="version">
+            v{{app_version}}
+            {% if is_local %}
+                <span>(Local Run)</span> 
+            {% elif update_available %} 
+                <span>(Update Available)</span> 
+            {% endif %}    
+        </div>
+
+        <div id="app-actions">
+            <a href="/info">
+                <span 
+                    class="material-symbols-outlined"
+                    data-bs-toggle="tooltip" 
+                    data-bs-placement="top" 
+                    title="App info">
+                    info
+                </span>
+            </a>
+
+            {% if runtime_args.get('nogui') or runtime_args.get('headless') %}
+            <a href="/shutdown-ui">
+                <span 
+                    id="power-button" 
+                    class="material-symbols-outlined"
+                    data-bs-toggle="tooltip" 
+                    data-bs-placement="top" 
+                    title="Shutdown App">
+                    power_settings_new
+                </span>
+            </a>
+            {% endif %}
+        </div>
+        
+    </footer>
+</body>
+</html>

lanscape/ui/templates/core/head.html

@@ -0,0 +1,10 @@
+<meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>LANscape</title>
+<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet">
+<link href="{{ url_for('static', filename='css/style.css') }}" rel="stylesheet">
+<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200" />
+<link rel="apple-touch-icon" sizes="180x180" href="/static/img/ico/apple-touch-icon.png">
+<link rel="icon" type="image/png" sizes="32x32" href="/static/img/ico/favicon-32x32.png">
+<link rel="icon" type="image/png" sizes="16x16" href="/static/img/ico/favicon-16x16.png">
+<link rel="manifest" href="/static/lanscape.webmanifest">

lanscape/ui/templates/core/scripts.html

@@ -0,0 +1,5 @@
+<script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.6/dist/umd/popper.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/js/bootstrap.min.js"></script>
+<script src="https://code.jquery.com/jquery-3.7.1.min.js" integrity="sha256-/JqT3SQfawRcv/BIHPThkBvs0OEvtFFmqPF/lYI/Cxo=" crossorigin="anonymous"></script>
+<script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.9.2/dist/umd/popper.min.js"></script>
+<script src="{{ url_for('static', filename='js/core.js') }}"></script>

lanscape/ui/templates/error.html

@@ -0,0 +1,35 @@
+{% extends "base.html" %}
+
+{% block content %}
+<div id="header">
+      <!-- Header and Scan Submission Inline -->
+    <div class="d-flex justify-content-start align-items-center">
+        <h1 class="title" onclick="location.href = '/'">
+            <span>LAN</span>scape 
+        </h1>
+    </div>
+</div>
+<div class="scroll-container" id="content">
+    <div class="container-fluid my-4">
+        <h3 class="text-danger">500 - Internal Server Error</h3>
+        <h5>{{ error or 'That was unexpected.' }}</h5>
+        
+        {% if traceback %}
+        <details>
+            <summary>Traceback:</summary>
+            <div class="error-container">
+                <pre>{{traceback}}</pre>
+            </div>
+        </details>
+        {% endif %}
+
+        <button onclick="location.href='/'" class="btn btn-primary m-2">Home</button>
+
+        <a  href="https://github.com/mdennis281/LANscape/issues" target="_blank">
+            <button class="btn btn-info m-2">Github issues</button>
+        </a>
+    </div>   
+</div>
+
+{% endblock %}
+

lanscape/ui/templates/info.html

@@ -0,0 +1,67 @@
+{% extends "base.html" %}
+
+{% block content %}
+<div id="header">
+      <!-- Header and Scan Submission Inline -->
+    <div class="d-flex justify-content-start align-items-center">
+        <h1 class="title" onclick="location.href = '/'">
+            <span>LAN</span>scape 
+        </h1>
+    </div>
+</div>
+<div class="scroll-container" id="content">
+    {% if update_available %} 
+    <div class="container-fluid my-4">
+        <h3>New version available!</h3>
+        <p>
+            A new version has been published to PyPi. 
+            ({{app_version}} -> {{latest_version}})
+        </p>
+        <input type="text" readonly class="form-control mb-3 mt-3" value="pip install --upgrade lanscape --no-cache"/>
+        <a  href="https://pypi.org/project/lanscape/" target="_blank"></a>
+            <button class="btn btn-primary m-2">PyPi - Lanscape</button>
+        </a>
+    </div>  
+    {% endif %}
+    <div class="container-fluid my-4">
+        <h3>About</h3>
+        <p>
+            LANscape was born from my frustration with existing local network scanning tools 
+            alongside my desire to dive deeper into technologies like 
+            Address Resolution Protocol (ARP), threadpooling, & Python packaging. 
+            I set out to create something faster, lightweight, & easier to use.
+            This project has been a learning journey, & I hope it helps you 
+            discover more about your network as well. Enjoy!
+        </p>
+        <a  href="https://github.com/mdennis281/" target="_blank"></a>
+            <button class="btn btn-primary m-2">Github</button>
+        </a>
+        <a  href="https://github.com/mdennis281/LANscape" target="_blank">
+            <button class="btn btn-secondary m-2">Project Repo</button>
+        </a>
+    </div>  
+    <div class="container-fluid my-4">
+        <h3>Runtime Arguments</h3>
+        <table class="table table-striped table-bordered">
+            <thead class="table-dark">
+                <tr>
+                    <th>Key</th>
+                    <th>Value</th>
+                </tr>
+            </thead>
+            <tbody>
+                {% for key, value in runtime_args.items() %}
+                <tr>
+                    <td>{{ key }}</td>
+                    <td>{{ value }}</td>
+                </tr>
+                {% endfor %}
+            </tbody>
+        </table>
+    </div>
+    
+     
+</div>
+
+{% endblock %}
+

lanscape/ui/templates/main.html

@@ -0,0 +1,89 @@
+{% extends "base.html" %}
+
+{% block content %}
+<div id="header">
+      <!-- Header and Scan Submission Inline -->
+    <div class="d-flex justify-content-between align-items-center flex-wrap">
+        <h1 class="title" onclick="location.reload()">
+            <span>LAN</span>scape 
+        </h1>
+        <!-- Form -->
+        <form id="scan-form" class="d-flex align-items-end">
+            <div class="form-group me-2">
+                <div class="label-container">
+                    <label for="subnet">Subnet:</label>
+                    <div id="subnet-info"></div>
+                </div>
+                <div class="input-group">
+                    <input type="text" id="subnet" name="subnet" class="form-control" value="{{ subnet }}" placeholder="Enter subnet">
+                    <button class="btn btn-secondary dropdown-toggle" 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 mb-3">Scan</button>
+        </form>
+    </div>
+
+    <!-- Advanced Section -->
+    <details onclick="rightSizeDocLayout()">
+        <summary>Advanced</summary>
+        <div class="form-group mt-2">
+            <label for="port_list">Port List:</label>
+            <div class="port-list-wrapper">
+                <div id="port-list" class="port-list">{{port_list}}</div>
+                <div id="port-list-dropdown" class="port-list-dropdown"></div>
+            </div>
+        </div>
+        
+        <div class="form-group mt-2">
+            <label for="parallelism">Parallelism:</label>
+            <input type="range" id="parallelism" name="parallelism" min="0.25" max="3" step="0.05" value="{{parallelism}}">
+            <output id="parallelism-value">{{parallelism}}</output>
+        </div>
+    </details>
+    <div id="scan-progress-bar"></div>
+</div>
+<div id="content">
+    <div class="container-fluid my-4">
+        <!-- Scan Results -->
+        <div id="scan-results" class="div-hide">
+            <div class="d-flex justify-content-between">
+                <h2>Scan Results</h2>
+                <div id="scan-actions">
+                    <a href="" id="export-link">
+                        <span 
+                            class="material-symbols-outlined secondary-icon-btn"
+                            data-bs-toggle="tooltip" 
+                            data-bs-placement="top" 
+                            title="Export scan to json">
+                            ios_share
+                        </span>
+                    </a>
+                </div>
+            </div>
+            
+            {% include 'scan/overview.html' %}
+            <input type="text" id="filter" placeholder="Filter results" class="form-control mb-3 mt-3">
+            <div class="table-frame-container">
+                <iframe id="ip-table-frame" src=""></iframe>
+            </div>
+        </div>
+        <div id="no-scan">
+            <h2>No results to show</h2>
+            <p>Submit a scan above</p>
+        </div>
+    </div>
+</div>
+
+
+<script src="{{ url_for('static', filename='js/main.js') }}"></script>
+<script src="{{ url_for('static', filename='js/subnet-info.js') }}"></script>
+<script src="{{ url_for('static', filename='js/subnet-selector.js') }}"></script>
+{% endblock %}
+
+
+

lanscape/ui/templates/scan/export.html

@@ -0,0 +1,27 @@
+{% extends "base.html" %}
+
+{% block content %}
+<div id="header">
+    <!-- Header and Scan Submission Inline -->
+  <div class="d-flex justify-content-start align-items-center">
+      <h1 class="title" onclick="location.href = '/'">
+          <span>LAN</span>scape 
+      </h1>
+  </div>
+</div>
+<div class="scroll-container" id="#content">
+    <div class="container-fluid my-4">
+        <h3>Json Export:</h3>
+        
+        <details>
+            <summary>{{ scan.uid }}</summary>
+            <div class="error-container">
+                <pre>{{ export_json }}</pre>
+            </div>
+        </details>
+        <button onclick="location.href='/?scan_id={{scan.uid}}'" class="btn btn-primary m-2">Back</button>
+    </div>   
+</div>
+
+{% endblock %}
+