eris/eris/webserver.py

#!/usr/bin/env python3.11


import asyncio
import functools
import gzip
import http.server
import os
import pickle
import sys
import urllib.parse

import fill3
import termstr

import eris.tools as tools


USAGE = """Usage:
  eris-webserver <directory>

Example:
  eris-webserver my_project
"""


def make_page(body_html, title):
    text = f"""
<html>
    <head>
        <title>{title}</title>
        <style type="text/css">
            body {{ margin:2; background-color:black; }}
            iframe {{ height:100%;width:100%;border:1px solid white; }}
            a:focus, a:hover {{ filter:brightness(180%); }}
        </style>
    </head>
    <body>{body_html}</body>
</html>"""
    return gzip.compress(text.encode("utf-8"))


@functools.lru_cache(maxsize=100)
def make_listing_page(url_path):
    unquoted_path = urllib.parse.unquote(url_path)
    path, tool_name = os.path.split(unquoted_path)
    result = index[(path, tool_name)]
    tool = getattr(tools, tool_name)
    tool_name_colored = tools.tool_name_colored(tool, path)
    header = fill3.appearance_as_html([lscolors.path_colored(path) + " - " + tool_name_colored,
                                       termstr.TermStr(" " * 100, is_underlined=True)])
    body = fill3.appearance_as_html(result.appearance())
    return make_page(header + body, f"{path} - {tool_name}")


class Webserver(http.server.BaseHTTPRequestHandler):

    def _set_headers(self):
        self.send_response(200)
        self.send_header("Content-type", "text/html")
        self.send_header("Content-encoding", "gzip")
        self.end_headers()

    def do_GET(self):
        self._set_headers()
        if self.path == "/":
            page = main_page
        elif self.path == "/summary":
            page = summary_page
        elif "/" in self.path[1:]:
            page = make_listing_page(self.path[1:])
        else:
            return
        self.wfile.write(page)


def make_main_page(project_name):
    body_html = """
<table style="height:100%;width:100%;">
    <tr>
        <td style="height:100%;width:38.198%;">
            <iframe name=summary src="summary"></iframe></td>
        <td style="height:100%;">
            <iframe name=listing></iframe></td>
    </tr>
</table>"""
    return make_page(body_html, "Summary of " + project_name)


def make_summary_page(project_name, summary):
    summary_html, summary_styles = summary.as_html()
    body_html = "\n".join(style.as_html() for style in summary_styles) + "\n" + summary_html
    return make_page(body_html, "Summary of " + project_name)


def run(server_class=http.server.HTTPServer, handler_class=Webserver, port=8080):
    server_address = ("", port)
    httpd = server_class(server_address, handler_class)
    print(f"Starting httpd…  See http://localhost:{port}/")
    httpd.serve_forever()


def get_summary(project_path):
    pickle_path = os.path.join(project_path, tools.CACHE_PATH, "summary.pickle")
    with gzip.open(pickle_path, "rb") as file_:
        screen = pickle.load(file_)
    summary = screen._summary
    summary._jobs_added_event = asyncio.Event()
    for entry in summary._old_entries:
        summary.add_entry(entry)
    if summary.is_directory_sort:
        summary.is_directory_sort = False
        summary.sort_entries()
    return summary


def main():
    global main_page, summary_page, index
    if len(sys.argv) == 1:
        print(USAGE)
        sys.exit(1)
    project_path = os.path.abspath(sys.argv[1])
    os.chdir(project_path)
    summary = get_summary(project_path)
    project_name = os.path.basename(project_path)
    summary_page = make_summary_page(project_name, summary)
    index = {}
    for row in summary._entries:
        for result in row:
            index[(result.path[2:], result.tool.__name__)] = result.result
    main_page = make_main_page(project_name)
    run()


if __name__ == "__main__":
    main()
Revert "packaging: Bring dependencies up to date" This reverts commit a059ae81924adb205ef644b84856c9f52c046265. Python3.12 is not in the stable distros yet. 2024-07-11 20:27:19 +10:00			`#!/usr/bin/env python3.11`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00

webserver: Fix it. - Should add tests for as_html methods. 2021-11-16 11:25:40 +10:00			`import asyncio`
webserver: Use an lru cache for 100 result pages. 2021-11-18 13:11:14 +10:00			`import functools`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`import gzip`
			`import http.server`
			`import os`
			`import pickle`
