diff --git a/.docs/Makefile b/.docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/.docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/.docs/_autosummary/opnsense_helper.rst b/.docs/_autosummary/opnsense_helper.rst new file mode 100644 index 0000000..4bafc77 --- /dev/null +++ b/.docs/_autosummary/opnsense_helper.rst @@ -0,0 +1,6 @@ +opnsense\_helper +================ + +.. currentmodule:: opnsense_helper + +.. automodule:: opnsense_helper \ No newline at end of file diff --git a/.docs/_build/doctrees/_autosummary/opnsense_helper.doctree b/.docs/_build/doctrees/_autosummary/opnsense_helper.doctree new file mode 100644 index 0000000..d58898d Binary files /dev/null and b/.docs/_build/doctrees/_autosummary/opnsense_helper.doctree differ diff --git a/.docs/_build/doctrees/environment.pickle b/.docs/_build/doctrees/environment.pickle new file mode 100644 index 0000000..146a7d5 Binary files /dev/null and b/.docs/_build/doctrees/environment.pickle differ diff --git a/.docs/_build/doctrees/index.doctree b/.docs/_build/doctrees/index.doctree new file mode 100644 index 0000000..855340e Binary files /dev/null and b/.docs/_build/doctrees/index.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper.doctree b/.docs/_build/doctrees/opnsense_helper.doctree new file mode 100644 index 0000000..d699404 Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.commands.commands.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.commands.commands.doctree new file mode 100644 index 0000000..cdf56de Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.commands.commands.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.commands.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.commands.doctree new file mode 100644 index 0000000..9e1b518 Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.commands.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.config_manager.config_manager.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.config_manager.config_manager.doctree new file mode 100644 index 0000000..dbf5383 Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.config_manager.config_manager.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.config_manager.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.config_manager.doctree new file mode 100644 index 0000000..6f30e8b Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.config_manager.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.doctree new file mode 100644 index 0000000..6a61d3f Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.opnsense_helper.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.opnsense_helper.doctree new file mode 100644 index 0000000..7ae1177 Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.opnsense_helper.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.scripts.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.scripts.doctree new file mode 100644 index 0000000..9636109 Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.scripts.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.scripts.scripts.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.scripts.scripts.doctree new file mode 100644 index 0000000..743f412 Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.scripts.scripts.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.baseclass.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.baseclass.doctree new file mode 100644 index 0000000..c475428 Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.baseclass.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.doctree new file mode 100644 index 0000000..1a200e9 Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.exec_class.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.exec_class.doctree new file mode 100644 index 0000000..e9a047c Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.exec_class.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.frontend_utils.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.frontend_utils.doctree new file mode 100644 index 0000000..48468b3 Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.frontend_utils.doctree differ diff --git a/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.utils.doctree b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.utils.doctree new file mode 100644 index 0000000..380befd Binary files /dev/null and b/.docs/_build/doctrees/opnsense_helper/opnsense_helper.utils.utils.doctree differ diff --git a/.docs/_build/html/.buildinfo b/.docs/_build/html/.buildinfo new file mode 100644 index 0000000..703db68 --- /dev/null +++ b/.docs/_build/html/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 8247d805a62aff7d248fb9f140f8e488 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.docs/_build/html/_autosummary/opnsense_helper.html b/.docs/_build/html/_autosummary/opnsense_helper.html new file mode 100644 index 0000000..172e65c --- /dev/null +++ b/.docs/_build/html/_autosummary/opnsense_helper.html @@ -0,0 +1,104 @@ + + + + + + + + opnsense_helper — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/_sources/_autosummary/opnsense_helper.rst.txt b/.docs/_build/html/_sources/_autosummary/opnsense_helper.rst.txt new file mode 100644 index 0000000..4bafc77 --- /dev/null +++ b/.docs/_build/html/_sources/_autosummary/opnsense_helper.rst.txt @@ -0,0 +1,6 @@ +opnsense\_helper +================ + +.. currentmodule:: opnsense_helper + +.. automodule:: opnsense_helper \ No newline at end of file diff --git a/.docs/_build/html/_sources/index.rst.txt b/.docs/_build/html/_sources/index.rst.txt new file mode 100644 index 0000000..3ec7d7e --- /dev/null +++ b/.docs/_build/html/_sources/index.rst.txt @@ -0,0 +1,17 @@ +.. my-sphinx-test documentation master file, created by + sphinx-quickstart on Sun Jan 14 17:51:39 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. +Welcome to my-sphinx-test's documentation! +========================================== +.. toctree:: + :maxdepth: 2 + :caption: Contents: opnsense_helper + + +.. autosummary:: + :toctree: opnsense_helper + :recursive: + + opnsense_helper + opnsense_helper.commands.commands diff --git a/.docs/_build/html/_sources/opnsense_helper.rst.txt b/.docs/_build/html/_sources/opnsense_helper.rst.txt new file mode 100644 index 0000000..e19a8ac --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper.rst.txt @@ -0,0 +1,12 @@ +.. my-sphinx-test documentation master file, created by + sphinx-quickstart on Sun Jan 14 17:51:39 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. +Welcome to my-sphinx-test's documentation! +========================================== +.. autosummary:: + :toctree: _autosummary + :template: custom-module-template.rst + :recursive: + + opnsense_helper diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.commands.commands.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.commands.commands.rst.txt new file mode 100644 index 0000000..37f2ecb --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.commands.commands.rst.txt @@ -0,0 +1,15 @@ +opnsense\_helper.commands.commands +================================== + +.. automodule:: opnsense_helper.commands.commands + + + .. rubric:: Classes + + .. autosummary:: + + Commands + configctl + pluginctl + reconfigure + \ No newline at end of file diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.commands.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.commands.rst.txt new file mode 100644 index 0000000..ce75b12 --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.commands.rst.txt @@ -0,0 +1,13 @@ +opnsense\_helper.commands +========================= + +.. automodule:: opnsense_helper.commands + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + commands diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.config_manager.config_manager.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.config_manager.config_manager.rst.txt new file mode 100644 index 0000000..7463fdf --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.config_manager.config_manager.rst.txt @@ -0,0 +1,15 @@ +opnsense\_helper.config\_manager.config\_manager +================================================ + +.. automodule:: opnsense_helper.config_manager.config_manager + + + .. rubric:: Classes + + .. autosummary:: + + Config_Manager + Dhcpd + Interface + Vlan + \ No newline at end of file diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.config_manager.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.config_manager.rst.txt new file mode 100644 index 0000000..e7f6ed2 --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.config_manager.rst.txt @@ -0,0 +1,13 @@ +opnsense\_helper.config\_manager +================================ + +.. automodule:: opnsense_helper.config_manager + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + config_manager diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.opnsense_helper.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.opnsense_helper.rst.txt new file mode 100644 index 0000000..c3cef31 --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.opnsense_helper.rst.txt @@ -0,0 +1,12 @@ +opnsense\_helper.opnsense\_helper +================================= + +.. automodule:: opnsense_helper.opnsense_helper + + + .. rubric:: Classes + + .. autosummary:: + + Opnsense_Helper + \ No newline at end of file diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.rst.txt new file mode 100644 index 0000000..00afd45 --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.rst.txt @@ -0,0 +1,17 @@ +opnsense\_helper +================ + +.. automodule:: opnsense_helper + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + commands + config_manager + opnsense_helper + scripts + utils diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.scripts.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.scripts.rst.txt new file mode 100644 index 0000000..6f8540c --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.scripts.rst.txt @@ -0,0 +1,13 @@ +opnsense\_helper.scripts +======================== + +.. automodule:: opnsense_helper.scripts + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + scripts diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.scripts.scripts.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.scripts.scripts.rst.txt new file mode 100644 index 0000000..cf0bc15 --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.scripts.scripts.rst.txt @@ -0,0 +1,31 @@ +opnsense\_helper.scripts.scripts +================================ + +.. automodule:: opnsense_helper.scripts.scripts + + + .. rubric:: Classes + + .. autosummary:: + + Scripts + Wireguard + auth + dhcp + dns + filter + firmware + health + interfaces + ipsec + netflow + openssh + openvpn + routes + shaper + shell + suricata + syslog + system + unbound + \ No newline at end of file diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.baseclass.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.baseclass.rst.txt new file mode 100644 index 0000000..756b263 --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.baseclass.rst.txt @@ -0,0 +1,12 @@ +opnsense\_helper.utils.baseclass +================================ + +.. automodule:: opnsense_helper.utils.baseclass + + + .. rubric:: Classes + + .. autosummary:: + + Base_Class + \ No newline at end of file diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.exec_class.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.exec_class.rst.txt new file mode 100644 index 0000000..5f560bf --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.exec_class.rst.txt @@ -0,0 +1,12 @@ +opnsense\_helper.utils.exec\_class +================================== + +.. automodule:: opnsense_helper.utils.exec_class + + + .. rubric:: Classes + + .. autosummary:: + + Exec_Class + \ No newline at end of file diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.frontend_utils.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.frontend_utils.rst.txt new file mode 100644 index 0000000..afb2937 --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.frontend_utils.rst.txt @@ -0,0 +1,17 @@ +opnsense\_helper.utils.frontend\_utils +====================================== + +.. automodule:: opnsense_helper.utils.frontend_utils + + + .. rubric:: Functions + + .. autosummary:: + + api_get + api_post + get_backup + get_vlans + ping + vlans_api + \ No newline at end of file diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.rst.txt new file mode 100644 index 0000000..b641879 --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.rst.txt @@ -0,0 +1,16 @@ +opnsense\_helper.utils +====================== + +.. automodule:: opnsense_helper.utils + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + baseclass + exec_class + frontend_utils + utils diff --git a/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.utils.rst.txt b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.utils.rst.txt new file mode 100644 index 0000000..c9a23fd --- /dev/null +++ b/.docs/_build/html/_sources/opnsense_helper/opnsense_helper.utils.utils.rst.txt @@ -0,0 +1,20 @@ +opnsense\_helper.utils.utils +============================ + +.. automodule:: opnsense_helper.utils.utils + + + .. rubric:: Functions + + .. autosummary:: + + exec + format_flags + get_child + get_element + parseChild + ping + recoursion + replace + update_xml_file + \ No newline at end of file diff --git a/.docs/_build/html/_static/alabaster.css b/.docs/_build/html/_static/alabaster.css new file mode 100644 index 0000000..e3174bf --- /dev/null +++ b/.docs/_build/html/_static/alabaster.css @@ -0,0 +1,708 @@ +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: Georgia, serif; + font-size: 17px; + background-color: #fff; + color: #000; + margin: 0; + padding: 0; +} + + +div.document { + width: 940px; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 220px; +} + +div.sphinxsidebar { + width: 220px; + font-size: 14px; + line-height: 1.5; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.body { + background-color: #fff; + color: #3E4349; + padding: 0 30px 0 30px; +} + +div.body > .section { + text-align: left; +} + +div.footer { + width: 940px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + +div.relations { + display: none; +} + + +div.sphinxsidebar { + max-height: 100%; + overflow-y: auto; +} + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Georgia, serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: Georgia, serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 160px; +} + +div.sphinxsidebar .search > div { + display: table-cell; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +div.sphinxsidebar .badge { + border-bottom: none; +} + +div.sphinxsidebar .badge:hover { + border-bottom: none; +} + +/* To address an issue with donation coming after search */ +div.sphinxsidebar h3.donation { + margin-top: 10px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Georgia, serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: Georgia, serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin-left: 0; + margin-right: 0; + margin-top: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #EEE; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Hide ugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + + +/* relbar */ + +.related { + line-height: 30px; + width: 100%; + font-size: 0.9rem; +} + +.related.top { + border-bottom: 1px solid #EEE; + margin-bottom: 20px; +} + +.related.bottom { + border-top: 1px solid #EEE; +} + +.related ul { + padding: 0; + margin: 0; + list-style: none; +} + +.related li { + display: inline; +} + +nav#rellinks { + float: right; +} + +nav#rellinks li+li:before { + content: "|"; +} + +nav#breadcrumbs li+li:before { + content: "\00BB"; +} + +/* Hide certain items when printing */ +@media print { + div.related { + display: none; + } +} \ No newline at end of file diff --git a/.docs/_build/html/_static/basic.css b/.docs/_build/html/_static/basic.css new file mode 100644 index 0000000..e5179b7 --- /dev/null +++ b/.docs/_build/html/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: inherit; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/.docs/_build/html/_static/custom.css b/.docs/_build/html/_static/custom.css new file mode 100644 index 0000000..2a924f1 --- /dev/null +++ b/.docs/_build/html/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/.docs/_build/html/_static/doctools.js b/.docs/_build/html/_static/doctools.js new file mode 100644 index 0000000..4d67807 --- /dev/null +++ b/.docs/_build/html/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/.docs/_build/html/_static/documentation_options.js b/.docs/_build/html/_static/documentation_options.js new file mode 100644 index 0000000..9542324 --- /dev/null +++ b/.docs/_build/html/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '0.1.20', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/.docs/_build/html/_static/file.png b/.docs/_build/html/_static/file.png new file mode 100644 index 0000000..a858a41 Binary files /dev/null and b/.docs/_build/html/_static/file.png differ diff --git a/.docs/_build/html/_static/language_data.js b/.docs/_build/html/_static/language_data.js new file mode 100644 index 0000000..367b8ed --- /dev/null +++ b/.docs/_build/html/_static/language_data.js @@ -0,0 +1,199 @@ +/* + * language_data.js + * ~~~~~~~~~~~~~~~~ + * + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, if available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/.docs/_build/html/_static/minus.png b/.docs/_build/html/_static/minus.png new file mode 100644 index 0000000..d96755f Binary files /dev/null and b/.docs/_build/html/_static/minus.png differ diff --git a/.docs/_build/html/_static/plus.png b/.docs/_build/html/_static/plus.png new file mode 100644 index 0000000..7107cec Binary files /dev/null and b/.docs/_build/html/_static/plus.png differ diff --git a/.docs/_build/html/_static/pygments.css b/.docs/_build/html/_static/pygments.css new file mode 100644 index 0000000..04a4174 --- /dev/null +++ b/.docs/_build/html/_static/pygments.css @@ -0,0 +1,84 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #8f5902; font-style: italic } /* Comment */ +.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ +.highlight .g { color: #000000 } /* Generic */ +.highlight .k { color: #004461; font-weight: bold } /* Keyword */ +.highlight .l { color: #000000 } /* Literal */ +.highlight .n { color: #000000 } /* Name */ +.highlight .o { color: #582800 } /* Operator */ +.highlight .x { color: #000000 } /* Other */ +.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ +.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #8f5902 } /* Comment.Preproc */ +.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #a40000 } /* Generic.Deleted */ +.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000000 } /* Generic.EmphStrong */ +.highlight .gr { color: #ef2929 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #888888 } /* Generic.Output */ +.highlight .gp { color: #745334 } /* Generic.Prompt */ +.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ +.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ +.highlight .ld { color: #000000 } /* Literal.Date */ +.highlight .m { color: #990000 } /* Literal.Number */ +.highlight .s { color: #4e9a06 } /* Literal.String */ +.highlight .na { color: #c4a000 } /* Name.Attribute */ +.highlight .nb { color: #004461 } /* Name.Builtin */ +.highlight .nc { color: #000000 } /* Name.Class */ +.highlight .no { color: #000000 } /* Name.Constant */ +.highlight .nd { color: #888888 } /* Name.Decorator */ +.highlight .ni { color: #ce5c00 } /* Name.Entity */ +.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #000000 } /* Name.Function */ +.highlight .nl { color: #f57900 } /* Name.Label */ +.highlight .nn { color: #000000 } /* Name.Namespace */ +.highlight .nx { color: #000000 } /* Name.Other */ +.highlight .py { color: #000000 } /* Name.Property */ +.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #000000 } /* Name.Variable */ +.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ +.highlight .w { color: #f8f8f8 } /* Text.Whitespace */ +.highlight .mb { color: #990000 } /* Literal.Number.Bin */ +.highlight .mf { color: #990000 } /* Literal.Number.Float */ +.highlight .mh { color: #990000 } /* Literal.Number.Hex */ +.highlight .mi { color: #990000 } /* Literal.Number.Integer */ +.highlight .mo { color: #990000 } /* Literal.Number.Oct */ +.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ +.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ +.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ +.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ +.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ +.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ +.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ +.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ +.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ +.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ +.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ +.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ +.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #000000 } /* Name.Function.Magic */ +.highlight .vc { color: #000000 } /* Name.Variable.Class */ +.highlight .vg { color: #000000 } /* Name.Variable.Global */ +.highlight .vi { color: #000000 } /* Name.Variable.Instance */ +.highlight .vm { color: #000000 } /* Name.Variable.Magic */ +.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/.docs/_build/html/_static/searchtools.js b/.docs/_build/html/_static/searchtools.js new file mode 100644 index 0000000..b08d58c --- /dev/null +++ b/.docs/_build/html/_static/searchtools.js @@ -0,0 +1,620 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, anchor) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + "Search finished, found ${resultCount} page(s) matching the search query." + ).replace('${resultCount}', resultCount); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString, anchor) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + for (const removalQuery of [".headerlink", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + _parseQuery: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score + boost, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/.docs/_build/html/_static/sphinx_highlight.js b/.docs/_build/html/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/.docs/_build/html/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/.docs/_build/html/genindex.html b/.docs/_build/html/genindex.html new file mode 100644 index 0000000..bb37f48 --- /dev/null +++ b/.docs/_build/html/genindex.html @@ -0,0 +1,241 @@ + + + + + + + Index — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Index

