ser2netweb 3.0.0__py3-none-any.whl

ser2netweb/web/templates/_cluster_body.html

@@ -0,0 +1,109 @@
+{% from "_macros.html" import state_label %}
+{% if peers_hidden %}
+<div class="banner warn">{{ _('Open access: only this node is shown. <a href="%(url)s">Sign in</a> to see and manage the other cluster nodes.', url=base ~ '/login') }}</div>
+{% endif %}
+{% if discovery_error %}
+<div class="banner warn" title="{{ discovery_error }}">{{ _("UDP auto-discovery is off: %(error)s. Manually-added peers still work (Settings → LAN cluster).", error=(discovery_error|explain or discovery_error)|trim('.')) }}</div>
+{% endif %}
+{% if notes %}
+{% for c in notes.copies %}
+<div class="banner warn">{{ _("Another node uses this node’s identity: %(name)s at %(addr)s — probably a copy of this installation (its data folder, disk or VM image). Give one of the two a new identity under Settings → LAN cluster.", name=c.name, addr=c.addr) }}</div>
+{% endfor %}
+{% for d in notes.shared %}
+<div class="banner warn">{{ _("Several nodes use the identity of %(name)s (%(addrs)s) — probably copies of one installation. Give each copy a new identity under Settings → LAN cluster on that node.", name=d.name, addrs=d.addrs|join(", ")) }}</div>
+{% endfor %}
+{% if notes.other_key %}
+<div class="banner warn">{{ _("Nodes on this network broadcast with a different cluster key, so they are not shown or contacted: %(addrs)s. Set the same key on every node (Settings → LAN cluster).", addrs=notes.other_key|join(", ")) }}</div>
+{% endif %}
+{% if notes.versions %}
+<div class="banner warn">{{ _("The cluster nodes run different versions (%(versions)s). Upgrade every node to the same version: a node can’t edit the settings another version doesn’t have (README: Upgrading a cluster).", versions=notes.versions|map("default", "?", true)|join(", ")) }}</div>
+{% endif %}
+{% if notes.legacy %}
+<div class="banner warn">{{ _("Nodes running 2.8.0 or older get the cluster key unsigned in every request: %(addrs)s. Upgrade them, then turn off legacy authentication under Settings → LAN cluster.", addrs=notes.legacy|join(", ")) }}</div>
+{% endif %}
+{% endif %}
+<div class="table-scroll">
+<table class="grid list cluster stackable">
+  <thead>
+    <tr>
+      <th>{{ _("Mapping") }}</th><th>{{ _("Serial") }}</th><th>{{ _("Network") }}</th>
+      <th>{{ _("State") }}</th><th>{{ _("Clients") }}</th><th title="{{ _('In: bytes read from the serial device · Out: bytes written to it (serial↔serial: A → B / B → A)') }}">{{ _("In / Out") }}</th><th class="col-actions"></th>
+    </tr>
+  </thead>
+  <tbody>
+  {% for n in nodes %}
+    <tr class="node-row{% if not n.online %} node-offline{% endif %}">
+      <td colspan="7">
+        <strong>{{ n.name }}</strong>
+        {% if n.self %}<span class="tag">{{ _("this node") }}</span>{% endif %}
+        {% if n.source == 'manual' %}<span class="tag">{{ _("manual") }}</span>{% endif %}
+        <span class="peer mono">{{ n.addr }}</span>
+        {% if n.reported %}<span class="muted">({{ _("its own address: %(addr)s", addr=n.reported) }})</span>{% endif %}
+        {% if n.online %}
+          <span class="muted"> · {{ _("up %(uptime)s", uptime=n.uptime) }}{% if n.version %} · v{{ n.version }}{% endif %} · {{ _("%(running)s/%(total)s running", running=n.running_count, total=n.mapping_count) }}</span>
+          {% if n.age == 'older' %}<span class="tag tag-warn">{{ _("older version") }}</span>{% elif n.age == 'newer' %}<span class="tag tag-warn">{{ _("newer version") }}</span>{% endif %}
+          {% if not n.self and 'control' not in n.caps %}<span class="tag" title="{{ _('This node runs a version before 2.6.0, which can’t be managed from another node. Upgrade it.') }}">{{ _("view only") }}</span>
+          {% elif not n.self and 'edit' not in n.caps %}<span class="tag" title="{{ _('This node runs a version that can’t be edited from another node (2.6.0). Upgrade it.') }}">{{ _("no remote edit") }}</span>{% endif %}
+          {% if n.auth == 'legacy' %}<span class="tag tag-warn" title="{{ _('A node running 2.8.0 or older: it gets the cluster key unsigned in every request. Upgrade it.') }}">{{ _("unsigned key") }}</span>{% endif %}
+          {% if n.previous_key %}<span class="tag tag-warn" title="{{ _('It accepts only the previous cluster key: set the new key on it.') }}">{{ _("previous key") }}</span>{% endif %}
+        {% elif n.problem == 'key' %}
+          <span class="state state-error">{{ _("cluster key rejected — check the key on that node") }}</span>
+        {% elif n.problem == 'cluster-off' %}
+          <span class="state state-error">{{ _("its cluster is switched off") }}</span>
+        {% elif n.problem == 'legacy-off' %}
+          <span class="state state-error">{{ _("2.8.0 or older — legacy authentication is off on this node") }}</span>
+        {% elif n.problem == 'manual-only' %}
+          <span class="state state-error">{{ _("2.8.0 or older and doesn’t advertise its LAN address — add it as a manual peer (Settings → LAN cluster) to manage it") }}</span>
+        {% elif n.problem == 'unsigned' %}
+          <span class="state state-error">{{ _("its answer is not signed with the cluster key") }}</span>
+        {% elif n.problem == 'clock' %}
+          <span class="state state-error">{{ _("its clock could not be matched") }}</span>
+        {% else %}
+          <span class="state state-error">{{ _("offline / unreachable") }}</span>
+        {% endif %}
+        {% if not n.self and n.online and n.url %}<a class="btn sm" href="{{ n.url }}" target="_blank" rel="noopener">{{ _("Open") }}</a>{% endif %}
+      </td>
+    </tr>
+    {% for m in n.mappings %}
+    {# ids as in _mappings_body.html, by the node's address: this node's own mappings are
+       in this table too #}
+    {% set rid = 'c-' ~ ((n.addr ~ '-' ~ m.id)|domid) %}
+    <tr>
+      <td class="indent col-name"><span id="{{ rid }}-name">{{ m.name|softbreak }}</span>{% if not m.enabled %} <span class="tag">{{ _("disabled") }}</span>{% endif %}</td>
+      <td class="mono" data-label="{{ _('Serial') }}">{{ m.serial|softbreak }}</td>
+      <td data-label="{{ _('Network') }}">
+        <div class="mono">{{ m.endpoint|softbreak }}</div>
+        <div class="sub mono">{{ m.kind }}</div>
+      </td>
+      <td data-label="{{ _('State') }}"><span class="state state-{{ m.state }}">{{ state_label(m.state) }}</span>{% if m.link == 'down' %} <span class="tag tag-warn">{{ _("link down") }}</span>{% endif %}</td>
+      <td data-label="{{ _('Clients') }}">{{ m.client_count }}</td>
+      <td class="mono nowrap" data-label="{{ _('In / Out') }}"><span id="{{ rid }}-bytes">{{ m.bytes_in|default('')|bytesize }} / {{ m.bytes_out|default('')|bytesize }}</span></td>
+      <td class="col-actions">
+        {% if can_edit and not n.self and 'control' in n.caps %}
+        <div class="row-actions"><div class="btn-group">
+          {# the peer by host + port only: the server looks up its address and scheme #}
+          {% set peer = {"host": n.ip, "port": n.port, "mid": m.id} %}
+          {% if m.enabled %}
+            {#- asked only while clients are connected, as on the node itself #}
+            {#- (not `n`: that is the node, whose caps the Edit button below reads) #}
+            {% set clients = m.client_count if m.client_count is number else 0 %}
+            <button class="btn sm" id="{{ rid }}-run" aria-describedby="{{ rid }}-name" hx-post="{{ base }}/api/cluster/control-peer" hx-vals='{{ dict(peer, action="stop")|tojson }}'{% if clients %} hx-confirm="{{ ngettext('Stop “%(name)s”? %(num)s connected client will be disconnected, and it stays stopped until it is started again.', 'Stop “%(name)s”? %(num)s connected clients will be disconnected, and it stays stopped until it is started again.', clients, name=m.name) }}"{% endif %} hx-swap="none" hx-disabled-elt="this">{{ _("Stop") }}</button>
+            <button class="btn sm" id="{{ rid }}-restart" aria-describedby="{{ rid }}-name" hx-post="{{ base }}/api/cluster/control-peer" hx-vals='{{ dict(peer, action="restart")|tojson }}'{% if clients %} hx-confirm="{{ ngettext('Restart “%(name)s”? %(num)s connected client will be disconnected.', 'Restart “%(name)s”? %(num)s connected clients will be disconnected.', clients, name=m.name) }}"{% endif %} hx-swap="none" hx-disabled-elt="this">{{ _("Restart") }}</button>
+          {% else %}
+            <button class="btn sm" id="{{ rid }}-run" aria-describedby="{{ rid }}-name" hx-post="{{ base }}/api/cluster/control-peer" hx-vals='{{ dict(peer, action="start")|tojson }}' hx-swap="none" hx-disabled-elt="this">{{ _("Start") }}</button>
+          {% endif %}
+          {% if 'edit' in n.caps %}<button class="btn sm" id="{{ rid }}-edit" aria-describedby="{{ rid }}-name" hx-get="{{ base }}/api/cluster/peer-form?{{ peer|urlencode }}" hx-target="#form-panel" hx-swap="innerHTML show:top">{{ _("Edit") }}</button>{% endif %}
+        </div></div>
+        {% endif %}
+      </td>
+    </tr>
+    {% endfor %}
+    {% if n.online and not n.mappings %}
+    <tr><td class="indent muted" colspan="7">{{ _("no mappings on this node") }}</td></tr>
+    {% endif %}
+  {% else %}
+    <tr><td colspan="7" class="muted">{{ _("No cluster nodes yet. Auto-discovery beacons run every few seconds; add manual peers under Settings → LAN cluster for routed networks.") }}</td></tr>
+  {% endfor %}
+  </tbody>
+</table>
+</div>

ser2netweb/web/templates/_console.html

@@ -0,0 +1,21 @@
+<div class="form-head">
+  <h3 id="panel-title" tabindex="-1">{{ _("Console — %(name)s", name=mapping_name|softbreak) }}</h3>
+  <div class="actions">
+    {% if interactive %}<span class="muted" data-text-only>{{ _("type to send to the device") }}</span>
+    <span class="muted">{{ _("Shift+Tab leaves the console") }}</span>
+    {#- a serial BREAK on the device's port (audited): the answer says it in the feedback
+        area, as a refusal (read-only, port not open) does #}
+    <button type="button" class="btn sm" id="console-break" hx-post="{{ base }}/api/mappings/{{ mid }}/break" hx-swap="none" hx-disabled-elt="this">{{ _("Send BREAK") }}</button>
+    {% else %}<span class="muted">{{ _("read-only") }}</span>{% endif %}
+    <button type="button" class="btn sm" data-term-mode>{{ _("Hex view") }}</button>
+    <button type="button" class="btn sm" id="console-close" data-cancel>{{ _("Close") }}</button>
+  </div>
+</div>
+<p class="muted mb-sm" data-mode-help>{% if interactive %}{{ _("Text view: what the device sends; what you type goes to the device.") }}{% else %}{{ _("Text view: what the device sends.") }}{% endif %} {% if bridge %}{{ _("Hex view: both directions with timestamps (A → B / B → A).") }}{% elif to_device %}{{ _("Hex view: both directions with timestamps (from / to the device).") }}{% else %}{{ _("Hex view: what the device sends, with timestamps.") }}{% endif %}{% if encoding and encoding != 'utf-8' %} {{ _("Text encoding: %(encoding)s.", encoding=encoding|upper) }}{% endif %}</p>
+<div id="term" class="term"
+     data-ws="{{ base }}/api/mappings/{{ mid }}/console"
+     data-ws-hex="{{ base }}/api/mappings/{{ mid }}/traffic"
+     data-bridge="{{ '1' if bridge else '0' }}"
+     data-interactive="{{ '1' if interactive else '0' }}"
+     data-mode="{{ 'hex' if hex_first else 'text' }}"
+     data-charset="{{ charset or '' }}"></div>

ser2netweb/web/templates/_footer.html

@@ -0,0 +1,13 @@
+{#- The footer of every page: the licence and where the source code is (AGPL-3.0 section 13;
+    ser2netweb/licences.py). `signed_in`: the version and the licences page too (they name what
+    this copy runs, which a page before the sign-in doesn't show). Import it with context. #}
+{% macro site_footer(signed_in) %}
+<footer class="site-footer">
+  <span>ser2netweb{% if signed_in %} {{ app_version }}{% endif %}</span>
+  <span>{{ _("AGPL-3.0 or a commercial licence") }}</span>
+  <a href="{{ source_url }}" rel="noopener noreferrer">{{ _("Source code") }}</a>
+  {%- if signed_in %}
+  <a href="{{ base }}/licenses">{{ _("Licences") }}</a>
+  {%- endif %}
+</footer>
+{% endmacro %}

ser2netweb/web/templates/_login_notice.html

@@ -0,0 +1,8 @@
+{# the notice an admin set for the sign-in and setup pages (Settings -> Web UI access): plain
+   text, escaped, line breaks kept (.notice-text); its link opens on its own #}
+{% if login_notice or login_notice_url %}
+<div class="banner notice" id="notice">
+  {%- if login_notice %}<p class="notice-text">{{ login_notice }}</p>{% endif -%}
+  {%- if login_notice_url %}<p><a href="{{ login_notice_url }}" target="_blank" rel="noopener noreferrer">{{ _("Read the full notice") }}</a></p>{% endif -%}
+</div>
+{% endif %}

ser2netweb/web/templates/_macros.html

@@ -0,0 +1,21 @@
+{# shared bits of markup; import with {% from "_macros.html" import ... %} #}
+{% macro state_label(s) -%}
+  {%- if s == 'running' -%}{{ _("running") }}
+  {%- elif s == 'stopped' -%}{{ _("stopped") }}
+  {%- elif s == 'reconnecting' -%}{{ _("reconnecting") }}
+  {%- elif s == 'device-missing' -%}{{ _("device missing") }}
+  {%- elif s == 'error' -%}{{ _("error") }}
+  {%- else -%}{{ s }}{%- endif -%}
+{%- endmacro %}
+
+{% macro lang_switch(request, lang, here=none) -%}
+{#- back to this page: its path (without the base path) and query (the sign-in page's
+    ?next=, the audit log's filters) - or `here`, the address that a page sent as the
+    answer to a form names (the form's own URL may answer only POST) #}
+{%- set back = here or (route_path(request) ~ ('?' ~ request.url.query if request.url.query else '')) %}
+<span class="lang-switch" role="group" aria-label="{{ _('Language') }}">
+  {%- for code, label in languages.items() -%}
+  <a href="{{ base_path(request) }}/lang/{{ code }}?next={{ back|urlencode }}" hreflang="{{ code }}" lang="{{ code }}" title="{{ label }}"{% if code == lang %} aria-current="true" class="on"{% endif %}>{{ code|upper }}</a>
+  {%- endfor -%}
+</span>
+{%- endmacro %}