webserver: Unquote urls containing quoted characters. - e.g. Caused by filenames containing spaces. 2021-11-18 21:35:59 +10:00			`import sys`
			`import urllib.parse`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00
webserver: Coding style. - Remove unnecessary function. - More import tidying. 2021-11-25 23:26:04 +10:00			`import fill3`
webserver: Add a title header to result pages. 2021-11-21 00:33:52 +10:00			`import termstr`

Rename the project to Eris. 2018-09-17 23:59:38 +10:00			`import eris.tools as tools`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00

			`USAGE = """Usage:`
Rename the project to Eris. 2018-09-17 23:59:38 +10:00			`eris-webserver <directory>`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00
			`Example:`
Rename the project to Eris. 2018-09-17 23:59:38 +10:00			`eris-webserver my_project`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`"""`


			`def make_page(body_html, title):`
webserver: Send pages gzip compressed. - Also don't need POST or HEAD. 2021-11-21 22:53:12 +10:00			`text = f"""`
webserver: Improve interface. - Put the listing on the same page, like in the tui. 2021-11-17 10:05:25 +10:00			`<html>`
			`<head>`
			`<title>{title}</title>`
			`<style type="text/css">`
			`body {{ margin:2; background-color:black; }}`
			`iframe {{ height:100%;width:100%;border:1px solid white; }}`
webserver: Add a cursor. 2021-11-18 08:07:39 +10:00			`a:focus, a:hover {{ filter:brightness(180%); }}`
webserver: Improve interface. - Put the listing on the same page, like in the tui. 2021-11-17 10:05:25 +10:00			`</style>`
			`</head>`
			`<body>{body_html}</body>`
			`</html>"""`
webserver: Send pages gzip compressed. - Also don't need POST or HEAD. 2021-11-21 22:53:12 +10:00			`return gzip.compress(text.encode("utf-8"))`
webserver: Improve interface. - Put the listing on the same page, like in the tui. 2021-11-17 10:05:25 +10:00

webserver: Use an lru cache for 100 result pages. 2021-11-18 13:11:14 +10:00			`@functools.lru_cache(maxsize=100)`
			`def make_listing_page(url_path):`
webserver: Unquote urls containing quoted characters. - e.g. Caused by filenames containing spaces. 2021-11-18 21:35:59 +10:00			`unquoted_path = urllib.parse.unquote(url_path)`
webserver: Add a title header to result pages. 2021-11-21 00:33:52 +10:00			`path, tool_name = os.path.split(unquoted_path)`
			`result = index[(path, tool_name)]`
			`tool = getattr(tools, tool_name)`
			`tool_name_colored = tools.tool_name_colored(tool, path)`
Coding style - Moved path_colored into lscolors. - Made lscolors a package. - Moved LS_COLORS.sh and LSCOLORS into lscolors. - Moved fill3.join into termstr so that lscolors can depend on termstr only. 2022-05-11 11:11:37 +10:00			`header = fill3.appearance_as_html([lscolors.path_colored(path) + " - " + tool_name_colored,`
Coding Style - Use better termstr contructor. 2022-10-20 16:26:09 +10:00			`termstr.TermStr(" " * 100, is_underlined=True)])`
Coding style - Rename appearance_min to appearance. 2022-01-18 14:37:12 +10:00			`body = fill3.appearance_as_html(result.appearance())`
webserver: Add a title header to result pages. 2021-11-21 00:33:52 +10:00			`return make_page(header + body, f"{path} - {tool_name}")`
webserver: Use an lru cache for 100 result pages. 2021-11-18 13:11:14 +10:00

webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`class Webserver(http.server.BaseHTTPRequestHandler):`

			`def _set_headers(self):`
			`self.send_response(200)`
			`self.send_header("Content-type", "text/html")`
webserver: Send pages gzip compressed. - Also don't need POST or HEAD. 2021-11-21 22:53:12 +10:00			`self.send_header("Content-encoding", "gzip")`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`self.end_headers()`

			`def do_GET(self):`
			`self._set_headers()`
			`if self.path == "/":`