+ +
+ M + | O + +
+

M

+ + +
+ +

O

+ + + +
    +
  • + opnsense_helper + +
    • +
  • + opnsense_helper.commands + +
    • +
  • + opnsense_helper.commands.commands + +
    • +
  • + opnsense_helper.config_manager + +
    • +
  • + opnsense_helper.config_manager.config_manager + +
    • +
  • + opnsense_helper.opnsense_helper + +
    • +
  • + opnsense_helper.scripts + +
    • +
    +
  • + opnsense_helper.scripts.scripts + +
    • +
  • + opnsense_helper.utils + +
    • +
  • + opnsense_helper.utils.baseclass + +
    • +
  • + opnsense_helper.utils.exec_class + +
    • +
  • + opnsense_helper.utils.frontend_utils + +
    • +
  • + opnsense_helper.utils.utils + +
    • +
+ + + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/index.html b/.docs/_build/html/index.html new file mode 100644 index 0000000..b6a799a --- /dev/null +++ b/.docs/_build/html/index.html @@ -0,0 +1,118 @@ + + + + + + + + Welcome to my-sphinx-test’s documentation! — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Welcome to my-sphinx-test’s documentation!

+
+
+ + + + + + + + + +

opnsense_helper

opnsense_helper.commands.commands

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/objects.inv b/.docs/_build/html/objects.inv new file mode 100644 index 0000000..3c49153 --- /dev/null +++ b/.docs/_build/html/objects.inv @@ -0,0 +1,6 @@ +# Sphinx inventory version 2 +# Project: opnsense_helper +# Version: +# The remainder of this file is compressed using zlib. +xڭMn0>T햴]TEȁI@26F +^Iġ)a~g3򳪥FK 56PwJ@xǞWģN ax\Eb[Wvzd״ &cžvFA%.JyL jJMA]\wq>e| X: ܋2YEiCQIhK*_0!syw1z7T\MFCto0ĨVN4\zd2퀮jVpc3޼Loy~{j>\|c. + + + + + + + Welcome to my-sphinx-test’s documentation! — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Welcome to my-sphinx-test’s documentation!

+ + + +
+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.commands.commands.html b/.docs/_build/html/opnsense_helper/opnsense_helper.commands.commands.html new file mode 100644 index 0000000..9f45b72 --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.commands.commands.html @@ -0,0 +1,139 @@ + + + + + + + + opnsense_helper.commands.commands — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper.commands.commands

+

Classes

+ + + + + + + + + + + + + + + +

Commands(base)

configctl(base)

pluginctl(base)

reconfigure(base)

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.commands.html b/.docs/_build/html/opnsense_helper/opnsense_helper.commands.html new file mode 100644 index 0000000..1e06247 --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.commands.html @@ -0,0 +1,128 @@ + + + + + + + + opnsense_helper.commands — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper.commands

+

Modules

+ + + + + + +

commands

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.config_manager.config_manager.html b/.docs/_build/html/opnsense_helper/opnsense_helper.config_manager.config_manager.html new file mode 100644 index 0000000..0d09269 --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.config_manager.config_manager.html @@ -0,0 +1,139 @@ + + + + + + + + opnsense_helper.config_manager.config_manager — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper.config_manager.config_manager

+

Classes

+ + + + + + + + + + + + + + + +

Config_Manager(base, init)

Dhcpd([id, enable, range, ddnsdomainalgorithm])

*Creates a dhcp object.*

Interface([id, descr, interface, enable, ...])

*Creates a Interface object.* The ID is the technical identifier.

Vlan([id, parentinterface, tag, vlanif, ...])

*Creates a vlan object.*

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.config_manager.html b/.docs/_build/html/opnsense_helper/opnsense_helper.config_manager.html new file mode 100644 index 0000000..07640a5 --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.config_manager.html @@ -0,0 +1,128 @@ + + + + + + + + opnsense_helper.config_manager — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper.config_manager

+

Modules

+ + + + + + +

config_manager

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.html b/.docs/_build/html/opnsense_helper/opnsense_helper.html new file mode 100644 index 0000000..eb048dd --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.html @@ -0,0 +1,135 @@ + + + + + + + + opnsense_helper — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper

+

Modules

+ + + + + + + + + + + + + + + + + + +

commands

config_manager

opnsense_helper

scripts

utils

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.opnsense_helper.html b/.docs/_build/html/opnsense_helper/opnsense_helper.opnsense_helper.html new file mode 100644 index 0000000..4433932 --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.opnsense_helper.html @@ -0,0 +1,125 @@ + + + + + + + + opnsense_helper.opnsense_helper — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper.opnsense_helper

+

Classes

+ + + + + + +

Opnsense_Helper([host, ssh_auth, api_auth, ...])

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.scripts.html b/.docs/_build/html/opnsense_helper/opnsense_helper.scripts.html new file mode 100644 index 0000000..a40f761 --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.scripts.html @@ -0,0 +1,128 @@ + + + + + + + + opnsense_helper.scripts — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper.scripts

+

Modules

+ + + + + + +

scripts

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.scripts.scripts.html b/.docs/_build/html/opnsense_helper/opnsense_helper.scripts.scripts.html new file mode 100644 index 0000000..b07d289 --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.scripts.scripts.html @@ -0,0 +1,187 @@ + + + + + + + + opnsense_helper.scripts.scripts — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper.scripts.scripts

+

Classes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Scripts(base)

Wireguard(base)

auth(base)

dhcp(base)

dns(base)

filter(base)

firmware(base)

health(base)

interfaces(base)

ipsec(base)

netflow(base)

openssh(base)

openvpn(base)

routes(base)

shaper(base)

shell(base)

suricata(base)

syslog(base)

system(base)

unbound(base)

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.utils.baseclass.html b/.docs/_build/html/opnsense_helper/opnsense_helper.utils.baseclass.html new file mode 100644 index 0000000..94e7e36 --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.utils.baseclass.html @@ -0,0 +1,133 @@ + + + + + + + + opnsense_helper.utils.baseclass — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper.utils.baseclass

+

Classes

+ + + + + + +

Base_Class([host, ssh_auth, api_auth, ...])

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.utils.exec_class.html b/.docs/_build/html/opnsense_helper/opnsense_helper.utils.exec_class.html new file mode 100644 index 0000000..ed50066 --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.utils.exec_class.html @@ -0,0 +1,133 @@ + + + + + + + + opnsense_helper.utils.exec_class — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper.utils.exec_class

+

Classes

+ + + + + + +

Exec_Class(base)

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.utils.frontend_utils.html b/.docs/_build/html/opnsense_helper/opnsense_helper.utils.frontend_utils.html new file mode 100644 index 0000000..3ee8162 --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.utils.frontend_utils.html @@ -0,0 +1,148 @@ + + + + + + + + opnsense_helper.utils.frontend_utils — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper.utils.frontend_utils

+

Functions

+ + + + + + + + + + + + + + + + + + + + + +

api_get(helper, command[, params])

api_post(helper, command, Data)

get_backup(helper[, output])

this function is currently deprecated it was used to get the config file using the api i left it in however if someone wants to fetch a certain backup i need to implement the backup selection though

get_vlans(helper)

ping(helper)

vlans_api(helper, vlans[, command])

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.utils.html b/.docs/_build/html/opnsense_helper/opnsense_helper.utils.html new file mode 100644 index 0000000..ed9a572 --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.utils.html @@ -0,0 +1,140 @@ + + + + + + + + opnsense_helper.utils — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper.utils

+

Modules

+ + + + + + + + + + + + + + + +

baseclass

exec_class

frontend_utils

utils

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/opnsense_helper/opnsense_helper.utils.utils.html b/.docs/_build/html/opnsense_helper/opnsense_helper.utils.utils.html new file mode 100644 index 0000000..409d91b --- /dev/null +++ b/.docs/_build/html/opnsense_helper/opnsense_helper.utils.utils.html @@ -0,0 +1,155 @@ + + + + + + + + opnsense_helper.utils.utils — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

opnsense_helper.utils.utils

+

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

exec(helper, obj)

format_flags(flags_array)

get_child(root, element, id, keys)

get_element(root, id, obj)

parseChild(child, tag)

ping(helper)

recoursion(e, value)

replace(item)

update_xml_file(objects, root, type)

+
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/py-modindex.html b/.docs/_build/html/py-modindex.html new file mode 100644 index 0000000..69de6b7 --- /dev/null +++ b/.docs/_build/html/py-modindex.html @@ -0,0 +1,178 @@ + + + + + + + Python Module Index — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Python Module Index

+ +
+ o +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 
+ o
+ opnsense_helper +
    + opnsense_helper.commands +
    + opnsense_helper.commands.commands +
    + opnsense_helper.config_manager +
    + opnsense_helper.config_manager.config_manager +
    + opnsense_helper.opnsense_helper +
    + opnsense_helper.scripts +
    + opnsense_helper.scripts.scripts +
    + opnsense_helper.utils +
    + opnsense_helper.utils.baseclass +
    + opnsense_helper.utils.exec_class +
    + opnsense_helper.utils.frontend_utils +
    + opnsense_helper.utils.utils +
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/search.html b/.docs/_build/html/search.html new file mode 100644 index 0000000..846e44b --- /dev/null +++ b/.docs/_build/html/search.html @@ -0,0 +1,120 @@ + + + + + + + Search — opnsense_helper 0.1.20 documentation + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +

Search

+ + + + +

+ Searching for multiple words only shows matches that contain + all words. +