webserver: Improve interface. - Put the listing on the same page, like in the tui. 2021-11-17 10:05:25 +10:00			`page = main_page`
			`elif self.path == "/summary":`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`page = summary_page`
			`elif "/" in self.path[1:]:`
webserver: Use an lru cache for 100 result pages. 2021-11-18 13:11:14 +10:00			`page = make_listing_page(self.path[1:])`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`else:`
			`return`
webserver: Send pages gzip compressed. - Also don't need POST or HEAD. 2021-11-21 22:53:12 +10:00			`self.wfile.write(page)`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00

webserver: Improve interface. - Put the listing on the same page, like in the tui. 2021-11-17 10:05:25 +10:00			`def make_main_page(project_name):`
webserver: Coding style. - Remove unnecessary function. - More import tidying. 2021-11-25 23:26:04 +10:00			`body_html = """`
			`<table style="height:100%;width:100%;">`
			`<tr>`
			`<td style="height:100%;width:38.198%;">`
			`<iframe name=summary src="summary"></iframe></td>`
			`<td style="height:100%;">`
			`<iframe name=listing></iframe></td>`
			`</tr>`
			`</table>"""`
webserver: Improve interface. - Put the listing on the same page, like in the tui. 2021-11-17 10:05:25 +10:00			`return make_page(body_html, "Summary of " + project_name)`


webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`def make_summary_page(project_name, summary):`
			`summary_html, summary_styles = summary.as_html()`
Coding style. - Increase maximum line length from 80 to 100. 2021-11-29 12:51:34 +10:00			`body_html = "\n".join(style.as_html() for style in summary_styles) + "\n" + summary_html`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`return make_page(body_html, "Summary of " + project_name)`


Coding style. - Increase maximum line length from 80 to 100. 2021-11-29 12:51:34 +10:00			`def run(server_class=http.server.HTTPServer, handler_class=Webserver, port=8080):`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`server_address = ("", port)`
			`httpd = server_class(server_address, handler_class)`
webserver: Add example url to startup. 2021-12-05 19:46:45 +10:00			`print(f"Starting httpd… See http://localhost:{port}/")`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`httpd.serve_forever()`


webserver: Coding Style. - Extract get_summary function. 2021-11-21 01:38:16 +10:00			`def get_summary(project_path):`
Coding style. - Increase maximum line length from 80 to 100. 2021-11-29 12:51:34 +10:00			`pickle_path = os.path.join(project_path, tools.CACHE_PATH, "summary.pickle")`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`with gzip.open(pickle_path, "rb") as file_:`
			`screen = pickle.load(file_)`
webserver: Fix it. - Should add tests for as_html methods. 2021-11-16 11:25:40 +10:00			`summary = screen._summary`
			`summary._jobs_added_event = asyncio.Event()`
			`for entry in summary._old_entries:`
			`summary.add_entry(entry)`
webserver: Coding style. - Don't sort unnecessarily. 2021-11-16 16:11:32 +10:00			`if summary.is_directory_sort:`
			`summary.is_directory_sort = False`
			`summary.sort_entries()`
webserver: Coding Style. - Extract get_summary function. 2021-11-21 01:38:16 +10:00			`return summary`


			`def main():`
			`global main_page, summary_page, index`
			`if len(sys.argv) == 1:`
			`print(USAGE)`
			`sys.exit(1)`
			`project_path = os.path.abspath(sys.argv[1])`
			`os.chdir(project_path)`
			`summary = get_summary(project_path)`
			`project_name = os.path.basename(project_path)`
webserver: Fix it. - Should add tests for as_html methods. 2021-11-16 11:25:40 +10:00			`summary_page = make_summary_page(project_name, summary)`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`index = {}`
webserver: Fix it. - Should add tests for as_html methods. 2021-11-16 11:25:40 +10:00			`for row in summary._entries:`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`for result in row:`
			`index[(result.path[2:], result.tool.__name__)] = result.result`
webserver: Improve interface. - Put the listing on the same page, like in the tui. 2021-11-17 10:05:25 +10:00			`main_page = make_main_page(project_name)`
webserver: Added a simple webserver to serve a project's reports. - e.g. sudo -H vigil-webserver my_project then see http://localhost:80 2018-05-13 21:23:57 +10:00			`run()`


			`if __name__ == "__main__":`
			`main()`