+ + +
+ + + +
+ + +
+ + +
+ +
+
+ +
+
+
+ ©2024, ji-podhead. + + | + Powered by Sphinx 7.4.7 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/.docs/_build/html/searchindex.js b/.docs/_build/html/searchindex.js new file mode 100644 index 0000000..4d7897a --- /dev/null +++ b/.docs/_build/html/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"Welcome to my-sphinx-test\u2019s documentation!": [[1, null], [2, null]], "opnsense_helper": [[0, null], [3, null]], "opnsense_helper.commands": [[4, null]], "opnsense_helper.commands.commands": [[5, null]], "opnsense_helper.config_manager": [[6, null]], "opnsense_helper.config_manager.config_manager": [[7, null]], "opnsense_helper.opnsense_helper": [[8, null]], "opnsense_helper.scripts": [[9, null]], "opnsense_helper.scripts.scripts": [[10, null]], "opnsense_helper.utils": [[11, null]], "opnsense_helper.utils.baseclass": [[12, null]], "opnsense_helper.utils.exec_class": [[13, null]], "opnsense_helper.utils.frontend_utils": [[14, null]], "opnsense_helper.utils.utils": [[15, null]]}, "docnames": ["_autosummary/opnsense_helper", "index", "opnsense_helper", "opnsense_helper/opnsense_helper", "opnsense_helper/opnsense_helper.commands", "opnsense_helper/opnsense_helper.commands.commands", "opnsense_helper/opnsense_helper.config_manager", "opnsense_helper/opnsense_helper.config_manager.config_manager", "opnsense_helper/opnsense_helper.opnsense_helper", "opnsense_helper/opnsense_helper.scripts", "opnsense_helper/opnsense_helper.scripts.scripts", "opnsense_helper/opnsense_helper.utils", "opnsense_helper/opnsense_helper.utils.baseclass", "opnsense_helper/opnsense_helper.utils.exec_class", "opnsense_helper/opnsense_helper.utils.frontend_utils", "opnsense_helper/opnsense_helper.utils.utils"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["_autosummary/opnsense_helper.rst", "index.rst", "opnsense_helper.rst", "opnsense_helper/opnsense_helper.rst", "opnsense_helper/opnsense_helper.commands.rst", "opnsense_helper/opnsense_helper.commands.commands.rst", "opnsense_helper/opnsense_helper.config_manager.rst", "opnsense_helper/opnsense_helper.config_manager.config_manager.rst", "opnsense_helper/opnsense_helper.opnsense_helper.rst", "opnsense_helper/opnsense_helper.scripts.rst", "opnsense_helper/opnsense_helper.scripts.scripts.rst", "opnsense_helper/opnsense_helper.utils.rst", "opnsense_helper/opnsense_helper.utils.baseclass.rst", "opnsense_helper/opnsense_helper.utils.exec_class.rst", "opnsense_helper/opnsense_helper.utils.frontend_utils.rst", "opnsense_helper/opnsense_helper.utils.utils.rst"], "indexentries": {"module": [[3, "module-opnsense_helper", false], [4, "module-opnsense_helper.commands", false], [5, "module-opnsense_helper.commands.commands", false], [6, "module-opnsense_helper.config_manager", false], [7, "module-opnsense_helper.config_manager.config_manager", false], [8, "module-opnsense_helper.opnsense_helper", false], [9, "module-opnsense_helper.scripts", false], [10, "module-opnsense_helper.scripts.scripts", false], [11, "module-opnsense_helper.utils", false], [12, "module-opnsense_helper.utils.baseclass", false], [13, "module-opnsense_helper.utils.exec_class", false], [14, "module-opnsense_helper.utils.frontend_utils", false], [15, "module-opnsense_helper.utils.utils", false]], "opnsense_helper": [[3, "module-opnsense_helper", false]], "opnsense_helper.commands": [[4, "module-opnsense_helper.commands", false]], "opnsense_helper.commands.commands": [[5, "module-opnsense_helper.commands.commands", false]], "opnsense_helper.config_manager": [[6, "module-opnsense_helper.config_manager", false]], "opnsense_helper.config_manager.config_manager": [[7, "module-opnsense_helper.config_manager.config_manager", false]], "opnsense_helper.opnsense_helper": [[8, "module-opnsense_helper.opnsense_helper", false]], "opnsense_helper.scripts": [[9, "module-opnsense_helper.scripts", false]], "opnsense_helper.scripts.scripts": [[10, "module-opnsense_helper.scripts.scripts", false]], "opnsense_helper.utils": [[11, "module-opnsense_helper.utils", false]], "opnsense_helper.utils.baseclass": [[12, "module-opnsense_helper.utils.baseclass", false]], "opnsense_helper.utils.exec_class": [[13, "module-opnsense_helper.utils.exec_class", false]], "opnsense_helper.utils.frontend_utils": [[14, "module-opnsense_helper.utils.frontend_utils", false]], "opnsense_helper.utils.utils": [[15, "module-opnsense_helper.utils.utils", false]]}, "objects": {"": [[3, 0, 0, "-", "opnsense_helper"]], "opnsense_helper": [[4, 0, 0, "-", "commands"], [6, 0, 0, "-", "config_manager"], [8, 0, 0, "-", "opnsense_helper"], [9, 0, 0, "-", "scripts"], [11, 0, 0, "-", "utils"]], "opnsense_helper.commands": [[5, 0, 0, "-", "commands"]], "opnsense_helper.config_manager": [[7, 0, 0, "-", "config_manager"]], "opnsense_helper.scripts": [[10, 0, 0, "-", "scripts"]], "opnsense_helper.utils": [[12, 0, 0, "-", "baseclass"], [13, 0, 0, "-", "exec_class"], [14, 0, 0, "-", "frontend_utils"], [15, 0, 0, "-", "utils"]]}, "objnames": {"0": ["py", "module", "Python module"]}, "objtypes": {"0": "py:module"}, "terms": {"class": [5, 7, 8, 10, 12, 13], "function": [14, 15], "modul": [3, 4, 6, 9, 11]}, "titles": ["opnsense_helper", "Welcome to my-sphinx-test\u2019s documentation!", "Welcome to my-sphinx-test\u2019s documentation!", "opnsense_helper", "opnsense_helper.commands", "opnsense_helper.commands.commands", "opnsense_helper.config_manager", "opnsense_helper.config_manager.config_manager", "opnsense_helper.opnsense_helper", "opnsense_helper.scripts", "opnsense_helper.scripts.scripts", "opnsense_helper.utils", "opnsense_helper.utils.baseclass", "opnsense_helper.utils.exec_class", "opnsense_helper.utils.frontend_utils", "opnsense_helper.utils.utils"], "titleterms": {"": [1, 2], "baseclass": 12, "command": [4, 5], "config_manag": [6, 7], "document": [1, 2], "exec_class": 13, "frontend_util": 14, "my": [1, 2], "opnsense_help": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], "script": [9, 10], "sphinx": [1, 2], "test": [1, 2], "util": [11, 12, 13, 14, 15], "welcom": [1, 2]}}) \ No newline at end of file diff --git a/.docs/conf.py b/.docs/conf.py new file mode 100644 index 0000000..bd8d0ae --- /dev/null +++ b/.docs/conf.py @@ -0,0 +1,39 @@ +import os +import sys +sys.path.insert(0, os.path.abspath('../python')) # Source code dir relative to this file + +extensions = [ + 'sphinx.ext.autodoc', # Core library for html generation from docstrings + 'sphinx.ext.autosummary', # Create neat summary tables +] +autosummary_generate = True # Turn on sphinx.ext.autosummary + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'opnsense_helper' +copyright = '2024, ji-podhead' +author = 'ji-podhead' +release = '0.1.20' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usaNUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/.docs/opnsense_helper.rst b/.docs/opnsense_helper.rst new file mode 100644 index 0000000..e19a8ac --- /dev/null +++ b/.docs/opnsense_helper.rst @@ -0,0 +1,12 @@ +.. my-sphinx-test documentation master file, created by + sphinx-quickstart on Sun Jan 14 17:51:39 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. +Welcome to my-sphinx-test's documentation! +========================================== +.. autosummary:: + :toctree: _autosummary + :template: custom-module-template.rst + :recursive: + + opnsense_helper diff --git a/.docs/opnsense_helper/opnsense_helper.commands.commands.rst b/.docs/opnsense_helper/opnsense_helper.commands.commands.rst new file mode 100644 index 0000000..37f2ecb --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.commands.commands.rst @@ -0,0 +1,15 @@ +opnsense\_helper.commands.commands +================================== + +.. automodule:: opnsense_helper.commands.commands + + + .. rubric:: Classes + + .. autosummary:: + + Commands + configctl + pluginctl + reconfigure + \ No newline at end of file diff --git a/.docs/opnsense_helper/opnsense_helper.commands.rst b/.docs/opnsense_helper/opnsense_helper.commands.rst new file mode 100644 index 0000000..ce75b12 --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.commands.rst @@ -0,0 +1,13 @@ +opnsense\_helper.commands +========================= + +.. automodule:: opnsense_helper.commands + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + commands diff --git a/.docs/opnsense_helper/opnsense_helper.config_manager.config_manager.rst b/.docs/opnsense_helper/opnsense_helper.config_manager.config_manager.rst new file mode 100644 index 0000000..7463fdf --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.config_manager.config_manager.rst @@ -0,0 +1,15 @@ +opnsense\_helper.config\_manager.config\_manager +================================================ + +.. automodule:: opnsense_helper.config_manager.config_manager + + + .. rubric:: Classes + + .. autosummary:: + + Config_Manager + Dhcpd + Interface + Vlan + \ No newline at end of file diff --git a/.docs/opnsense_helper/opnsense_helper.config_manager.rst b/.docs/opnsense_helper/opnsense_helper.config_manager.rst new file mode 100644 index 0000000..e7f6ed2 --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.config_manager.rst @@ -0,0 +1,13 @@ +opnsense\_helper.config\_manager +================================ + +.. automodule:: opnsense_helper.config_manager + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + config_manager diff --git a/.docs/opnsense_helper/opnsense_helper.opnsense_helper.rst b/.docs/opnsense_helper/opnsense_helper.opnsense_helper.rst new file mode 100644 index 0000000..c3cef31 --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.opnsense_helper.rst @@ -0,0 +1,12 @@ +opnsense\_helper.opnsense\_helper +================================= + +.. automodule:: opnsense_helper.opnsense_helper + + + .. rubric:: Classes + + .. autosummary:: + + Opnsense_Helper + \ No newline at end of file diff --git a/.docs/opnsense_helper/opnsense_helper.rst b/.docs/opnsense_helper/opnsense_helper.rst new file mode 100644 index 0000000..00afd45 --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.rst @@ -0,0 +1,17 @@ +opnsense\_helper +================ + +.. automodule:: opnsense_helper + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + commands + config_manager + opnsense_helper + scripts + utils diff --git a/.docs/opnsense_helper/opnsense_helper.scripts.rst b/.docs/opnsense_helper/opnsense_helper.scripts.rst new file mode 100644 index 0000000..6f8540c --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.scripts.rst @@ -0,0 +1,13 @@ +opnsense\_helper.scripts +======================== + +.. automodule:: opnsense_helper.scripts + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + scripts diff --git a/.docs/opnsense_helper/opnsense_helper.scripts.scripts.rst b/.docs/opnsense_helper/opnsense_helper.scripts.scripts.rst new file mode 100644 index 0000000..cf0bc15 --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.scripts.scripts.rst @@ -0,0 +1,31 @@ +opnsense\_helper.scripts.scripts +================================ + +.. automodule:: opnsense_helper.scripts.scripts + + + .. rubric:: Classes + + .. autosummary:: + + Scripts + Wireguard + auth + dhcp + dns + filter + firmware + health + interfaces + ipsec + netflow + openssh + openvpn + routes + shaper + shell + suricata + syslog + system + unbound + \ No newline at end of file diff --git a/.docs/opnsense_helper/opnsense_helper.utils.baseclass.rst b/.docs/opnsense_helper/opnsense_helper.utils.baseclass.rst new file mode 100644 index 0000000..756b263 --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.utils.baseclass.rst @@ -0,0 +1,12 @@ +opnsense\_helper.utils.baseclass +================================ + +.. automodule:: opnsense_helper.utils.baseclass + + + .. rubric:: Classes + + .. autosummary:: + + Base_Class + \ No newline at end of file diff --git a/.docs/opnsense_helper/opnsense_helper.utils.exec_class.rst b/.docs/opnsense_helper/opnsense_helper.utils.exec_class.rst new file mode 100644 index 0000000..5f560bf --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.utils.exec_class.rst @@ -0,0 +1,12 @@ +opnsense\_helper.utils.exec\_class +================================== + +.. automodule:: opnsense_helper.utils.exec_class + + + .. rubric:: Classes + + .. autosummary:: + + Exec_Class + \ No newline at end of file diff --git a/.docs/opnsense_helper/opnsense_helper.utils.frontend_utils.rst b/.docs/opnsense_helper/opnsense_helper.utils.frontend_utils.rst new file mode 100644 index 0000000..afb2937 --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.utils.frontend_utils.rst @@ -0,0 +1,17 @@ +opnsense\_helper.utils.frontend\_utils +====================================== + +.. automodule:: opnsense_helper.utils.frontend_utils + + + .. rubric:: Functions + + .. autosummary:: + + api_get + api_post + get_backup + get_vlans + ping + vlans_api + \ No newline at end of file diff --git a/.docs/opnsense_helper/opnsense_helper.utils.rst b/.docs/opnsense_helper/opnsense_helper.utils.rst new file mode 100644 index 0000000..b641879 --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.utils.rst @@ -0,0 +1,16 @@ +opnsense\_helper.utils +====================== + +.. automodule:: opnsense_helper.utils + + +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: + + baseclass + exec_class + frontend_utils + utils diff --git a/.docs/opnsense_helper/opnsense_helper.utils.utils.rst b/.docs/opnsense_helper/opnsense_helper.utils.utils.rst new file mode 100644 index 0000000..c9a23fd --- /dev/null +++ b/.docs/opnsense_helper/opnsense_helper.utils.utils.rst @@ -0,0 +1,20 @@ +opnsense\_helper.utils.utils +============================ + +.. automodule:: opnsense_helper.utils.utils + + + .. rubric:: Functions + + .. autosummary:: + + exec + format_flags + get_child + get_element + parseChild + ping + recoursion + replace + update_xml_file + \ No newline at end of file diff --git a/.gitignore b/.gitignore index 9481a50..2aea055 100644 --- a/.gitignore +++ b/.gitignore @@ -21,7 +21,8 @@ config.xml *.tmp *.swp *.swo - +*.dist +*.build # IDE-Spezifische Dateien .vscode/ .idea/ diff --git a/python/build/lib/opnsense_helper/__init__.py b/python/build/lib/opnsense_helper/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/python/build/lib/opnsense_helper/classes.py b/python/build/lib/opnsense_helper/classes.py deleted file mode 100644 index 83b1271..0000000 --- a/python/build/lib/opnsense_helper/classes.py +++ /dev/null @@ -1,383 +0,0 @@ - -import paramiko -from lxml import etree -import xml.etree.ElementTree as ET -import logging -from xmldiff import main, formatting -from opnsense_helper.utils import parseChild, update_xml_file, aliases, reconfigure_vlans -from opnsense_helper.frontend_utils import api_get,api_post - -{"id":"router",'descr': 'router', 'enable': '1', 'ipaddr': '200.1.0.1','spoofmac': '00:00:00:01:00:01',"interface":"vtnet1"}, - -class Interface: - """ - ***Creates a Interface object.*** - The ID is the technical identifier. - This is required and you need to find out which "opt" to use, - because rn there is no function that provides that. - The interface key in the xml are the identifiers, in this case the class id`s. - Im not sure if they have a certain naming convention - - *Required params(man. usage):* - * id: str - * interface: str - * enable: str - * descr: str - - *Defaults:* - * subnet: 32 - * ipaddr: None - * spoofmac: None - - """ - def __init__(self, id=None, descr =None, interface=None, enable=None, ipaddr=None, subnet="32", spoofmac=None): - self.id=id - self.interface=interface - self.enable=enable - self.subnet=subnet - self.ipaddr=ipaddr - self.spoofmac=spoofmac - self.descr=descr - self.descr= descr #if descr is not None else id if id is not None else None - self.attr={} - def initialize(self, parent): - - self.descr = parseChild(parent, "descr") - self.interface = parseChild(parent, "if") - self.enable = parseChild(parent, "enable") - self.ipaddr = parseChild(parent, "ipaddr") - self.subnet = parseChild(parent, "subnet") - self.type = parseChild(parent, "type") - self.virtual = parseChild(parent, "virtual") - self.spoofmac=parseChild(parent, "spoofmac") - -class Vlan: - """ - ***Creates a vlan object.*** - - *Required params(man. usage):* - * id: str - * tag: str - - *Defaults:* - * pcp: 0 - * descr: id - * vlanif: "vlan0."+tag - """ - def __init__(self, id=None, parentinterface=None, tag=None, vlanif= None, pcp= '0', descr=None ): - self.id=id - self.parentinterface=parentinterface - self.pcp = pcp - self.tag=tag - self.descr= descr if descr is not None else id if id is not None else None - self.vlanif= vlanif if vlanif is not None else "vlan0."+str(tag) if tag is not None else None - self.attr={} - def initialize(self,parent): - self.parentinterface =parseChild(parent, "if") - self.tag = parseChild(parent,"tag") - self.pcp = parseChild(parent,"pcp") - self.proto = parseChild(parent,"proto") - self.descr = parseChild(parent,"descr") - self.vlanif = parseChild(parent,"vlanif") - - -class Dhcpd: - """ - ***Creates a dhcp object.*** - - *Required params(man. usage):* - * id: str - * enable: str - * range: dict{_from:str,_to:str} - - *Defaults:* - * ddnsdomainalgorithm: "hmac-md" - """ - def __init__(self,id=None,enable=None,range=None,ddnsdomainalgorithm="hmac-md"): - self.id=id - self.enable=enable - self._range=range - self.ddnsdomainalgorithm=ddnsdomainalgorithm - self.attr={} - def initialize(self, parent): - self.enable = parseChild(parent, "enable") - self.ddnsdomainalgorithm = parseChild(parent, "ddnsdomainalgorithm") - self._range={ - "_from": parent.find("range/from"), - "_to":parent.find("range/to") - } - if self._range["_from"] is not None: - self._range["_from"]=self._range["_from"].text - self._range["_to"]=self._range["_to"].text - -class Opnsense_Helper(): - def __init__(self, host=None, ssh_auth=None, api_auth=None, conf_path="/conf/config.xml", temp_path="./config.xml", verbose=False, init=True): - if(verbose): - self.logging=logging.basicConfig(level=logging.DEBUG) - self.objects={ - "vlans":{}, - "dhcpd":{}, - "interfaces":{} - } - self.url = host - self.conf_path=conf_path - - if(ssh_auth!=None): - self.temp_path= temp_path - self.ssh = paramiko.SSHClient() - self.ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy()) - self.ssh.connect(host, username=ssh_auth["user"], password=ssh_auth["passw"]) - self.sftp = self.ssh.open_sftp() - - if(api_auth!=None): - self.api_key = api_auth["api_key"] - self.api_secret = api_auth["api_secret"] - self.ssl=api_auth["ssl"] - self.verify=api_auth["verify"] - self.host=host - if init: - self.get_conf() - self.initialize() - - def close(self): - self.close_con() - - def get_dif(self): - - diff = main.diff_files('file1.xml', 'file2.xml', formatter=formatting.XMLFormatter()) - def initialize(self): - """ - Initialize the configuration. - - This method reads the configuration from the in-memory configuration. - The configuration is read from the - remote host via the SSH protocol or the opnsense API. - Either run get_backup() or get_conf() before calling this method. - This method is not called automatically when the class is instantiated, so you need to get the conf file before and then call this method. - - """ - self.get_all("dhcpd") - self.get_all("vlans") - self.get_all("interfaces") - - def save(self,output,put=True): - output= output if output is not None else self.temp_path - """ - Save the current configuration to a file. - - This method takes the current in-memory configuration and saves it to a - file specified by the output parameter. The file is written in XML - format. - - Parameters - ---------- - output : str - The path to the file to which the configuration should be written. - default: self.temp_path - put: bool - Automatically copies the configuration to the firewall - """ - if len(self.objects["dhcpd"]) > 0: - print("saving dhcpd") - update_xml_file(self.objects["dhcpd"],self.root,"dhcpd") - if len(self.objects["interfaces"]) > 0: - - print("saving ifs") - update_xml_file(self.objects["interfaces"],self.root,"interfaces") - if len(self.objects["vlans"]) > 0: - print("saving vlans") - update_xml_file(self.objects["vlans"],self.root,"vlans") - with open(output, 'w') as f: - f.write(ET.tostring(self.root, encoding='unicode', method='xml')) - print(self.objects) - if(put==True): - self.put_file() - - def get_all(self,element): - """ - Get all objects of a given type from the in-memory xml data. - - This method returns a dictionary containing all objects of this type. The dictionary keys are the tags - of the elements, and the values are dictionaries containing the - attributes and subelements of the elements. - - Parameters - ---------- - element : str - The type of the objects to retrieve. Can be "dhcpd", "interfaces", - or "vlans". - - Returns - ------- - dict - A dictionary containing all objects of the given type. - """ - print(f''' ----------------------------- - {element}''') - for parent in self.root.findall(element): - for child in parent: - - if element== "dhcpd": - child_object = Dhcpd() - - elif element== "interfaces": - child_object = Interface() - elif element== "vlans": - child_object = Vlan() - - if element != "vlans": - name = child.tag - else: - name = child_object.descr - - child_object.initialize(child) - del child_object.id - child_object.attr=child.attrib if child.attrib is not None else {} - print(child_object.attr) - self.objects[element][name]=child_object.__dict__ - print(f'''found {child.tag} : {child_object.__dict__}''') - return(self.objects[element]) - - def close_con(self): - self.sftp.close() - self.ssh.close() - - def put_file(self, _from=None,_to=None): - """ - Apply the configuration. - Transfer a file from the local host to the remote host. - - Parameters - ---------- - _from : str - The path to the file on the local host. - default: self.temp_path - _to : str - The destination path on the remote host where the file should be stored. - default: self.conf_path - """ - a=_from if _from is not None else self.temp_path - b=_to if _to is not None else self.conf_path - self.sftp.put(a, b) - if len(self.objects["vlans"]) > 0: - reconfigure_vlans(self) - - def remove_items(self,type, items, init=True, apply=True): - if init: - self.get_conf() - self.initialize() - for id in items: - self.objects[type].pop(id) - if apply: - self.save() - self.put_file() - - def get_item(self,type,item): - o = self.objects[type][item] - if o: - o=o.__dict__.pop("attr") - print(f"""recieved item of type{type} - {o}""") - return o - else: - return print(f"{item} not found") - - def set(self,type, data): - """ - Set objects of a given type to the in-memory xml data. - - This method adds all objects given in the data parameter to the in-memory - xml data. The objects are stored in the self.objects dictionary. - - Parameters - ---------- - type : str - The type of the objects to add. Can be "dhcpd", "interfaces", - or "vlans". - - data : dict - A dictionary containing the objects to add. The keys are the tags of - the elements, and the values are dictionaries containing the - attributes and subelements of the elements. - - Returns - ------- - None - """ - for value in data: - id=value.id - del value.id - self.objects[type][id] = value.__dict__ - - - def get_conf(self,_from= None,_to=None): - """ - Get the config file from the remote host and save it to a file. - - Parameters - ---------- - _from : str - The path to the file on the remote host. - _to : str - The path to the file on the local host. If None, the file is saved - to the location specified in self.temp_path. - """ - _to = self.temp_path if _to is None else _to - _from=self.conf_path if _from is None else _from - self.sftp.get(_from,_to) - self.tree = ET.parse(_to) - self.root = self.tree.getroot() - - - - - - - - - - - - - - - - -# deprecated - def get_backup(self,output=None): - """ - this function is currently deprecated - it was used to get the config file using the api - i left it in however if someone wants to fetch a certain backup - i need to implement the backup selection though - """ - command = 'core/backup/download/this' - backup=api_get(self,command) - self.root=backup - print(ET.tostring(backup, encoding='unicode')) - # if output != None: - # path=output - # else: - # path = self.temp_path - # with open(path, 'w') as f: - # f.write(ET.tostring(backup, encoding='unicode', method='xml')) - - -# deprecated - def vlans_api(self,vlans, command="add"): - if command == "add": - for value in vlans: - print("---------add vlan-----------------") - print(value) - payload={"vlan":value} - r=api_post(self,"interfaces/vlan_settings/addItem",payload) - print(r) - r=api_post(self,"interfaces/vlan_settings/reconfigure",{}) - print(r) - elif command == "set": - for value in vlans: - print("---------set vlan-----------------") - payload={"vlan":value} - r=api_post(self,"interfaces/vlan_settings/set",payload) - print(r) - \ No newline at end of file diff --git a/python/build/lib/opnsense_helper/opnsense_helper.py b/python/build/lib/opnsense_helper/opnsense_helper.py deleted file mode 100644 index 91bd585..0000000 --- a/python/build/lib/opnsense_helper/opnsense_helper.py +++ /dev/null @@ -1,16 +0,0 @@ - -from opnsense_helper.config_manager.config_manager import Interface, Vlan, Dhcpd, Config_Manager -from opnsense_helper.utils.baseclass import Base_Class -from opnsense_helper.commands.commands import Commands -from opnsense_helper.scripts.scripts import Scripts -class Opnsense_Helper(): - def __init__(self, host=None, ssh_auth=None, api_auth=None, conf_path="/conf/config.xml", temp_path="./config.xml", verbose=False, init_config_manager=True): - - base_class = Base_Class(host, ssh_auth, api_auth, conf_path, temp_path, verbose) - self.config_manager=Config_Manager(base_class) - self.commands=Commands(base_class) - self.scripts=Scripts(base_class) - - if init_config_manager: - self.config_manager.get_conf() - self.config_manager.initialize() diff --git a/python/build/lib/opnsense_helper/test.py b/python/build/lib/opnsense_helper/test.py deleted file mode 100644 index 5acf05c..0000000 --- a/python/build/lib/opnsense_helper/test.py +++ /dev/null @@ -1,26 +0,0 @@ -import opnsense_helper.opnsense_helper -opnsensehelper=opnsense_helper.opnsense_helper -def test(): - filepath = '/home/ji/confignew.xml' - output="/home/ji/.ansible/collections/ansible_collections/ji_podhead/podnet/plugins/x.xml" - conf_path="/conf/config.xml" - vlan3 ={'parentinterface': 'vtnet1', 'tag': '3', 'pcp': '0', 'proto': None, 'descr': 'vlan3', 'vlanif': 'vlan0.3',"attr":{"uuid":"cb503df8-821d-4acd-86ba-66b35e4df17n"}} - vlan4 ={'parentinterface': 'vtnet1', 'tag': '4', 'pcp': '0', 'proto': None, 'descr': 'vlan4', 'vlanif': 'vlan0.4',"attr":{"uuid":"cb503df8-821d-4acd-86ba-66b35e4s7c"}} - opt3_dhcp= {'enable': '1', 'ddnsdomainalgorithm': 'hmac-md', "range":{'from': '200.0.3.10', '_to': '200.0.3.100'},"attr":None} - opt4_dhcp= {'enable': '1', 'ddnsdomainalgorithm': 'hmac-md', "range":{'from': '200.0.4.10', '_to': '200.0.4.100'},"attr":None} - opt3_interface= {'descr': 'vlan3', 'enable': '1', 'ipaddr': '200.0.3.1', 'subnet': '24', 'type': None, 'virtual': None, 'spoofmac': '00:00:00:00:00:03', 'attr': {}} - opt4_interface= {'descr': 'vlan4', 'enable': '1', 'ipaddr': '200.0.3.1', 'subnet': '24', 'type': None, 'virtual': None, 'spoofmac': '00:00:00:00:00:04', 'attr': {}} - helper=opnsensehelper(filepath,True,"root","opnsense","192.168.1.103") - helper.get_file(conf_path, output) - helper.initialize() - helper.objects["dhcpd"]["opt3"]=opt3_dhcp - helper.objects["dhcpd"]["opt4"]=opt4_dhcp - helper.objects["vlans"]["vlan3"]=vlan3 - helper.objects["vlans"]["vlan4"]=vlan4 - helper.objects["interfaces"]["opt3"]=opt3_interface - helper.objects["interfaces"]["opt4"]=opt4_interface - helper.save(output) - helper.put_file(output,conf_path) - helper.close_con() -if __name__ == "__main__": - test() \ No newline at end of file diff --git a/python/build/lib/opnsense_helper/utils.py b/python/build/lib/opnsense_helper/utils.py deleted file mode 100644 index d148a22..0000000 --- a/python/build/lib/opnsense_helper/utils.py +++ /dev/null @@ -1,95 +0,0 @@ -import xml.etree.ElementTree as ET -# import libraries -import json -import xml.etree.ElementTree as ET -import requests -import os - -aliases={ -"parent": "if", -"_from":"from", -"_to":"to", -"interface":"if", -"_range":"range" -} - -def parseChild(child, tag): - result=child.find(tag) - element=result.text if result is not None else None - return element - -def ping(helper): - response = os.system(f"ping -c 1 {helper.host}") - if response == 0: - print(f"IP {helper.host} is reachable") - return 0 - else: return 1 - -def reconfigure_vlans(helper): - stdin, stdout, stderr = helper.ssh.exec_command('/usr/local/opnsense/scripts/interfaces/reconfigure_vlans.php') - output = stdout.read().decode('utf-8') - print(output) - error = stderr.read().decode('utf-8') - if error: - print(f"Fehler: {error}") - - -def get_element(root,id, obj): - for x in root.findall(id): - for key in obj.__dict__.keys(): -# if isinstance(obj.__dict__[key], dict): - if(key!="_to"and key!="_from"): - - if key in aliases.keys(): - key2 = aliases[key] - y=parseChild(x, key2) - else: - y=parseChild(x, key) - setattr(obj, key, y) - return obj - -def recoursion(e, value): - for key2, value2 in value.items(): - if(key2!="attr"): - if key2 in aliases.keys(): - key2 = aliases[key2] - x=ET.SubElement(e, key2) - if isinstance(value2, dict): - recoursion(x,value2) - else: - x.text = value2 - -def update_xml_file(objects,root,type): - el = root.find(type) - el.clear() - for key, value in objects.items(): - if(type=="vlans"): - key="vlan" - if value["attr"] is not {}: - e = ET.SubElement(el, key,value["attr"]) - else: - e=ET.SubElement(el,key) - recoursion(e,value) - -# deprecated due to a logic fail -def get_child(root,element, id, keys): - elements=[] - for parent in root.findall(element): - child= {} - for y in keys: - child[y]=None - for x in parent.findall(id): - for key in keys: - child[key]=parseChild(x, key) - elements.append(child) - return elements - -def replace(item): - Data = {} - #data='{"vlan": {"descr": "example2", "if": "vtnet1", "tag": 110, "pcp": 0, "vlanif": "vlan0.110"}}' - for key, value in item.items(): - if key in aliases.keys(): - Data[aliases[key]] = value - else: - Data[key] = value - return Data diff --git a/python/opnsense_helper.egg-info/PKG-INFO b/python/opnsense_helper.egg-info/PKG-INFO deleted file mode 100644 index ccd7f0f..0000000 --- a/python/opnsense_helper.egg-info/PKG-INFO +++ /dev/null @@ -1,18 +0,0 @@ -Metadata-Version: 2.1 -Name: opnsense_helper -Version: 0.1.10 -Summary: assign lan interfaces, create vlans, vlan-interfaces and setup dhcp in a single script. -Home-page: https://github.com/the-pod-shop/opnsense-helper/ -Author: ji-podhdead -Author-email: ji.podhdead@proton.me -License: BSD 2-clause -Classifier: Development Status :: 1 - Planning -Classifier: Intended Audience :: Science/Research -Classifier: License :: OSI Approved :: BSD License -Classifier: Operating System :: POSIX :: Linux -Classifier: Programming Language :: Python :: 2 -Classifier: Programming Language :: Python :: 2.7 -Classifier: Programming Language :: Python :: 3 -Classifier: Programming Language :: Python :: 3.4 -Classifier: Programming Language :: Python :: 3.5 -Requires-Dist: paramiko diff --git a/python/opnsense_helper.egg-info/SOURCES.txt b/python/opnsense_helper.egg-info/SOURCES.txt deleted file mode 100644 index b3adb48..0000000 --- a/python/opnsense_helper.egg-info/SOURCES.txt +++ /dev/null @@ -1,11 +0,0 @@ -README.md -setup.py -opnsense_helper/__init__.py -opnsense_helper/classes.py -opnsense_helper/frontend_utils.py -opnsense_helper/utils.py -opnsense_helper.egg-info/PKG-INFO -opnsense_helper.egg-info/SOURCES.txt -opnsense_helper.egg-info/dependency_links.txt -opnsense_helper.egg-info/requires.txt -opnsense_helper.egg-info/top_level.txt \ No newline at end of file diff --git a/python/opnsense_helper.egg-info/dependency_links.txt b/python/opnsense_helper.egg-info/dependency_links.txt deleted file mode 100644 index 8b13789..0000000 --- a/python/opnsense_helper.egg-info/dependency_links.txt +++ /dev/null @@ -1 +0,0 @@ - diff --git a/python/opnsense_helper.egg-info/requires.txt b/python/opnsense_helper.egg-info/requires.txt deleted file mode 100644 index 8608c1b..0000000 --- a/python/opnsense_helper.egg-info/requires.txt +++ /dev/null @@ -1 +0,0 @@ -paramiko diff --git a/python/opnsense_helper.egg-info/top_level.txt b/python/opnsense_helper.egg-info/top_level.txt deleted file mode 100644 index 3679a63..0000000 --- a/python/opnsense_helper.egg-info/top_level.txt +++ /dev/null @@ -1 +0,0 @@ -opnsense_helper diff --git a/python/opnsense_helper/opnsense_helper.py b/python/opnsense_helper/opnsense_helper.py index 999a3e4..c9bb6b6 100644 --- a/python/opnsense_helper/opnsense_helper.py +++ b/python/opnsense_helper/opnsense_helper.py @@ -1,8 +1,21 @@ from opnsense_helper.utils.baseclass import Base_Class - +from opnsense_helper.utils import utils class Opnsense_Helper(): def __init__(self, host=None, ssh_auth=None, api_auth=None, conf_path="/conf/config.xml", temp_path="./config.xml", verbose=False, init_config_manager=True): + """ + Initialize an Opnsense_Helper instance. + + :param host: The hostname or ip address of the opnsense firewall. + :param ssh_auth: A dictionary containing the ssh authentication data. + The dictionary must contain the keys "user" and "passw". + :param api_auth: A dictionary containing the api authentication data. + The dictionary must contain the keys "api_key", "api_secret", "ssl" and "verify". + :param conf_path: The path to the config.xml on the opnsense firewall. + :param temp_path: The path to the temporary config.xml file. + :param verbose: If True, the class will print debug messages. + :param init_config_manager: If True, the class will initialize the config_manager. + """ base_class = Base_Class(host, ssh_auth, api_auth, conf_path, temp_path, verbose) self.config_manager=base_class.config_manager self.commands=base_class.commands diff --git a/python/opnsense_helper/scripts.py b/python/opnsense_helper/scripts.py deleted file mode 100644 index 09c95a4..0000000 --- a/python/opnsense_helper/scripts.py +++ /dev/null @@ -1,216 +0,0 @@ -scripts_folder="/usr/local/opnsense/scripts/" -unbound={ -"wrapper":{ "command":scripts_folder+"ubound/wrapper.py*","flags":[]}, -"stats":{ "command":scripts_folder+"ubound/stats.py*","flags":[]}, -"start":{ "command":scripts_folder+"ubound/start.sh*","flags":[]}, -"restore_db":{ "command":scripts_folder+"ubound/restore_db.py*","flags":[]}, -"logger":{ "command":scripts_folder+"ubound/logger.py*","flags":[]}, -"check":{ "command":scripts_folder+"ubound/check.sh*","flags":[]}, -"cache":{ "command":scripts_folder+"ubound/cache.sh*","flags":[]}, -"blocklists":{ "command":scripts_folder+"ubound/blocklists.py*","flags":[]}, -"blocklists":{ "command":scripts_folder+"ubound/blocklists/","flags":[]}, -} -system={ -"trigger_config_changed_events":{"command":scripts_folder+"system/trigger_config_changed_events.py*", "flags":[]}, -"temperature":{"command":scripts_folder+"system/temperature.sh*", "flags":[]}, -"sysctl":{"command":scripts_folder+"system/sysctl.py*", "flags":[]}, -"status":{"command":scripts_folder+"system/status.php*", "flags":[]}, -"ssl_ciphers":{"command":scripts_folder+"system/ssl_ciphers.py*", "flags":[]}, -"rrd_pfstate_info":{"command":scripts_folder+"system/rrd_pfstate_info.py*", "flags":[]}, -"rfc5246_cipher_suites":{"command":scripts_folder+"system/rfc5246_cipher_suites.csv", "flags":[]}, -"remote_backup":{"command":scripts_folder+"system/remote_backup.php*", "flags":[]}, -"nameservers":{"command":scripts_folder+"system/nameservers.php*", "flags":[]}, -"certctl":{"command":scripts_folder+"system/certctl.py*", "flags":[]}, -"activity":{"command":scripts_folder+"system/activity.py*", "flags":[]}, -} -syslog={ - "queryLog":{"command":scripts_folder+"syslog/ queryLog.py*", "flags":[]}, - "logformats":{"command":scripts_folder+"syslog/ logformats/", "flags":[]}, - "log_archive":{"command":scripts_folder+"syslog/ log_archive*", "flags":[]}, - "lockout_handler":{"command":scripts_folder+"syslog/ lockout_handler*", "flags":[]}, - "list_applications":{"command":scripts_folder+"syslog/ list_applications.php*", "flags":[]}, - "generate_certs":{"command":scripts_folder+"syslog/ generate_certs*", "flags":[]}, - "clearlog":{"command":scripts_folder+"syslog/ clearlog.php*", "flags":[]}, -} -suricata={ - "setup":{"command":scripts_folder+"suricata/setup.sh*", "flags":[]}, - "rule-updater":{"command":scripts_folder+"suricata/rule-updater.py*", "flags":[]}, - "queryInstalledRules":{"command":scripts_folder+"suricata/queryInstalledRules.py*", "flags":[]}, - "queryAlertLog":{"command":scripts_folder+"suricata/queryAlertLog.py*", "flags":[]}, - "metadata":{"command":scripts_folder+"suricata/metadata/", "flags":[]}, - "listRuleMetadata":{"command":scripts_folder+"suricata/listRuleMetadata.py*", "flags":[]}, - "listInstallableRulesets":{"command":scripts_folder+"suricata/listInstallableRulesets.py*", "flags":[]}, - "listAlertLogs":{"command":scripts_folder+"suricata/listAlertLogs.py*", "flags":[]}, - "lib":{"command":scripts_folder+"suricata/lib/", "flags":[]}, - "installRules":{"command":scripts_folder+"suricata/installRules.py*", "flags":[]}, - "dropAlertLog":{"command":scripts_folder+"suricata/dropAlertLog.py*", "flags":[]}, - "__init__":{"command":scripts_folder+"suricata/__init__.py*", "flags":[]}, -} -shell={ - "setports":{"command":scripts_folder+"shell/setports.php*","flags":[]}, - "setaddr":{"command":scripts_folder+"shell/setaddr.php*","flags":[]}, - "restore":{"command":scripts_folder+"shell/restore.sh*","flags":[]}, - "reboot":{"command":scripts_folder+"shell/reboot.php*","flags":[]}, - "ping":{"command":scripts_folder+"shell/ping.php*","flags":[]}, - "password":{"command":scripts_folder+"shell/password.php*","flags":[]}, - "halt":{"command":scripts_folder+"shell/halt.php*","flags":[]}, - "firmware":{"command":scripts_folder+"shell/firmware.sh*","flags":[]}, - "defaults":{"command":scripts_folder+"shell/defaults.php*","flags":[]}, - "banner":{"command":scripts_folder+"shell/banner.php*","flags":[]}, -} -shaper={ - "update_tables":{"command":scripts_folder+"shaper/update_tables*","flags":[]}, - "lib":{"command":scripts_folder+"shaper/lib/","flags":[]}, - "dummynet_stats":{"command":scripts_folder+"shaper/dummynet_stats.py*","flags":[]}, -} -routes={ - "show_routes":{"command":scripts_folder+"routes/show_routes.py*","flags":[]}, - "gateways":{"command":scripts_folder+"routes/gateways.php*","flags":[]}, - "gateway_watcher":{"command":scripts_folder+"routes/gateway_watcher.php*","flags":[]}, - "gateway_status":{"command":scripts_folder+"routes/gateway_status.php*","flags":[]}, - "del_route":{"command":scripts_folder+"routes/del_route.py*","flags":[]}, -} -openvpn={ - "user_pass_verify":{"command":scripts_folder+"openvpn/user_pass_verify.php*", "flags":[]}, - "tls_verify":{"command":scripts_folder+"openvpn/tls_verify.php*", "flags":[]}, - "ovpn_status":{"command":scripts_folder+"openvpn/ovpn_status.py*", "flags":[]}, - "ovpn_service_control":{"command":scripts_folder+"openvpn/ovpn_service_control.php*", "flags":[]}, - "ovpn_event":{"command":scripts_folder+"openvpn/ovpn_event.py*", "flags":[]}, - "kill_session":{"command":scripts_folder+"openvpn/kill_session.py*", "flags":[]}, - "client_disconnect":{"command":scripts_folder+"openvpn/client_disconnect.sh*", "flags":[]}, - "client_connect":{"command":scripts_folder+"openvpn/client_connect.php*", "flags":[]}, -} -openssh={ -"ssh_query":{"command":scripts_folder+"openssh/ssh_query.py*","flags":[]}} - -netflow={ - "lib":{"command":scripts_folder+"netflow/lib/","flags":[]}, - "get_top_usage":{"command":scripts_folder+"netflow/get_top_usage.py*","flags":[]}, - "get_timeseries":{"command":scripts_folder+"netflow/get_timeseries.py*","flags":[]}, - "flush_all":{"command":scripts_folder+"netflow/flush_all.sh*","flags":[]}, - "flowd_aggregate_metadata":{"command":scripts_folder+"netflow/flowd_aggregate_metadata.py*","flags":[]}, - "flowd_aggregate":{"command":scripts_folder+"netflow/flowd_aggregate.py*","flags":[]}, - "flowctl_stats":{"command":scripts_folder+"netflow/flowctl_stats.py*","flags":[]}, - "export_details":{"command":scripts_folder+"netflow/export_details.py*","flags":[]}, - "dump_log":{"command":scripts_folder+"netflow/dump_log.py*","flags":[]}, -} -ipsec={ - "updown_event":{"command":scripts_folder+"ipsec/updown_event.py*","flags":[]}, - "spddelete":{"command":scripts_folder+"ipsec/spddelete.py*","flags":[]}, - "saddelete":{"command":scripts_folder+"ipsec/saddelete.py*","flags":[]}, - "list_status":{"command":scripts_folder+"ipsec/list_status.py*","flags":[]}, - "list_spd":{"command":scripts_folder+"ipsec/list_spd.py*","flags":[]}, - "list_sad":{"command":scripts_folder+"ipsec/list_sad.py*","flags":[]}, - "list_leases":{"command":scripts_folder+"ipsec/list_leases.py*","flags":[]}, - "lib":{"command":scripts_folder+"ipsec/lib/","flags":[]}, - "get_legacy_vti.":{"command":scripts_folder+"ipsec/get_legacy_vti.php*","flags":[]}, - "disconnect":{"command":scripts_folder+"ipsec/disconnect.py*","flags":[]}, - "connect":{"command":scripts_folder+"ipsec/connect.py*","flags":[]}, -} -interfaces={ -"traffic_top":{"command": scripts_folder+"interfaces/traffic_top.py*", "flags":[]}, -"traffic_stats":{"command": scripts_folder+"interfaces/traffic_stats.php*", "flags":[]}, -"traceroute":{"command": scripts_folder+"interfaces/traceroute.py*", "flags":[]}, -"rtsold_resolvconf":{"command": scripts_folder+"interfaces/rtsold_resolvconf.sh*", "flags":[]}, -"reconfigure_vlans":{"command": scripts_folder+"interfaces/reconfigure_vlans.php*", "flags":[]}, -"reconfigure_vips":{"command": scripts_folder+"interfaces/reconfigure_vips.php*", "flags":[]}, -"reconfigure_neighbors":{"command": scripts_folder+"interfaces/reconfigure_neighbors.php*", "flags":[]}, -"reconfigure_laggs":{"command": scripts_folder+"interfaces/reconfigure_laggs.php*", "flags":[]}, -"ppp-uptime":{"command": scripts_folder+"interfaces/ppp-uptime.sh*", "flags":[]}, -"ppp-rename":{"command": scripts_folder+"interfaces/ppp-rename.sh*", "flags":[]}, -"ppp-linkup":{"command": scripts_folder+"interfaces/ppp-linkup.sh*", "flags":[]}, -"ppp-linkdown":{"command": scripts_folder+"interfaces/ppp-linkdown.sh*", "flags":[]}, -"portprobe":{"command": scripts_folder+"interfaces/portprobe.py*", "flags":[]}, -"ping":{"command": scripts_folder+"interfaces/ping.py*", "flags":[]}, -"mpd":{"command": scripts_folder+"interfaces/mpd.script*", "flags":[]}, -"macinfo":{"command": scripts_folder+"interfaces/macinfo.py*", "flags":[]}, -"list_sockstat":{"command": scripts_folder+"interfaces/list_sockstat.py*", "flags":[]}, -"list_ndp":{"command": scripts_folder+"interfaces/list_ndp.py*", "flags":[]}, -"list_macdb":{"command": scripts_folder+"interfaces/list_macdb.py*", "flags":[]}, -"list_arp":{"command": scripts_folder+"interfaces/list_arp.py*", "flags":[]}, -"ifctl":{"command": scripts_folder+"interfaces/ifctl.sh*", "flags":[]}, -"dhclient":{"command": scripts_folder+"interfaces/dhclient-script*", "flags":[]}, -"carp_set_status":{"command": scripts_folder+"interfaces/carp_set_status.php*", "flags":[]}, -"carp_global_status":{"command": scripts_folder+"interfaces/carp_global_status.php*", "flags":[]}, -"capture":{"command": scripts_folder+"interfaces/capture.py*", "flags":[]}, -} -health={ - "listReports":{"command":scripts_folder+"health/listReports.py*","flags":[]}, - "flush_rrd":{"command":scripts_folder+"health/flush_rrd.py*","flags":[]}, - "fetchData":{"command":scripts_folder+"health/fetchData.py*","flags":[]}, -} -firmware={ -"upgrade":{"command":scripts_folder+"firmware/upgrade.sh*","flags":[]}, -"update":{"command":scripts_folder+"firmware/update.sh*","flags":[]}, -"unlock":{"command":scripts_folder+"firmware/unlock.sh*","flags":[]}, -"sync.subr":{"command":scripts_folder+"firmware/sync.subr.sh*","flags":[]}, -"sync":{"command":scripts_folder+"firmware/sync.sh*","flags":[]}, -"security":{"command":scripts_folder+"firmware/security.sh*","flags":[]}, -"running":{"command":scripts_folder+"firmware/running.sh*","flags":[]}, -"resync":{"command":scripts_folder+"firmware/resync.sh*","flags":[]}, -"remove":{"command":scripts_folder+"firmware/remove.sh*","flags":[]}, -"reinstall":{"command":scripts_folder+"firmware/reinstall.sh*","flags":[]}, -"register.":{"command":scripts_folder+"firmware/register.php*","flags":[]}, -"reboot":{"command":scripts_folder+"firmware/reboot.sh*","flags":[]}, -"read":{"command":scripts_folder+"firmware/read.sh*","flags":[]}, -"query":{"command":scripts_folder+"firmware/query.sh*","flags":[]}, -"product.":{"command":scripts_folder+"firmware/product.php*","flags":[]}, -"plugin":{"command":scripts_folder+"firmware/plugin.sh*","flags":[]}, -"lock":{"command":scripts_folder+"firmware/lock.sh*","flags":[]}, -"license":{"command":scripts_folder+"firmware/license.sh*","flags":[]}, -"launcher":{"command":scripts_folder+"firmware/launcher.sh*","flags":[]}, -"latest.":{"command":scripts_folder+"firmware/latest.php*","flags":[]}, -"install":{"command":scripts_folder+"firmware/install.sh*","flags":[]}, -"health":{"command":scripts_folder+"firmware/health.sh*","flags":[]}, -"connection":{"command":scripts_folder+"firmware/connection.sh*","flags":[]}, -"check":{"command":scripts_folder+"firmware/check.sh*","flags":[]}, -"changelog":{"command":scripts_folder+"firmware/changelog.sh*","flags":[]}, -} -filter={ -"update_tables":{"commands":scripts_folder+"filter/update_tables.py*","flags":[]}, -"update_bogons":{"commands":scripts_folder+"filter/update_bogons.sh*","flags":[]}, -"run_unittests":{"commands":scripts_folder+"filter/run_unittests.py*","flags":[]}, -"rule_stats":{"commands":scripts_folder+"filter/rule_stats.py*","flags":[]}, -"rollback_timer.":{"commands":scripts_folder+"filter/rollback_timer.php*","flags":[]}, -"rollback_cancel.":{"commands":scripts_folder+"filter/rollback_cancel.php*","flags":[]}, -"read_log":{"commands":scripts_folder+"filter/read_log.py*","flags":[]}, -"pftop":{"commands":scripts_folder+"filter/pftop.py*","flags":[]}, -"pftablecount":{"commands":scripts_folder+"filter/pftablecount.py*","flags":[]}, -"pfstatistics":{"commands":scripts_folder+"filter/pfstatistics.py*","flags":[]}, -"list_tables":{"commands":scripts_folder+"filter/list_tables.py*","flags":[]}, -"list_table":{"commands":scripts_folder+"filter/list_table.py*","flags":[]}, -"list_states":{"commands":scripts_folder+"filter/list_states.py*","flags":[]}, -"list_rule_ids":{"commands":scripts_folder+"filter/list_rule_ids.py*","flags":[]}, -"list_pfsync":{"commands":scripts_folder+"filter/list_pfsync.py*","flags":[]}, -"list_osfp":{"commands":scripts_folder+"filter/list_osfp.py*","flags":[]}, -"kill_table":{"commands":scripts_folder+"filter/kill_table.py*","flags":[]}, -"kill_states":{"commands":scripts_folder+"filter/kill_states.py*","flags":[]}, -"find_table_references":{"commands":scripts_folder+"filter/find_table_references.py*","flags":[]}, -"download_geoip":{"commands":scripts_folder+"filter/download_geoip.py*","flags":[]}, -"delete_table":{"commands":scripts_folder+"filter/delete_table.py*","flags":[]}, -} -dns={ - "query_dns":{"commands":scripts_folder+"dns/query_dns.py*","flags":[]} -} - -dhcp={ -"unbound_watche":{"command":scripts_folder+"dhcp/unbound_watcher.py*","flags":[]}, -"prefixe":{"command":scripts_folder+"dhcp/prefixes.sh*","flags":[]}, -"prefixes":{"command":scripts_folder+"dhcp/prefixes.php*","flags":[]}, -"get_leases":{"command":scripts_folder+"dhcp/get_leases6.py*","flags":[]}, -"get_lease":{"command":scripts_folder+"dhcp/get_leases.py*","flags":[]}, -"get_kea_lease":{"command":scripts_folder+"dhcp/get_kea_leases.py*","flags":[]}, -"dnsmasq_watche":{"command":scripts_folder+"dhcp/dnsmasq_watcher.py*","flags":[]}, -"cleanup_leases6":{"command":scripts_folder+"dhcp/cleanup_leases6.php*","flags":[]}, -"cleanup_leases4":{"command":scripts_folder+"dhcp/cleanup_leases4.php*","flags":[]}, -} -auth={ -"list_group_members":{"command":scripts_folder+"auth/list_group_members.php*","flags":[]}, -"add_user":{"command":scripts_folder+"auth/add_user.php*","flags":[]}, -} -Wireguard={ -"wg_show":{"command":scripts_folder+"wireguard/wg_show.py*","flags":[]}, -"wg-service-control":{"command":scripts_folder+"wireguard/wg-service-control.php*","flags":[]}, -"reresolve-dns":{"command":scripts_folder+"wireguard/reresolve-dns.py*","flags":[]}, -"gen_keypair":{"command":scripts_folder+"wireguard/gen_keypair.py*","flags":[]}, -} \ No newline at end of file diff --git a/python/opnsense_helper/utils.py b/python/opnsense_helper/utils.py deleted file mode 100644 index 6c50621..0000000 --- a/python/opnsense_helper/utils.py +++ /dev/null @@ -1,97 +0,0 @@ -import xml.etree.ElementTree as ET -# import libraries -import json -import xml.etree.ElementTree as ET -import requests -import os - -aliases={ -"parent": "if", -"_from":"from", -"_to":"to", -"interface":"if", -"_range":"range" -} - -def parseChild(child, tag): - result=child.find(tag) - element=result.text if result is not None else None - return element - -def ping(helper): - response = os.system(f"ping -c 1 {helper.host}") - if response == 0: - print(f"IP {helper.host} is reachable") - return 0 - else: return 1 -def format_flags(flags_array): - return ' '.join(map(str, flags_array)) -def exec(helper, obj): - flags= format_flags[obj["flags"]] if obj["flags"] is not [] else "" - stdin, stdout, stderr = helper.ssh.exec_command(f"""{obj["command"]} {obj["argument"]if obj["argument"] is not None else ""} {flags}""") - output = stdout.read().decode('utf-8') - print(output) - error = stderr.read().decode('utf-8') - if error: - print(f"Fehler: {error}") - - -def get_element(root,id, obj): - for x in root.findall(id): - for key in obj.__dict__.keys(): -# if isinstance(obj.__dict__[key], dict): - if(key!="_to"and key!="_from"): - - if key in aliases.keys(): - key2 = aliases[key] - y=parseChild(x, key2) - else: - y=parseChild(x, key) - setattr(obj, key, y) - return obj - -def recoursion(e, value): - for key2, value2 in value.items(): - if(key2!="attr"): - if key2 in aliases.keys(): - key2 = aliases[key2] - x=ET.SubElement(e, key2) - if isinstance(value2, dict): - recoursion(x,value2) - else: - x.text = value2 - -def update_xml_file(objects,root,type): - el = root.find(type) - el.clear() - for key, value in objects.items(): - if(type=="vlans"): - key="vlan" - if value["attr"] is not {}: - e = ET.SubElement(el, key,value["attr"]) - else: - e=ET.SubElement(el,key) - recoursion(e,value) - -# deprecated due to a logic fail -def get_child(root,element, id, keys): - elements=[] - for parent in root.findall(element): - child= {} - for y in keys: - child[y]=None - for x in parent.findall(id): - for key in keys: - child[key]=parseChild(x, key) - elements.append(child) - return elements - -def replace(item): - Data = {} - #data='{"vlan": {"descr": "example2", "if": "vtnet1", "tag": 110, "pcp": 0, "vlanif": "vlan0.110"}}' - for key, value in item.items(): - if key in aliases.keys(): - Data[aliases[key]] = value - else: - Data[key] = value - return Data diff --git a/pyproject.toml_old b/python/pyproject.toml_old similarity index 100% rename from pyproject.toml_old rename to python/pyproject.toml_old