Reset
This commit is contained in:
Agie Ashwood
commit
cce193ea43
|
|
@ -0,0 +1,20 @@
|
|||
lib/
|
||||
lib64/
|
||||
share/
|
||||
src/__pycache__/
|
||||
src/webui/build/
|
||||
src/webui/htmx-extensions/
|
||||
src/webui/res/js/node_modules/
|
||||
tui.rst
|
||||
lib64
|
||||
src/Components/__pycache__/
|
||||
bin/
|
||||
src/daisy/
|
||||
src/catch/
|
||||
src/Cryptography/__pycache__/
|
||||
src/webui/__pycache__
|
||||
src/logs
|
||||
src/Packets/__pycache__
|
||||
src/Transmission/__pycache__/
|
||||
src/Filters/Protocols/__pycache__
|
||||
src/Bubble/__pycache__
|
||||
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
|
|
@ -0,0 +1,9 @@
|
|||
rm -rf docs/*
|
||||
sphinx-build -M markdown src docs
|
||||
mv docs/markdown docs.tmp
|
||||
rm -rf docs/doctrees
|
||||
mv docs.tmp/* docs
|
||||
rm -rf docs.tmp
|
||||
mv docs/index.md docs/readme.md
|
||||
sed -i '1s;^;\n\n;' docs/readme.md
|
||||
sed -i '1s;^;\n\n;' docs/Components/daisy.md
|
||||
|
|
@ -0,0 +1 @@
|
|||
# Configuration utilities
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Network map representation
|
||||
|
||||
### *class* Bubble.map.Network(icg=None, file=None)
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Data routing logic and data
|
||||
|
||||
### *class* Bubble.router.Router(cLog, nfpath='server.info')
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
|
||||
|
||||
# Schemaless binary database
|
||||
|
||||
### *class* Components.daisy.Daisy(filepath: str, templates: dict = {}, template: bool = False, prefillDict: bool = False)
|
||||
|
||||
Base class for Daisy data representation
|
||||
|
||||
[🔗 Source](https://git.utopic.work/PierMesh/piermesh/src/branch/main/Components/daisy.py)
|
||||
|
||||
#### get()
|
||||
|
||||
Get record dictionary from memory
|
||||
|
||||
* **Returns:**
|
||||
**self.msg**
|
||||
* **Return type:**
|
||||
dict
|
||||
|
||||
#### read(decrypt: bool = False, decryptKey=False)
|
||||
|
||||
Read record from disk to memory
|
||||
|
||||
* **Parameters:**
|
||||
* **decrypt** (*bool*) – Whether to decrypt record
|
||||
* **decryptKey** – Key to decrypt record
|
||||
|
||||
#### sublist()
|
||||
|
||||
Lists contents of directory if object is a directory, otherwise return None
|
||||
|
||||
#### write(override=False, encrypt: bool = False, encryptKey=None, recur: bool = False)
|
||||
|
||||
Write record to disk
|
||||
|
||||
* **Parameters:**
|
||||
* **override** – Either false or a dictionary of values to set on the record
|
||||
* **encrypt** (*bool*) – Whether to encrypt the record (TODO)
|
||||
* **encryptKey** – Key to encrypt record with, or None if not set
|
||||
* **recur** (*bool*) – Whether to recursively handle keys
|
||||
|
||||
### *class* Components.daisy.Cache(filepaths=None, cacheFile=None, path: str = 'daisy', walk: bool = False, isCatch: bool = False)
|
||||
|
||||
In memory collection of Daisy records
|
||||
|
||||
#### create(path: str, data: dict)
|
||||
|
||||
Create new record
|
||||
|
||||
* **Parameters:**
|
||||
* **path** (*str*) – Path to create record at
|
||||
* **data** (*dict*) – Data to populate record with
|
||||
|
||||
#### get(path: str)
|
||||
|
||||
Get record at path, else return False
|
||||
|
||||
path: str
|
||||
: Path of record
|
||||
|
||||
#### refresh()
|
||||
|
||||
Reload from disk to memory
|
||||
|
||||
#### search(keydict: dict, strict: bool = True)
|
||||
|
||||
Search cache for record for records with values
|
||||
|
||||
keydict: dict
|
||||
: Values to search for
|
||||
|
||||
strict: bool
|
||||
: Whether to require values match
|
||||
|
||||
### *class* Components.daisy.Catch(path: str = 'catch', filepaths=None, catchFile=None, walk: bool = False)
|
||||
|
||||
Sub class of Cache for handling catchs
|
||||
|
||||
|
||||
|
||||
#### get(head: str, tail: str, fins=None)
|
||||
|
||||
Get catch by pieces
|
||||
|
||||
* **Parameters:**
|
||||
* **head** (*str*) – First part of catch (maximum: 4 characters)
|
||||
* **tail** (*str*) – Second part of catch (maximum: 16 characters)
|
||||
* **fins** – List of (maximum 8 characters) strings at the end of the catch oe None if none
|
||||
|
||||
#### sget(path: str)
|
||||
|
||||
Call Cache’s get to get record
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
# Small internet interop utilities
|
||||
|
||||
### Components.hopper.get(url: str, params=None)
|
||||
|
||||
http/s get request
|
||||
|
||||
* **Parameters:**
|
||||
* **url** (*str*)
|
||||
* **params** – Requests (library) parameters
|
||||
|
||||
### Components.hopper.post(url: str, params=None)
|
||||
|
||||
http/s post request
|
||||
|
||||
* **Parameters:**
|
||||
* **url** (*str*)
|
||||
* **params** – Requests (library) parameters
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
Diffie hellman ephemeral
|
||||
Fernet based encryption
|
||||
==========================
|
||||
|
||||
### *class* Cryptography.DHEFern.DHEFern(cache, nodeNickname, cLog)
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
Primary filtering functionality
|
||||
Dispatches to Protocols
|
||||
===============================
|
||||
|
||||
### *class* Filters.base.Filter(cache, onodeID, todo, cLog)
|
||||
|
||||
#### *async* protoRoute(completeMessage)
|
||||
|
||||
Shorthand reference
|
||||
|
||||
### *class* Filters.Protocols.bubble.filter(completeMessage, recipient, recipientNode, onodeID, todo)
|
||||
|
||||
### *class* Filters.Protocols.catch.filter(completeMessage, recipient, recipientNode, todo)
|
||||
|
||||
### *class* Filters.Protocols.cryptography.filter(completeMessage, recipientNode, todo)
|
||||
|
||||
### *class* Filters.Protocols.map.filter(completeMessage, todo)
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Header packet: Metadata packet
|
||||
|
||||
### *class* Packets.HeaderPacket.Header(packetsID, packetCount, sender, senderDisplayName, recipient, recipientNode, json=True, fname=False, subpacket=False, wantFullResponse=False, mimeType=-1, protocol=None, packetsClass=0)
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Base packet
|
||||
|
||||
### *class* Packets.Packet.Packet(data, packetsID=False, packetNumber=False, packetCount=1, packetsClass=-1)
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
Packets representation for full
|
||||
message
|
||||
===============================
|
||||
|
||||
### *class* Packets.Packets.Packets(bytesObject, sender, senderDisplayName, recipient, recipientNode, dataSize=128, wantFullResponse=False, packetsClass=None)
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
SinglePacket: Singular packet
|
||||
for very low data applications
|
||||
===============================
|
||||
|
||||
### *class* Packets.SinglePacket.SinglePacket(data, packetsID, packetsClass=None, cache=None)
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
SubPacket for handling
|
||||
individual packets of submessages
|
||||
=================================
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
SubPackets for handling
|
||||
full submessages
|
||||
=======================
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# Layer 0 data transmission
|
||||
|
||||
### *class* Transmission.transmission.Transmitter(device, filter, onodeID, cache, catch, cryptographyInfo, cLog)
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
|
||||
|
||||
<!-- PierMesh documentation master file, created by
|
||||
sphinx-quickstart on Fri Jul 26 23:30:55 2024. -->
|
||||
|
||||
# PierMesh documentation
|
||||
|
||||
# Contents:
|
||||
|
||||
* [PierMesh service runner](/PierMesh/piermesh/src/branch/main/docs/run.md)
|
||||
* [`Node`](/PierMesh/piermesh/src/branch/main/docs/run.md#run.Node)
|
||||
* [`Node.action_initNodeDH()`](/PierMesh/piermesh/src/branch/main/docs/run.md#run.Node.action_initNodeDH)
|
||||
* [`Node.action_keyDeriveDH()`](/PierMesh/piermesh/src/branch/main/docs/run.md#run.Node.action_keyDeriveDH)
|
||||
* [`Node.action_map()`](/PierMesh/piermesh/src/branch/main/docs/run.md#run.Node.action_map)
|
||||
* [`Node.action_sendCatch()`](/PierMesh/piermesh/src/branch/main/docs/run.md#run.Node.action_sendCatch)
|
||||
* [`Node.action_sendToPeer()`](/PierMesh/piermesh/src/branch/main/docs/run.md#run.Node.action_sendToPeer)
|
||||
* [`Node.cLog()`](/PierMesh/piermesh/src/branch/main/docs/run.md#run.Node.cLog)
|
||||
* [`Node.fListen()`](/PierMesh/piermesh/src/branch/main/docs/run.md#run.Node.fListen)
|
||||
* [`Node.monitor()`](/PierMesh/piermesh/src/branch/main/docs/run.md#run.Node.monitor)
|
||||
* [`Node.toLog`](/PierMesh/piermesh/src/branch/main/docs/run.md#run.Node.toLog)
|
||||
* [TUI application](/PierMesh/piermesh/src/branch/main/docs/ui.md)
|
||||
* [`TUI`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI)
|
||||
* [`TUI.visibleLogo`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.visibleLogo)
|
||||
* [`TUI.nodeOb`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.nodeOb)
|
||||
* [`TUI.done`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.done)
|
||||
* [`TUI.CSS_PATH`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.CSS_PATH)
|
||||
* [`TUI.action_quitFull()`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.action_quitFull)
|
||||
* [`TUI.action_toggleFullscreen()`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.action_toggleFullscreen)
|
||||
* [`TUI.compose()`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.compose)
|
||||
* [`TUI.do_set_cpu_percent()`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.do_set_cpu_percent)
|
||||
* [`TUI.do_set_mem()`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.do_set_mem)
|
||||
* [`TUI.do_write_line()`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.do_write_line)
|
||||
* [`TUI.on_mount()`](/PierMesh/piermesh/src/branch/main/docs/ui.md#ui.TUI.on_mount)
|
||||
* [Configuration utilities](/PierMesh/piermesh/src/branch/main/docs/Bubble/config.md)
|
||||
* [Network map representation](/PierMesh/piermesh/src/branch/main/docs/Bubble/map.md)
|
||||
* [`Network`](/PierMesh/piermesh/src/branch/main/docs/Bubble/map.md#Bubble.map.Network)
|
||||
* [Data routing logic and data](/PierMesh/piermesh/src/branch/main/docs/Bubble/router.md)
|
||||
* [`Router`](/PierMesh/piermesh/src/branch/main/docs/Bubble/router.md#Bubble.router.Router)
|
||||
* [Schemaless binary database](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md)
|
||||
* [`Daisy`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Daisy)
|
||||
* [`Daisy.get()`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Daisy.get)
|
||||
* [`Daisy.read()`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Daisy.read)
|
||||
* [`Daisy.sublist()`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Daisy.sublist)
|
||||
* [`Daisy.write()`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Daisy.write)
|
||||
* [`Cache`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Cache)
|
||||
* [`Cache.create()`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Cache.create)
|
||||
* [`Cache.get()`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Cache.get)
|
||||
* [`Cache.refresh()`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Cache.refresh)
|
||||
* [`Cache.search()`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Cache.search)
|
||||
* [`Catch`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Catch)
|
||||
* [`Catch.get()`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Catch.get)
|
||||
* [`Catch.sget()`](/PierMesh/piermesh/src/branch/main/docs/Components/daisy.md#Components.daisy.Catch.sget)
|
||||
* [Small internet interop utilities](/PierMesh/piermesh/src/branch/main/docs/Components/hopper.md)
|
||||
* [`get()`](/PierMesh/piermesh/src/branch/main/docs/Components/hopper.md#Components.hopper.get)
|
||||
* [`post()`](/PierMesh/piermesh/src/branch/main/docs/Components/hopper.md#Components.hopper.post)
|
||||
* [`DHEFern`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/DHEFern.md)
|
||||
* [`Filter`](/PierMesh/piermesh/src/branch/main/docs/Filters/base.md)
|
||||
* [`Filter.protoRoute()`](/PierMesh/piermesh/src/branch/main/docs/Filters/base.md#Filters.base.Filter.protoRoute)
|
||||
* [`filter`](/PierMesh/piermesh/src/branch/main/docs/Filters/base.md#Filters.Protocols.bubble.filter)
|
||||
* [`filter`](/PierMesh/piermesh/src/branch/main/docs/Filters/base.md#Filters.Protocols.catch.filter)
|
||||
* [`filter`](/PierMesh/piermesh/src/branch/main/docs/Filters/base.md#Filters.Protocols.cryptography.filter)
|
||||
* [`filter`](/PierMesh/piermesh/src/branch/main/docs/Filters/base.md#Filters.Protocols.map.filter)
|
||||
* [Header packet: Metadata packet](/PierMesh/piermesh/src/branch/main/docs/Packets/HeaderPacket.md)
|
||||
* [`Header`](/PierMesh/piermesh/src/branch/main/docs/Packets/HeaderPacket.md#Packets.HeaderPacket.Header)
|
||||
* [Base packet](/PierMesh/piermesh/src/branch/main/docs/Packets/Packet.md)
|
||||
* [`Packet`](/PierMesh/piermesh/src/branch/main/docs/Packets/Packet.md#Packets.Packet.Packet)
|
||||
* [`Packets`](/PierMesh/piermesh/src/branch/main/docs/Packets/Packets.md)
|
||||
* [`SinglePacket`](/PierMesh/piermesh/src/branch/main/docs/Packets/SinglePacket.md)
|
||||
* [Layer 0 data transmission](/PierMesh/piermesh/src/branch/main/docs/Transmission/transmission.md)
|
||||
* [`Transmitter`](/PierMesh/piermesh/src/branch/main/docs/Transmission/transmission.md#Transmission.transmission.Transmitter)
|
||||
|
|
@ -0,0 +1,88 @@
|
|||
# PierMesh service runner
|
||||
|
||||
Main method for running the PierMesh service
|
||||
|
||||
### *class* run.Node
|
||||
|
||||
Class that handles most of the PierMesh data
|
||||
|
||||
[🔗 Source](https://git.utopic.work/PierMesh/piermesh/src/branch/main/src/run.py)
|
||||
|
||||
#### *async* action_initNodeDH(data: dict)
|
||||
|
||||
Initialize diffie hellman key exchange
|
||||
|
||||
#### SEE ALSO
|
||||
[`Cryptography.DHEFern.DHEFern`](/PierMesh/piermesh/src/branch/main/docs/Cryptography/DHEFern.md#Cryptography.DHEFern.DHEFern)
|
||||
: End to end encryption functionality
|
||||
|
||||
#### *async* action_keyDeriveDH(data: dict)
|
||||
|
||||
Derive key via diffie hellman key exchange
|
||||
|
||||
#### *async* action_map(data: dict)
|
||||
|
||||
Map new network data to internal network map
|
||||
|
||||
#### SEE ALSO
|
||||
`Bubble.network.Network`
|
||||
: Layered graph etwork representation
|
||||
|
||||
#### *async* action_sendCatch(data: dict)
|
||||
|
||||
Get catch and return the data to a peer
|
||||
|
||||
#### SEE ALSO
|
||||
[`Bubble.router.Router`](/PierMesh/piermesh/src/branch/main/docs/Bubble/router.md#Bubble.router.Router)
|
||||
: Routing class
|
||||
|
||||
#### *async* action_sendToPeer(data: dict)
|
||||
|
||||
Send data to a peer connected to the server
|
||||
|
||||
* **Parameters:**
|
||||
**data** (*dict*) – Data passed from the filter, this is a generic object so it’s similar on all actions here
|
||||
|
||||
#### SEE ALSO
|
||||
`Filters.Protocols`
|
||||
: Protocol based packet filtering
|
||||
|
||||
`webui.serve.Server`
|
||||
: Runs a light Microdot web server with http/s and websocket functionality
|
||||
|
||||
`webui.serve.Server.sendToPeer`
|
||||
: Function to actually execute the action
|
||||
|
||||
#### cLog(priority: int, message: str)
|
||||
|
||||
Convenience function that logs to the ui and log files
|
||||
|
||||
* **Parameters:**
|
||||
* **priority** (*int*) – Priority of message to be passed to logging
|
||||
* **message** (*str*) – Message to log
|
||||
* **Return type:**
|
||||
None
|
||||
|
||||
#### *async* fListen()
|
||||
|
||||
Loop to watch for tasks to do
|
||||
|
||||
#### SEE ALSO
|
||||
`Filters.base.sieve`
|
||||
: Packet filtering/parsing
|
||||
|
||||
### Notes
|
||||
|
||||
We use a common technique here that calls the function from our preloaded actions via dictionary entry
|
||||
|
||||
#### *async* monitor()
|
||||
|
||||
Monitor and log ram and cpu usage
|
||||
|
||||
#### toLog
|
||||
|
||||
We store logs to be processed here
|
||||
|
||||
#### SEE ALSO
|
||||
`logPassLoop`
|
||||
: Loop to handle logging to file and TUI
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
# TUI application
|
||||
|
||||
### *class* ui.TUI(driver_class: Type[Driver] | None = None, css_path: str | PurePath | List[str | PurePath] | None = None, watch_css: bool = False)
|
||||
|
||||
TUI for PierMesh
|
||||
|
||||
[🔗 Source](https://git.utopic.work/PierMesh/piermesh/src/branch/main/src/ui.py)
|
||||
|
||||
#### visibleLogo
|
||||
|
||||
Whether the logo is visible or not, used in toggling visibility
|
||||
|
||||
* **Type:**
|
||||
bool
|
||||
|
||||
#### nodeOb
|
||||
|
||||
Reference to the Node running the PierMesh service
|
||||
|
||||
* **Type:**
|
||||
[Node](/PierMesh/piermesh/src/branch/main/docs/run.md#run.Node)
|
||||
|
||||
#### done
|
||||
|
||||
Whether the TUI has been killed
|
||||
|
||||
* **Type:**
|
||||
bool
|
||||
|
||||
#### CSS_PATH *: ClassVar[CSSPathType | None]* *= 'ui.tcss'*
|
||||
|
||||
File paths to load CSS from.
|
||||
|
||||
#### action_quitFull()
|
||||
|
||||
Kill the whole stack by setting self to done and terminating the thread. We check in run.monitor later and kill the rest of the stack then with psutil
|
||||
|
||||
#### SEE ALSO
|
||||
`run.monitor`
|
||||
|
||||
#### action_toggleFullscreen()
|
||||
|
||||
Toggle fullscreen logs by either collapsing width or setting it to it’s original size
|
||||
|
||||
#### compose()
|
||||
|
||||
Build the TUI
|
||||
|
||||
#### do_set_cpu_percent(percent: float)
|
||||
|
||||
Set CPU percent in the label and progress bar
|
||||
|
||||
* **Parameters:**
|
||||
**percent** (*float*) – Percent of the cpu PierMesh is using
|
||||
|
||||
#### do_set_mem(memmb: float)
|
||||
|
||||
Set memory usage label in the ui
|
||||
|
||||
* **Parameters:**
|
||||
**memmb** (*float*) – Memory usage of PierMesh in megabytes
|
||||
|
||||
#### do_write_line(logLine: str)
|
||||
|
||||
Write line to the logs panel
|
||||
|
||||
* **Parameters:**
|
||||
**logLine** (*str*) – Line to log
|
||||
|
||||
#### on_mount()
|
||||
|
||||
Called at set up, configures the title and the progess bar
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 275 B |
Binary file not shown.
|
After Width: | Height: | Size: 332 B |
Binary file not shown.
|
After Width: | Height: | Size: 89 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.3 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 89 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.3 KiB |
|
|
@ -0,0 +1,3 @@
|
|||
home = /usr/bin
|
||||
include-system-site-packages = false
|
||||
version = 3.10.12
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
|
||||
# PierMesh
|
||||
## A new internet, a fresh start
|
||||
|
||||
This is the monorepo for PierMesh.
|
||||
|
||||
# Docs
|
||||
|
||||
You can find the full docs here: [docs/](https://git.utopic.work/PierMesh/piermesh/src/branch/main/docs)
|
||||
|
||||
# How to use
|
||||
|
||||
Note: these instructions will probably only work on Linux at the moment
|
||||
|
||||
Note: check the scripts to make sure they'll work with your system, and in general I recommend checking scripts before you run them
|
||||
|
||||
Follow Meshtastic's guide on setting up your device: [https://meshtastic.org/docs/getting-started/](https://meshtastic.org/docs/getting-started/)
|
||||
Make sure you have the latest Python installed
|
||||
|
||||
```
|
||||
git clone https://git.utopic.work/PierMesh/piermesh
|
||||
|
||||
cd piermesh
|
||||
|
||||
python -m venv .
|
||||
|
||||
source bin/activate
|
||||
|
||||
pip install -r requirements.txt
|
||||
|
||||
cd src
|
||||
|
||||
chmod a+x ./scripts/falin
|
||||
|
||||
./scripts/falin
|
||||
```
|
||||
|
||||
# License text
|
||||
|
||||
```
|
||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along with this program. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).
|
||||
```
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
pytap
|
||||
meshtastic
|
||||
beautifulsoup4
|
||||
msgpack
|
||||
esptool
|
||||
jinja2
|
||||
markdown2
|
||||
watchdog
|
||||
microdot
|
||||
networkx[default]
|
||||
psutil
|
||||
sphinx
|
||||
textual
|
||||
textual-dev
|
||||
sphinx-markdown-builder==0.6.6
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
Configuration utilities
|
||||
==========================
|
||||
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
import networkx as nx
|
||||
import msgpack
|
||||
import json
|
||||
import matplotlib.pyplot as plt
|
||||
|
||||
# TODO: Extra maps logic
|
||||
|
||||
|
||||
class Network:
|
||||
"""
|
||||
Layered graph network
|
||||
|
||||
`🔗 Source <https://git.utopic.work/PierMesh/piermesh/src/branch/main/src/Bubble/map.py>`_
|
||||
"""
|
||||
|
||||
def __init__(self, icg=None, file=None):
|
||||
self.omap = nx.Graph()
|
||||
self.imap = nx.Graph()
|
||||
self.emaps = []
|
||||
self.lookup = {}
|
||||
|
||||
def addLookup(self, onodeID, mnodeID):
|
||||
self.lookup[onodeID] = mnodeID
|
||||
|
||||
def doLookup(self, onodeID):
|
||||
if onodeID in self.lookup.keys():
|
||||
return self.lookup[onodeID]
|
||||
else:
|
||||
return False
|
||||
|
||||
def export(self, path):
|
||||
n = {}
|
||||
n["omap"] = nx.to_dict_of_dicts(self.omap)
|
||||
n["imap"] = nx.to_dict_of_dicts(self.imap)
|
||||
n["emaps"] = []
|
||||
for e in self.emaps:
|
||||
n["emaps"].append(nx.to_dict_of_dicts(e))
|
||||
# TODO: Daisy
|
||||
with open(path, "wb") as f:
|
||||
f.write(msgpack.dumps(n))
|
||||
with open(path + ".json", "w") as f:
|
||||
f.write(json.dumps(n))
|
||||
|
||||
def mimport(self, path):
|
||||
ndata = ""
|
||||
with open(path, "rb") as f:
|
||||
ndata = msgpack.loads(f.read())
|
||||
self.omap = nx.Graph(ndata["omap"])
|
||||
self.imap = nx.Graph(ndata["imap"])
|
||||
self.emaps = []
|
||||
for e in ndata["emaps"]:
|
||||
self.emaps.append(nx.Graph(e))
|
||||
|
||||
def addon(self, id):
|
||||
self.omap.add_node(id)
|
||||
|
||||
def addoe(self, nodea, nodeb):
|
||||
self.omap.add_edge(nodea, nodeb)
|
||||
|
||||
def addin(self, id):
|
||||
self.imap.add_node(id)
|
||||
|
||||
def addie(self, nodea, nodeb):
|
||||
self.imap.add_edge(nodea, nodeb)
|
||||
|
||||
def getRoute(self, senderNode, recipientNode):
|
||||
return nx.shortest_path(self.omap, senderNode, recipientNode)
|
||||
|
||||
def render(self):
|
||||
nx.draw(self.omap)
|
||||
plt.savefig("tmp/omap.png")
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
Network map representation
|
||||
==========================
|
||||
|
||||
.. autoclass:: Bubble.map.Network
|
||||
:members:
|
||||
|
|
@ -0,0 +1,41 @@
|
|||
import msgpack
|
||||
from Bubble.map import Network
|
||||
from Components.daisy import Catch
|
||||
from Components.daisy import Cache
|
||||
import random, logging
|
||||
|
||||
# DONE Catch integration
|
||||
# TODO: Catch examples
|
||||
#
|
||||
# 🐟+🔥+🤤
|
||||
# prmh.catchexample.rabbit.hutch
|
||||
# 🟥|🟧|🟦
|
||||
# 🖐️📡🌍
|
||||
# prmh@Ashwood_Skye
|
||||
# 💻💻
|
||||
|
||||
|
||||
class Router:
|
||||
def __init__(self, cLog, nfpath="server.info"):
|
||||
self.cLog = cLog
|
||||
# TODO: Better network init
|
||||
self.n = Network()
|
||||
self.c = Catch(walk=True)
|
||||
self.cache = Cache(walk=True)
|
||||
self.cLog(10, "Loading server info")
|
||||
self.serverInfo = self.cache.get(nfpath)
|
||||
if self.serverInfo == False:
|
||||
self.cache.create(nfpath, {"nodeID": random.randrange(0, 1000000)})
|
||||
self.serverInfo = self.cache.get(nfpath)
|
||||
self.n.addin(self.serverInfo.get()["nodeID"])
|
||||
|
||||
def getRoute(self, headerPacket):
|
||||
headerPacket = msgpack.loads(headerPacket)
|
||||
peer = headerPacket["recipient"]
|
||||
node = headerPacket["node"]
|
||||
|
||||
def getCatch(self, head, tail, fins=None):
|
||||
return self.c.get(head, tail, fins=fins)
|
||||
|
||||
def addc(self, peer, node, seperator, head, tail, data, fins=None):
|
||||
self.c.addc(peer, node, seperator, head, tail, data, fins=fins)
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
Data routing logic and data
|
||||
===========================
|
||||
|
||||
.. autoclass:: Bubble.router.Router
|
||||
:members:
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
from Bubble.map import Network
|
||||
import random
|
||||
|
||||
# TODO: Creating network from 0
|
||||
|
||||
n = Network()
|
||||
|
||||
onodes = [random.randrange(1, 1000000) for it in range(20)]
|
||||
|
||||
for onode in onodes:
|
||||
n.addon(onode)
|
||||
n.addin(onode)
|
||||
|
||||
for it in range(10):
|
||||
nodea = random.choice(onodes)
|
||||
print(nodea)
|
||||
nodeb = random.choice([n for n in onodes if n != nodea])
|
||||
print(nodeb)
|
||||
n.addoe(nodea, nodeb)
|
||||
|
||||
for it in range(10):
|
||||
nodea = random.choice(onodes)
|
||||
nodeb = random.choice([n for n in onodes if n != nodea])
|
||||
#print(n.getRoute(nodea, nodeb))
|
||||
n.export("tmp/map.bin")
|
||||
n.render()
|
||||
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
import random
|
||||
|
||||
class Client:
|
||||
def __init__(self, nodeID, permissions=False):
|
||||
self.cid = random.randrange(1, 1000000)
|
||||
self.nodeID = nodeID
|
||||
|
||||
|
|
@ -0,0 +1,423 @@
|
|||
import os
|
||||
import json
|
||||
import msgpack
|
||||
import Cryptography
|
||||
import random
|
||||
from watchdog.observers import Observer
|
||||
from watchdog.events import FileSystemEventHandler
|
||||
import logging
|
||||
|
||||
# TODO: delete
|
||||
# TODO: propagate json changes to msgpack automatically
|
||||
# TODO: propagate msgpack changes to cache automatically
|
||||
# TODO: Indexing
|
||||
|
||||
|
||||
def _json_to_msg(path: str):
|
||||
"""
|
||||
Convert json at the path plus .json to a msgpack binary
|
||||
|
||||
Parameters
|
||||
----------
|
||||
path: str
|
||||
Path to json minus the extension
|
||||
"""
|
||||
rpath = path + ".json"
|
||||
res = ""
|
||||
with open(rpath) as f:
|
||||
res = msgpack.dumps(json.load(f))
|
||||
with open(path, "wb") as f:
|
||||
f.write(res)
|
||||
|
||||
|
||||
class Daisy:
|
||||
"""
|
||||
Base class for Daisy data representation
|
||||
|
||||
`🔗 Source <https://git.utopic.work/PierMesh/piermesh/src/branch/main/Components/daisy.py>`_
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
filepath: str,
|
||||
templates: dict = {},
|
||||
template: bool = False,
|
||||
prefillDict: bool = False,
|
||||
):
|
||||
"""
|
||||
Parameters
|
||||
----------
|
||||
filepath: str
|
||||
Path to disk location
|
||||
|
||||
templates: dict
|
||||
Dictionary of templates to Use
|
||||
|
||||
template: bool
|
||||
Which template to Use
|
||||
|
||||
prefillDict: bool
|
||||
Whether to fill the record with a template
|
||||
"""
|
||||
self.filepath = filepath
|
||||
if os.path.exists(filepath) != True:
|
||||
with open(filepath, "wb") as f:
|
||||
if template != False:
|
||||
if template in templates.keys():
|
||||
t = templates[template].get()
|
||||
if prefillDict != False:
|
||||
for k in prefillDict.keys():
|
||||
t[k] = prefillDict[k]
|
||||
f.write(msgpack.dumps(t))
|
||||
self.msg = t
|
||||
else:
|
||||
print("No such template as: " + template)
|
||||
else:
|
||||
f.write(msgpack.dumps({}))
|
||||
self.msg = {}
|
||||
elif os.path.isdir(filepath):
|
||||
self.msg = "directory"
|
||||
else:
|
||||
with open(filepath, "rb") as f:
|
||||
self.msg = msgpack.loads(f.read())
|
||||
|
||||
# Use override for updating
|
||||
|
||||
def write(
|
||||
self,
|
||||
override=False,
|
||||
encrypt: bool = False,
|
||||
encryptKey=None,
|
||||
recur: bool = False,
|
||||
):
|
||||
"""
|
||||
Write record to disk
|
||||
|
||||
Parameters
|
||||
----------
|
||||
override
|
||||
Either false or a dictionary of values to set on the record
|
||||
|
||||
encrypt: bool
|
||||
Whether to encrypt the record (TODO)
|
||||
|
||||
encryptKey
|
||||
Key to encrypt record with, or None if not set
|
||||
|
||||
recur: bool
|
||||
Whether to recursively handle keys
|
||||
"""
|
||||
if override != False:
|
||||
for key in override.keys():
|
||||
# TODO: Deeper recursion
|
||||
if recur:
|
||||
if not key in self.msg.keys():
|
||||
self.msg[key] = {}
|
||||
for ikey in override[key].keys():
|
||||
self.msg[key][ikey] = override[key][ikey]
|
||||
else:
|
||||
self.msg[key] = override[key]
|
||||
data = msgpack.dumps(self.msg)
|
||||
with open(self.filepath, "wb") as f:
|
||||
f.write(data)
|
||||
|
||||
# Use for refreshing
|
||||
|
||||
def read(self, decrypt: bool = False, decryptKey=False):
|
||||
"""
|
||||
Read record from disk to memory
|
||||
|
||||
Parameters
|
||||
----------
|
||||
decrypt: bool
|
||||
Whether to decrypt record
|
||||
|
||||
decryptKey
|
||||
Key to decrypt record
|
||||
"""
|
||||
if os.path.isdir(self.filepath):
|
||||
self.msg = "directory"
|
||||
else:
|
||||
with open(self.filepath, "rb") as f:
|
||||
self.msg = msgpack.loads(f.read())
|
||||
|
||||
def get(self):
|
||||
"""
|
||||
Get record dictionary from memory
|
||||
|
||||
Returns
|
||||
-------
|
||||
self.msg: dict
|
||||
"""
|
||||
return self.msg
|
||||
|
||||
def sublist(self):
|
||||
"""
|
||||
Lists contents of directory if object is a directory, otherwise return None
|
||||
"""
|
||||
fpath = self.filepath
|
||||
if os.path.isdir(fpath):
|
||||
return ["messages/" + x for x in os.listdir(fpath)]
|
||||
else:
|
||||
return None
|
||||
|
||||
|
||||
def loadTemplates(templatePath: str = "templates"):
|
||||
"""Load templates for prefilling records
|
||||
|
||||
Parameters
|
||||
----------
|
||||
templatePath: str
|
||||
Path to templates
|
||||
"""
|
||||
templates = {}
|
||||
for p in os.listdir(templatePath):
|
||||
p = templatePath + "/" + p
|
||||
if os.path.isdir(p):
|
||||
for ip in os.listdir(p):
|
||||
ip = p + "/" + ip
|
||||
if os.path.isdir(ip):
|
||||
print("Too deep, skipping: " + ip)
|
||||
else:
|
||||
templates[ip] = Daisy(ip)
|
||||
else:
|
||||
templates[p] = Daisy(p)
|
||||
self.templates = templates
|
||||
return templates
|
||||
|
||||
|
||||
class CFSHandler(FileSystemEventHandler):
|
||||
"""
|
||||
File system watchdog that propagates disk changes to records to their proper cache
|
||||
"""
|
||||
|
||||
def __init__(self, cache, isCatch: bool = False):
|
||||
"""
|
||||
Parameters
|
||||
----------
|
||||
cache: Cache
|
||||
Daisy cache to update
|
||||
|
||||
isCatch: bool
|
||||
Is the cache for catchs
|
||||
"""
|
||||
self.cache = cache
|
||||
self.isCatch = isCatch
|
||||
super().__init__()
|
||||
|
||||
def on_any_event(self, event):
|
||||
"""
|
||||
Called when a CRUD operation is performed on a record file
|
||||
|
||||
Parameters
|
||||
----------
|
||||
event
|
||||
Event object provided by watchdog
|
||||
"""
|
||||
if not (".json" in event.src_path):
|
||||
if not (".md" in event.src_path):
|
||||
tpath = "/".join(event.src_path.split("/")[1:])
|
||||
if tpath != "":
|
||||
if self.isCatch:
|
||||
self.cache.sget(tpath)
|
||||
else:
|
||||
self.cache.get(tpath).get()
|
||||
|
||||
|
||||
# TODO: Dumping to cacheFile
|
||||
|
||||
|
||||
class Cache:
|
||||
"""
|
||||
In memory collection of Daisy records
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
filepaths=None,
|
||||
cacheFile=None,
|
||||
path: str = "daisy",
|
||||
walk: bool = False,
|
||||
isCatch: bool = False,
|
||||
):
|
||||
"""
|
||||
Parameters
|
||||
----------
|
||||
filepaths
|
||||
Either a list of filepaths to load or None
|
||||
|
||||
cacheFile
|
||||
Path to a cache file which is a collection of paths to load
|
||||
|
||||
path: str
|
||||
Path prefix to load records from
|
||||
|
||||
walk: bool
|
||||
Whether to automatically walk the path and load records
|
||||
|
||||
isCatch: bool
|
||||
Whether this cache is for catchs
|
||||
"""
|
||||
self.data = {}
|
||||
self.path = path
|
||||
self.event_handler = CFSHandler(self, isCatch=isCatch)
|
||||
self.observer = Observer()
|
||||
self.observer.schedule(self.event_handler, self.path, recursive=True)
|
||||
self.observer.start()
|
||||
# TODO: Test
|
||||
|
||||
if filepaths != None:
|
||||
for fp in filepaths:
|
||||
fp = path + "/" + fp
|
||||
if os.path.isfile(fp):
|
||||
self.data[fp] = Daisy(fp)
|
||||
elif cacheFile != None:
|
||||
with open(cacheFile, "r") as f:
|
||||
for fp in f.read().split("\n"):
|
||||
self.data[fp] = Daisy(fp)
|
||||
elif walk:
|
||||
for root, dirs, files in os.walk(self.path):
|
||||
for p in dirs + files:
|
||||
# print("walking")
|
||||
if not (".json" in p):
|
||||
if not (".md" in p):
|
||||
tpath = root + "/" + p
|
||||
# print(p)
|
||||
# print(tpath)
|
||||
self.data[tpath] = Daisy(tpath)
|
||||
|
||||
def create(self, path: str, data: dict):
|
||||
"""
|
||||
Create new record
|
||||
|
||||
Parameters
|
||||
----------
|
||||
path: str
|
||||
Path to create record at
|
||||
|
||||
data: dict
|
||||
Data to populate record with
|
||||
"""
|
||||
with open(self.path + "/" + path, "wb") as f:
|
||||
f.write(msgpack.dumps(data))
|
||||
logging.log(10, "Done creating record")
|
||||
self.data[path] = Daisy(self.path + "/" + path)
|
||||
logging.log(10, "Done loading to Daisy")
|
||||
return self.data[path]
|
||||
|
||||
def get(self, path: str):
|
||||
"""
|
||||
Get record at path, else return False
|
||||
|
||||
path: str
|
||||
Path of record
|
||||
"""
|
||||
if path in self.data.keys():
|
||||
return self.data[path]
|
||||
else:
|
||||
if os.path.exists(self.path + "/" + path):
|
||||
self.data[path] = Daisy(self.path + "/" + path)
|
||||
return self.data[path]
|
||||
else:
|
||||
logging.log(10, "File does not exist")
|
||||
return False
|
||||
|
||||
def refresh(self):
|
||||
"""
|
||||
Reload from disk to memory
|
||||
"""
|
||||
for key in self.data.keys():
|
||||
self.data[key].read()
|
||||
|
||||
def search(self, keydict: dict, strict: bool = True):
|
||||
"""
|
||||
Search cache for record for records with values
|
||||
|
||||
keydict: dict
|
||||
Values to search for
|
||||
|
||||
strict: bool
|
||||
Whether to require values match
|
||||
"""
|
||||
results = []
|
||||
for key, val in self.data.items():
|
||||
val = val.get()
|
||||
if strict and type(val) != str:
|
||||
addcheck = False
|
||||
for k, v in keydict.items():
|
||||
if k in val.keys():
|
||||
if v in val[k]:
|
||||
addcheck = True
|
||||
else:
|
||||
addcheck = False
|
||||
break
|
||||
if addcheck:
|
||||
results.append([key, val])
|
||||
elif type(val) != str:
|
||||
for k, v in keydict.items():
|
||||
if k in val.keys():
|
||||
if v in val[k]:
|
||||
results.append([key, val])
|
||||
return results
|
||||
|
||||
|
||||
class Catch(Cache):
|
||||
"""
|
||||
Sub class of Cache for handling catchs
|
||||
|
||||
.. image:: https://git.utopic.work/PierMesh/piermesh/raw/branch/main/imgs/catchdisplay.png
|
||||
"""
|
||||
|
||||
catches = {}
|
||||
|
||||
def __init__(
|
||||
self, path: str = "catch", filepaths=None, catchFile=None, walk: bool = False
|
||||
):
|
||||
"""
|
||||
Basically the same initialization parameters as Catch
|
||||
"""
|
||||
super().__init__(
|
||||
filepaths=filepaths, cacheFile=catchFile, path=path, walk=walk, isCatch=True
|
||||
)
|
||||
|
||||
# TODO: Fins
|
||||
|
||||
def sget(self, path: str):
|
||||
"""
|
||||
Call Cache's get to get record
|
||||
"""
|
||||
return super().get(path)
|
||||
|
||||
def get(self, head: str, tail: str, fins=None):
|
||||
"""
|
||||
Get catch by pieces
|
||||
|
||||
Parameters
|
||||
----------
|
||||
head: str
|
||||
First part of catch (maximum: 4 characters)
|
||||
|
||||
tail: str
|
||||
Second part of catch (maximum: 16 characters)
|
||||
|
||||
fins
|
||||
List of (maximum 8 characters) strings at the end of the catch oe None if none
|
||||
"""
|
||||
r = self.search({"head": head, "tail": tail})
|
||||
return r[0][1]["html"]
|
||||
|
||||
def addc(self, peer, node, seperator, head, tail, data, fins=None):
|
||||
tnpath = "catch/" + node
|
||||
if os.path.exists(tnpath) != True:
|
||||
os.makedirs(tnpath)
|
||||
tppath = tnpath + "/" + peer
|
||||
if os.path.exists(tppath) != True:
|
||||
os.makedirs(tppath)
|
||||
sid = str(random.randrange(0, 999999)).zfill(6)
|
||||
data["seperator"] = seperator
|
||||
data["head"] = head
|
||||
data["tail"] = tail
|
||||
if fins != None:
|
||||
data["fins"] = fins
|
||||
res = self.create("{0}/{1}/{2}".format(node, peer, sid), data)
|
||||
return [sid, res]
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
Schemaless binary database
|
||||
==========================
|
||||
|
||||
.. autoclass:: Components.daisy.Daisy
|
||||
:members:
|
||||
.. autoclass:: Components.daisy.Cache
|
||||
:members:
|
||||
.. autoclass:: Components.daisy.Catch
|
||||
:members:
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
import requests
|
||||
import msgpack
|
||||
import lzma
|
||||
from Packets.Packets import Packets
|
||||
|
||||
|
||||
def get(url: str, params=None):
|
||||
"""
|
||||
http/s get request
|
||||
|
||||
Parameters
|
||||
----------
|
||||
url: str
|
||||
|
||||
params
|
||||
Requests (library) parameters
|
||||
"""
|
||||
r = requests.get(url, params=params)
|
||||
r = {"response": r.text, "code": r.status_code}
|
||||
return Packets(lzma.compress(msgpack.dumps(r))).get()
|
||||
|
||||
|
||||
def post(url: str, params=None):
|
||||
"""
|
||||
http/s post request
|
||||
|
||||
Parameters
|
||||
----------
|
||||
url: str
|
||||
|
||||
params
|
||||
Requests (library) parameters
|
||||
"""
|
||||
r = requests.post(url, datan=params)
|
||||
r = {"response": r.text, "code": r.status_code}
|
||||
return Packets(lzma.compress(msgpack.dumps(r))).get()
|
||||
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
Small internet interop utilities
|
||||
================================
|
||||
|
||||
.. automodule:: Components.hopper
|
||||
:members:
|
||||
|
|
@ -0,0 +1,205 @@
|
|||
import base64, os
|
||||
from cryptography.fernet import Fernet
|
||||
from cryptography.hazmat.primitives import hashes
|
||||
from cryptography.hazmat.primitives.asymmetric import dh
|
||||
from cryptography.hazmat.primitives.kdf.hkdf import HKDF
|
||||
from cryptography.hazmat.primitives.serialization import (
|
||||
Encoding,
|
||||
NoEncryption,
|
||||
ParameterFormat,
|
||||
PublicFormat,
|
||||
PrivateFormat,
|
||||
)
|
||||
import cryptography.hazmat.primitives.serialization as Serialization
|
||||
import msgpack
|
||||
|
||||
# TODO: Different store directories per node
|
||||
|
||||
|
||||
class DHEFern:
|
||||
def __init__(self, cache, nodeNickname, cLog):
|
||||
self.cLog = cLog
|
||||
self.loadedParams = {}
|
||||
self.loadedKeys = {}
|
||||
self.nodeNickname = nodeNickname
|
||||
self.cache = cache
|
||||
if self.cache.get("cryptography/{0}/paramStore".format(nodeNickname)) == False:
|
||||
self.initStore("param")
|
||||
else:
|
||||
self.params = self.loadParamBytes(
|
||||
self.cache.get(
|
||||
"cryptography/{0}/paramStore".format(nodeNickname)
|
||||
).get()["self"]
|
||||
)
|
||||
if self.cache.get("cryptography/{0}/keyStore".format(nodeNickname)) == False:
|
||||
self.initStore("key")
|
||||
self.genKeyPair()
|
||||
else:
|
||||
tks = self.cache.get("cryptography/{0}/keyStore".format(nodeNickname)).get()
|
||||
self.publicKey = tks["self"]["publicKey"]
|
||||
self.privateKey = tks["self"]["privateKey"]
|
||||
|
||||
def checkInMem(self, store, nodeID):
|
||||
if store == "param":
|
||||
return nodeID in self.loadedParams.keys()
|
||||
elif store == "key":
|
||||
return nodeID in self.loadedKeys.keys()
|
||||
|
||||
def loadRecordToMem(self, store, nodeID):
|
||||
r = self.getRecord(store, nodeID)
|
||||
if r == False:
|
||||
self.cLog(
|
||||
30, "Tried to load nonexistent {0} for node {1}".format(store, nodeID)
|
||||
)
|
||||
return False
|
||||
elif self.checkInMem(store, nodeID):
|
||||
self.cLog(10, "{0}s already deserialized, skipping".format(store))
|
||||
else:
|
||||
if store == "param":
|
||||
self.loadedParams[nodeID] = self.loadParamBytes(r)
|
||||
elif store == "key":
|
||||
self.loadedKeys[nodeID] = {
|
||||
"publicKey": Serialization.load_pem_public_key(r["publicKey"]),
|
||||
"privateKey": Serialization.load_pem_private_key(
|
||||
r["privateKey"], None
|
||||
),
|
||||
}
|
||||
return True
|
||||
|
||||
# TODO: Store class daisy
|
||||
#
|
||||
def getRecord(self, store, key):
|
||||
r = self.cache.get(
|
||||
"cryptography/{0}/{1}Store".format(self.nodeNickname, store)
|
||||
).get()
|
||||
if r == False:
|
||||
self.cLog(20, "Record does not exist")
|
||||
return False
|
||||
else:
|
||||
if key in r.keys():
|
||||
return r[key]
|
||||
else:
|
||||
self.cLog(20, "Record does not exist")
|
||||
return False
|
||||
|
||||
def initStore(self, store):
|
||||
if not os.path.exists("daisy/cryptography/" + self.nodeNickname):
|
||||
os.mkdir("daisy/cryptography/" + self.nodeNickname)
|
||||
if store == "param":
|
||||
self.genParams()
|
||||
self.cache.create(
|
||||
"cryptography/{0}/paramStore".format(self.nodeNickname),
|
||||
{"self": self.getParamsBytes()},
|
||||
)
|
||||
elif store == "key":
|
||||
self.cache.create(
|
||||
"cryptography/{0}/keyStore".format(self.nodeNickname), {"self": {}}
|
||||
)
|
||||
else:
|
||||
self.cLog(30, "Store not defined")
|
||||
|
||||
def updateStore(self, store, entry, data, recur=True):
|
||||
self.cache.get(
|
||||
"cryptography/" + self.nodeNickname + "/" + store + "Store"
|
||||
).write(override={entry: data}, recur=recur)
|
||||
|
||||
def genParams(self):
|
||||
params = dh.generate_parameters(generator=2, key_size=2048)
|
||||
self.params = params
|
||||
return params
|
||||
|
||||
def genKeyPair(self, paramsOverride=False, setSelf=True):
|
||||
privateKey = self.params.generate_private_key()
|
||||
if setSelf:
|
||||
self.privateKey = privateKey
|
||||
publicKey = privateKey.public_key()
|
||||
if setSelf:
|
||||
self.publicKey = publicKey
|
||||
self.updateStore(
|
||||
"key",
|
||||
"self",
|
||||
{
|
||||
"publicKey": self.publicKey.public_bytes(
|
||||
Encoding.PEM, PublicFormat.SubjectPublicKeyInfo
|
||||
),
|
||||
"privateKey": self.privateKey.private_bytes(
|
||||
Encoding.PEM, PrivateFormat.PKCS8, NoEncryption()
|
||||
),
|
||||
},
|
||||
)
|
||||
return [privateKey, publicKey]
|
||||
else:
|
||||
publicKey = publicKey.public_bytes(
|
||||
Encoding.PEM, PublicFormat.SubjectPublicKeyInfo
|
||||
)
|
||||
privateKey = privateKey.private_bytes(
|
||||
Encoding.PEM, PrivateFormat.PKCS8, NoEncryption()
|
||||
)
|
||||
return [privateKey, publicKey]
|
||||
|
||||
def keyDerive(self, pubKey, salt, nodeID, params):
|
||||
if self.checkInMem("param", nodeID) == False:
|
||||
if self.getRecord("param", nodeID) == False:
|
||||
self.updateStore("param", nodeID, params, recur=False)
|
||||
self.loadRecordToMem("param", nodeID)
|
||||
self.cLog(20, "Precheck done for key derivation")
|
||||
|
||||
# TODO: Load them and if private key exists load it, otherwise generate a private key
|
||||
if self.checkInMem("key", nodeID) == False:
|
||||
if self.getRecord("key", nodeID) == False:
|
||||
privateKey, publicKey = self.genKeyPair(setSelf=False)
|
||||
self.updateStore(
|
||||
"key", nodeID, {"publicKey": publicKey, "privateKey": privateKey}
|
||||
)
|
||||
self.loadRecordToMem("key", nodeID)
|
||||
|
||||
sharedKey = self.loadedKeys[nodeID]["privateKey"].exchange(
|
||||
Serialization.load_pem_public_key(pubKey)
|
||||
)
|
||||
# Perform key derivation.
|
||||
self.cLog(20, "Performing key derivation")
|
||||
derivedKey = HKDF(
|
||||
algorithm=hashes.SHA256(), length=32, salt=salt, info=b"handshake data"
|
||||
).derive(sharedKey)
|
||||
self.cLog(20, "Derived key")
|
||||
ederivedKey = base64.urlsafe_b64encode(derivedKey)
|
||||
tr = self.getRecord("key", nodeID)
|
||||
tr["derivedKey"] = ederivedKey
|
||||
self.updateStore("key", nodeID, tr)
|
||||
self.cLog(20, "Done with cryptography store updates")
|
||||
return ederivedKey
|
||||
|
||||
def getSalt(self):
|
||||
return os.urandom(16)
|
||||
|
||||
def encrypt(self, data, nodeID, isDict=True):
|
||||
r = self.getRecord("key", nodeID)
|
||||
if r == False:
|
||||
self.cLog(20, "Node {0} not in keystore".format(nodeID))
|
||||
return False
|
||||
else:
|
||||
derivedKey = r["derivedKey"]
|
||||
fernet = Fernet(derivedKey)
|
||||
if isDict:
|
||||
data = msgpack.dumps(data)
|
||||
token = fernet.encrypt(data)
|
||||
return token
|
||||
|
||||
def decrypt(self, data, nodeID):
|
||||
r = self.getRecord("key", nodeID)
|
||||
if r == False:
|
||||
self.cLog(20, "No record of node " + nodeID)
|
||||
return False
|
||||
elif not "derivedKey" in r.keys():
|
||||
self.cLog(20, "No key derived for node " + nodeID)
|
||||
return False
|
||||
else:
|
||||
fernet = Fernet(self.getRecord("key", nodeID)["derivedKey"])
|
||||
return msgpack.loads(fernet.decrypt(data))
|
||||
|
||||
def getParamsBytes(self):
|
||||
return self.params.parameter_bytes(Encoding.PEM, ParameterFormat.PKCS3)
|
||||
|
||||
def loadParamBytes(self, pemBytes):
|
||||
self.params = Serialization.load_pem_parameters(pemBytes)
|
||||
return self.params
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
|
||||
Diffie hellman ephemeral
|
||||
Fernet based encryption
|
||||
==========================
|
||||
|
||||
.. autoclass:: Cryptography.DHEFern.DHEFern
|
||||
:members:
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
import DHEFern as d
|
||||
from cryptography.fernet import Fernet
|
||||
# Small enough to send in one packet
|
||||
parameters = d.getParams()
|
||||
myKey = d.getPrivateKey(parameters)
|
||||
yourKey = d.getPublicKey(parameters)
|
||||
salt = d.getSalt()
|
||||
derived_key = d.keyDerive(myKey, yourKey, salt)
|
||||
# Put this somewhere safe!
|
||||
#key = Fernet.generate_key()
|
||||
# TODO: how to use derived key
|
||||
#print(derived_key)
|
||||
f = Fernet(derived_key)
|
||||
token = f.encrypt(b"A really secret message. Not for prying eyes.")
|
||||
print(f.decrypt(token).decode("utf-8"))
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
async def filter(completeMessage, recipient, recipientNode, onodeID, todo):
|
||||
m = completeMessage
|
||||
if recipientNode == onodeID:
|
||||
todo.append(
|
||||
{
|
||||
"action": "sendToPeer",
|
||||
"data": {"res": m["data"]["data"], "recipient": recipient},
|
||||
}
|
||||
)
|
||||
else:
|
||||
# TODO: Forwarding message to next node
|
||||
# TODO: Method to get next node in path to recipient node
|
||||
# self.t.addPackets(m.data, sender, senderDisplay, recipient, recipientNode)
|
||||
pass
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
async def filter(completeMessage, recipient, recipientNode, todo):
|
||||
m = completeMessage
|
||||
# TODO: Sending to other nodes clients
|
||||
todo.append(
|
||||
{
|
||||
"action": "sendCatch",
|
||||
"data": {
|
||||
"toLocal": True,
|
||||
"recipientNode": recipientNode,
|
||||
"recipient": recipient,
|
||||
"head": m["head"],
|
||||
"body": m["body"],
|
||||
"fins": m["fins"],
|
||||
},
|
||||
}
|
||||
)
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
import logging
|
||||
|
||||
|
||||
async def filter(completeMessage, recipientNode, todo):
|
||||
todo.append(
|
||||
{
|
||||
"action": "keyDeriveDH",
|
||||
"data": {
|
||||
"publicKey": completeMessage["data"]["publicKey"],
|
||||
"params": completeMessage["data"]["params"],
|
||||
"recipientNode": recipientNode,
|
||||
},
|
||||
}
|
||||
)
|
||||
logging.log(10, "Adding cryptography request")
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
import logging
|
||||
|
||||
|
||||
async def filter(completeMessage, todo):
|
||||
m = completeMessage
|
||||
todo.append(
|
||||
{
|
||||
"action": "map",
|
||||
"data": {
|
||||
"onodeID": m["data"]["onodeID"],
|
||||
"mnodeID": m["data"]["mnodeID"],
|
||||
},
|
||||
}
|
||||
)
|
||||
todo.append(
|
||||
{
|
||||
"action": "initNodeDH",
|
||||
"data": {"mnodeID": m["data"]["mnodeID"], "onodeID": m["data"]["onodeID"]},
|
||||
}
|
||||
)
|
||||
|
|
@ -0,0 +1,121 @@
|
|||
from Components.daisy import Cache
|
||||
from Packets.Packets import Packets
|
||||
import msgpack, lzma
|
||||
from Packets.Packet import Packet
|
||||
from Packets.Packets import Packets
|
||||
import logging
|
||||
import Filters.Protocols.bubble
|
||||
import Filters.Protocols.map
|
||||
import Filters.Protocols.catch
|
||||
import Filters.Protocols.cryptography
|
||||
import asyncio
|
||||
import traceback
|
||||
|
||||
|
||||
# ✅ TODO: Cache integration for messages
|
||||
|
||||
|
||||
class Filter:
|
||||
def __init__(self, cache, onodeID, todo, cLog):
|
||||
self.cLog = cLog
|
||||
self.cache = cache
|
||||
# Note: Messages is temporary storage
|
||||
# for unfinished messages
|
||||
self.messages = {}
|
||||
self.completed = []
|
||||
self.todo = todo
|
||||
self.onodeID = onodeID
|
||||
|
||||
def mCheck(self, payload):
|
||||
try:
|
||||
msgpack.loads(payload)
|
||||
return True
|
||||
except Exception as e:
|
||||
self.cLog(20, "Not msgpack encoded, skipping")
|
||||
return False
|
||||
|
||||
def selfCheck(self, packet):
|
||||
if packet["fromId"] == packet["toId"]:
|
||||
self.cLog(20, "Self packet, ignored")
|
||||
return False
|
||||
else:
|
||||
return True
|
||||
|
||||
async def protoMap(self, protocolID):
|
||||
protocolID = str(protocolID).zfill(6)
|
||||
return self.cache.get("mlookup").get()[protocolID]
|
||||
|
||||
async def protoRoute(self, completeMessage):
|
||||
"""
|
||||
Shorthand reference
|
||||
"""
|
||||
m = completeMessage
|
||||
sender = m["sender"]
|
||||
senderDisplay = m["senderDisplayName"]
|
||||
recipient = m["recipient"]
|
||||
recipientNode = m["recipientNode"]
|
||||
# TODO: Fix packets to use class
|
||||
protocol = await self.protoMap(m["packetsClass"])
|
||||
self.cLog(20, "Protocol: " + protocol)
|
||||
if protocol == "bubble":
|
||||
await Filters.Protocols.bubble.filter(
|
||||
m, recipient, recipientNode, self.onodeID, self.todo
|
||||
)
|
||||
elif protocol == "map":
|
||||
await Filters.Protocols.map.filter(m, self.todo)
|
||||
elif protocol == "catch":
|
||||
await Filters.Protocols.catch.filter(m, recipient, recipientNode, self.todo)
|
||||
elif protocol == "cryptography":
|
||||
await Filters.Protocols.cryptography.filter(
|
||||
completeMessage, recipientNode, self.todo
|
||||
)
|
||||
else:
|
||||
self.cLog(30, "Cant route, no protocol")
|
||||
|
||||
async def sieve(self, packet):
|
||||
p = packet["decoded"]["payload"]
|
||||
if self.selfCheck(packet) and self.mCheck(p):
|
||||
try:
|
||||
p = msgpack.loads(p)
|
||||
self.cLog(20, p)
|
||||
packetsID = p["packetsID"]
|
||||
packetsClass = p["packetsClass"]
|
||||
if packetsID == 0:
|
||||
self.cLog(20, "Single packet")
|
||||
# Do sp handling
|
||||
pass
|
||||
if packetsID in self.completed:
|
||||
raise ValueError("Message already completed")
|
||||
if not (packetsID in self.messages):
|
||||
self.messages[packetsID] = {
|
||||
"packetCount": p["packetCount"],
|
||||
"data": [],
|
||||
"finished": False,
|
||||
"dataOrder": [],
|
||||
}
|
||||
if "wantFullResponse" in p.keys():
|
||||
for k in p.keys():
|
||||
if k != "data":
|
||||
self.messages[packetsID][k] = p[k]
|
||||
elif not p["packetNumber"] in self.messages[packetsID]["dataOrder"]:
|
||||
self.messages[packetsID]["data"].append(p["data"])
|
||||
self.messages[packetsID]["dataOrder"].append(p["packetNumber"])
|
||||
if (len(self.messages[packetsID]["data"])) >= (
|
||||
self.messages[packetsID]["packetCount"] - 1
|
||||
) and ("wantFullResponse" in self.messages[packetsID].keys()):
|
||||
self.cLog(20, "Finished receiving for message " + str(packetsID))
|
||||
self.messages[packetsID]["finished"] = True
|
||||
if self.messages[packetsID]["wantFullResponse"] != False:
|
||||
# TO DO: implement loop
|
||||
# responseLoop(packets_id)
|
||||
pass
|
||||
# TODO: Sorting
|
||||
completeMessage = self.messages[packetsID]
|
||||
completeMessage["data"] = Packets.reassemble(None, completeMessage)
|
||||
del self.messages[packetsID]
|
||||
self.completed.append(packetsID)
|
||||
self.cLog(20, "Assembly completed, routing")
|
||||
# self.cache.create("messages/" + str(packetsID), cm)
|
||||
await self.protoRoute(completeMessage)
|
||||
except Exception as e:
|
||||
self.cLog(30, traceback.print_exc())
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
Primary filtering functionality
|
||||
Dispatches to Protocols
|
||||
===============================
|
||||
|
||||
.. autoclass:: Filters.base.Filter
|
||||
:members:
|
||||
|
||||
.. autoclass:: Filters.Protocols.bubble.filter
|
||||
:members:
|
||||
|
||||
.. autoclass:: Filters.Protocols.catch.filter
|
||||
:members:
|
||||
|
||||
.. autoclass:: Filters.Protocols.cryptography.filter
|
||||
:members:
|
||||
|
||||
.. autoclass:: Filters.Protocols.map.filter
|
||||
:members:
|
||||
|
|
@ -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 = source
|
||||
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)
|
||||
|
|
@ -0,0 +1,53 @@
|
|||
from Packets.Packet import Packet
|
||||
import Components.daisy as d
|
||||
import msgpack
|
||||
|
||||
|
||||
class Header(Packet):
|
||||
def __init__(
|
||||
self,
|
||||
packetsID,
|
||||
packetCount,
|
||||
sender,
|
||||
senderDisplayName,
|
||||
recipient,
|
||||
recipientNode,
|
||||
json=True,
|
||||
fname=False,
|
||||
subpacket=False,
|
||||
wantFullResponse=False,
|
||||
mimeType=-1,
|
||||
protocol=None,
|
||||
packetsClass=0,
|
||||
):
|
||||
super().__init__(
|
||||
"", packetsID=packetsID, packetCount=packetCount, packetsClass=packetsClass
|
||||
)
|
||||
self.sender = sender
|
||||
self.senderDisplayName = senderDisplayName
|
||||
self.recipient = recipient
|
||||
self.recipientNode = recipientNode
|
||||
self.json = json
|
||||
self.fname = fname
|
||||
self.subpacket = subpacket
|
||||
self.wantFullResponse = wantFullResponse
|
||||
self.mimeType = mimeType
|
||||
|
||||
def usePreset(self, path):
|
||||
preset = d.Daisy(path)
|
||||
for key in preset.get().keys():
|
||||
self.msg[key] = preset.get()[key]
|
||||
|
||||
def dump(self):
|
||||
res = msgpack.loads(super().dump())
|
||||
res["sender"] = self.sender
|
||||
res["senderDisplayName"] = self.senderDisplayName
|
||||
res["recipient"] = self.recipient
|
||||
res["recipientNode"] = self.recipientNode
|
||||
# res["json"] = self.json
|
||||
# res["fname"] = self.fname
|
||||
res["subpacket"] = self.subpacket
|
||||
res["wantFullResponse"] = self.wantFullResponse
|
||||
res["mimeType"] = self.mimeType
|
||||
# res["protocol"] = self.protocol
|
||||
return msgpack.dumps(res)
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
Header packet: Metadata packet
|
||||
===============================
|
||||
|
||||
.. autoclass:: Packets.HeaderPacket.Header
|
||||
:members:
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
import lzma, sys
|
||||
from Components.daisy import Daisy
|
||||
import msgpack
|
||||
import logging
|
||||
|
||||
|
||||
class Packet:
|
||||
def parsePayload(data):
|
||||
msg = msgpack.loads(data)
|
||||
return [
|
||||
msg["packetsID"],
|
||||
msg["packetNumber"],
|
||||
lzma.decompress(msg["data"]),
|
||||
msg["packetsClass"],
|
||||
]
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
data,
|
||||
packetsID=False,
|
||||
packetNumber=False,
|
||||
packetCount=1,
|
||||
packetsClass=-1,
|
||||
):
|
||||
if packetsID == False:
|
||||
self.packetsID, self.packetNumber, self.data, self.packetsClass = (
|
||||
self.parsePayload(data)
|
||||
)
|
||||
else:
|
||||
self.packetsID = packetsID
|
||||
self.packetNumber = packetNumber
|
||||
self.data = data
|
||||
self.packetsClass = packetsClass
|
||||
if packetsClass != -1:
|
||||
pass
|
||||
"""template = Daisy("daisy/packet_templates/template.lookup").get()[
|
||||
str(packetsClass).zfill(2)
|
||||
]
|
||||
edata = Daisy("daisy/packet_templates/" + template)
|
||||
for key in edata.get().keys():
|
||||
self.data[key] = edata.get()[key]"""
|
||||
|
||||
def dump(self):
|
||||
res = {
|
||||
"packetsID": self.packetsID,
|
||||
"packetNumber": self.packetNumber,
|
||||
"data": self.data,
|
||||
"packetsClass": self.packetsClass,
|
||||
}
|
||||
if res["data"] == "":
|
||||
res.pop("data")
|
||||
ores = msgpack.dumps(res)
|
||||
logging.log(20, "Packet size: " + str(sys.getsizeof(ores)))
|
||||
return ores
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
Base packet
|
||||
===============================
|
||||
|
||||
.. autoclass:: Packets.Packet.Packet
|
||||
:members:
|
||||
|
|
@ -0,0 +1,91 @@
|
|||
import Packets.Packet as p
|
||||
import Packets.HeaderPacket as h
|
||||
import lzma
|
||||
import msgpack
|
||||
import random
|
||||
import sys
|
||||
import math
|
||||
|
||||
# Reassemble method
|
||||
|
||||
# Test
|
||||
# Polymorph to accept payload array, done
|
||||
# Create packet instance with payload
|
||||
# Add to and from node ids
|
||||
# Node id generation, random, checked against existing ids
|
||||
|
||||
# DO NOT CHANGE DATA SIZE UNLESS YOU KNOW WHAT YOURE DOING
|
||||
|
||||
|
||||
class Packets:
|
||||
def __init__(
|
||||
self,
|
||||
bytesObject,
|
||||
sender,
|
||||
senderDisplayName,
|
||||
recipient,
|
||||
recipientNode,
|
||||
dataSize=128,
|
||||
wantFullResponse=False,
|
||||
packetsClass=None,
|
||||
):
|
||||
if isinstance(bytesObject, list):
|
||||
# TODO: instantiating HeaderPacket correctly
|
||||
packets = [h.Header(bytesObject[0])]
|
||||
for packet in bytesObject:
|
||||
packets.append(
|
||||
p.Packet(
|
||||
packet["data"],
|
||||
packetsID=packet["packetsID"],
|
||||
packetNumber=packet["packetNumber"],
|
||||
packetsClass=packetsClass,
|
||||
)
|
||||
)
|
||||
self.packets = packets
|
||||
else:
|
||||
bytesObject = lzma.compress(bytesObject)
|
||||
packets = []
|
||||
self.packetsID = random.randrange(0, 999999)
|
||||
pnum = 1
|
||||
blen = math.ceil(len(bytesObject) / dataSize)
|
||||
tb = b""
|
||||
for it in range(blen):
|
||||
if it >= (blen - 1):
|
||||
b = bytesObject[it * dataSize :]
|
||||
else:
|
||||
b = bytesObject[it * dataSize : (it * dataSize + dataSize)]
|
||||
packets.append(
|
||||
p.Packet(b, self.packetsID, pnum, packetsClass=packetsClass)
|
||||
)
|
||||
pnum += 1
|
||||
tb += b
|
||||
packets.insert(
|
||||
0,
|
||||
h.Header(
|
||||
self.packetsID,
|
||||
pnum,
|
||||
sender,
|
||||
senderDisplayName,
|
||||
recipient,
|
||||
recipientNode,
|
||||
wantFullResponse=wantFullResponse,
|
||||
packetsClass=packetsClass,
|
||||
),
|
||||
)
|
||||
for it in range(pnum):
|
||||
packet = msgpack.loads(packets[it].dump())
|
||||
packet["packetCount"] = pnum
|
||||
|
||||
packets[it] = msgpack.dumps(packet)
|
||||
|
||||
self.packets = packets
|
||||
|
||||
def get(self):
|
||||
return self.packets
|
||||
|
||||
def reassemble(self, cm):
|
||||
data = b""
|
||||
for it in range(1, int(cm["packetCount"])):
|
||||
data += cm["data"][cm["dataOrder"].index(it)]
|
||||
res = msgpack.loads(lzma.decompress(data))
|
||||
return res
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
Packets representation for full
|
||||
message
|
||||
===============================
|
||||
|
||||
.. autoclass:: Packets.Packets.Packets
|
||||
:members:
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
from .Packet import Packet
|
||||
import msgpack, lzma
|
||||
|
||||
# TODO: Instantiation
|
||||
# TODO: Packet template loading
|
||||
|
||||
|
||||
class SinglePacket(Packet):
|
||||
def __init__(self, data, packetsID, packetsClass=None, cache=None):
|
||||
super().__init__(
|
||||
lzma.compress(msgpack.dumps(data)),
|
||||
packetsID=packetsID,
|
||||
packetNumber=0,
|
||||
packetsClass=packetsClass,
|
||||
)
|
||||
self.packetCount = 1
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
SinglePacket: Singular packet
|
||||
for very low data applications
|
||||
===============================
|
||||
|
||||
.. autoclass:: Packets.SinglePacket.SinglePacket
|
||||
:members:
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
SubPacket for handling
|
||||
individual packets of submessages
|
||||
=================================
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
SubPackets for handling
|
||||
full submessages
|
||||
=======================
|
||||
|
|
@ -0,0 +1,223 @@
|
|||
from sys import getsizeof
|
||||
import meshtastic
|
||||
import meshtastic.serial_interface
|
||||
from pubsub import pub
|
||||
from Packets.Packets import Packets as Packets
|
||||
from Packets.SinglePacket import SinglePacket
|
||||
import time
|
||||
from threading import Thread
|
||||
from Components.daisy import Catch, Cache
|
||||
import sys
|
||||
import logging
|
||||
|
||||
# from Filters.base import Filter
|
||||
import msgpack
|
||||
|
||||
import asyncio
|
||||
import random
|
||||
|
||||
|
||||
class Transmitter:
|
||||
def __init__(self, device, filter, onodeID, cache, catch, cryptographyInfo, cLog):
|
||||
self.cLog = cLog
|
||||
self.cryptographyInfo = cryptographyInfo
|
||||
self.filter = filter
|
||||
self.tcache = cache
|
||||
self.tcatch = catch
|
||||
self.html = False
|
||||
self.notConnected = True
|
||||
self.messages = {}
|
||||
self.acks = {}
|
||||
# self.threads = {}
|
||||
self.onodeID = onodeID
|
||||
# Be careful with this
|
||||
self.cpid = 0
|
||||
self.tasks = {}
|
||||
# TODO: use node id to deliver directly
|
||||
pub.subscribe(self.onReceive, "meshtastic.receive")
|
||||
pub.subscribe(self.onConnection, "meshtastic.connection.established")
|
||||
self.interface = meshtastic.serial_interface.SerialInterface(device)
|
||||
i = 0
|
||||
while self.notConnected:
|
||||
if i % 5000000 == 0:
|
||||
self.cLog(20, "Waiting for node initialization...")
|
||||
i += 1
|
||||
self.cLog(20, "Initialized")
|
||||
|
||||
# TODO: Sending packets across multiple nodes/load balancing/distributed packet transmission/reception
|
||||
def onReceive(self, packet, interface):
|
||||
asyncio.new_event_loop().run_until_complete(self.filter.sieve(packet))
|
||||
self.tcache.refresh()
|
||||
|
||||
async def sendAnnounce(self):
|
||||
await self.addPackets(
|
||||
msgpack.dumps(
|
||||
{
|
||||
"onodeID": self.onodeID,
|
||||
"mnodeID": self.interface.localNode.nodeNum,
|
||||
}
|
||||
),
|
||||
self.onodeID,
|
||||
None,
|
||||
True,
|
||||
None,
|
||||
packetsClass=0,
|
||||
)
|
||||
|
||||
def onConnection(self, interface, topic=pub.AUTO_TOPIC):
|
||||
# self.send("connect".encode("utf-8"))
|
||||
# time.sleep(3)
|
||||
asyncio.run(self.sendAnnounce())
|
||||
self.notConnected = False
|
||||
|
||||
def responseCheck(self, packet):
|
||||
rid = packet["decoded"]["requestId"]
|
||||
if packet["decoded"]["routing"]["errorReason"] == "MAX_RETRANSMIT":
|
||||
self.cLog(20, "Got ack error")
|
||||
self.acks[str(rid)] = False
|
||||
else:
|
||||
self.acks[str(rid)] = True
|
||||
|
||||
# TODO: Threaded send method
|
||||
|
||||
def send(self, packet, recipientNode=False):
|
||||
interface = self.interface
|
||||
if recipientNode == False:
|
||||
pid = interface.sendData(
|
||||
packet, wantAck=True, onResponse=self.responseCheck
|
||||
)
|
||||
else:
|
||||
pid = interface.sendData(
|
||||
packet,
|
||||
destinationId=recipientNode,
|
||||
wantAck=True,
|
||||
onResponse=self.responseCheck,
|
||||
)
|
||||
|
||||
# Can I use waitForAckNak on cpid?
|
||||
self.cpid = pid.id
|
||||
return True
|
||||
|
||||
async def awaitResponse(self, pid):
|
||||
for i in range(120):
|
||||
await asyncio.sleep(1)
|
||||
if str(pid) in self.acks:
|
||||
break
|
||||
return True
|
||||
|
||||
async def initNodeDH(self, dhefOb, recipientNode, onodeID):
|
||||
await self.addPackets(
|
||||
msgpack.dumps(
|
||||
{"params": dhefOb.getParamsBytes(), "publicKey": dhefOb.publicKey}
|
||||
),
|
||||
self.onodeID,
|
||||
000000,
|
||||
000000,
|
||||
onodeID,
|
||||
directID=recipientNode,
|
||||
packetsClass=3,
|
||||
)
|
||||
|
||||
def awaitFullResponse(self, pid):
|
||||
for i in range(1_000_000_000):
|
||||
time.sleep(5)
|
||||
if pid in self.messages.keys():
|
||||
if self.messages[pid]["finished"]:
|
||||
break
|
||||
return True
|
||||
|
||||
async def addPackets(
|
||||
self,
|
||||
data,
|
||||
sender,
|
||||
senderName,
|
||||
recipient,
|
||||
recipientNode,
|
||||
directID=False,
|
||||
packetsClass=None,
|
||||
encrypt=False,
|
||||
):
|
||||
interface = self.interface
|
||||
tp = Packets(
|
||||
data,
|
||||
sender,
|
||||
senderName,
|
||||
recipient,
|
||||
recipientNode,
|
||||
packetsClass=packetsClass,
|
||||
)
|
||||
# print(sys.getsizeof(tp.packets[0]))
|
||||
# print(tp.packets[0])
|
||||
for p in tp.packets:
|
||||
# time.sleep(5)
|
||||
if recipientNode == None:
|
||||
# print("sending none")
|
||||
# print(p)
|
||||
self.send(p)
|
||||
else:
|
||||
# print(p)
|
||||
# print(recipientNode)
|
||||
self.cLog(10, "Sending target: " + str(directID))
|
||||
if directID != False:
|
||||
recipientNode = directID
|
||||
self.send(p, recipientNode=recipientNode)
|
||||
awaitTask = asyncio.create_task(self.awaitResponse(self.cpid))
|
||||
await asyncio.sleep(1)
|
||||
currentTask = {
|
||||
"ob": awaitTask,
|
||||
"pid": str(self.cpid),
|
||||
"packet": p,
|
||||
"retry": False,
|
||||
}
|
||||
self.tasks[str(self.cpid)] = currentTask
|
||||
|
||||
async def progressCheck(self):
|
||||
# interface = self.interface
|
||||
while True:
|
||||
await asyncio.sleep(90)
|
||||
self.cLog(
|
||||
20, "Checking progress of {0} tasks".format(len(self.tasks.keys()))
|
||||
)
|
||||
doneFlag = True
|
||||
dcTasks = [k for k in self.tasks.keys()]
|
||||
for task in dcTasks:
|
||||
task = self.tasks[task]
|
||||
if task["ob"]:
|
||||
if task["pid"] in self.acks:
|
||||
if not self.acks[task["pid"]]:
|
||||
retry = task["retry"]
|
||||
remove = False
|
||||
if retry == False:
|
||||
retry = 1
|
||||
elif retry < 3:
|
||||
retry += 1
|
||||
else:
|
||||
self.cLog(30, "Too many retries")
|
||||
remove = True
|
||||
if remove:
|
||||
del self.tasks[task["pid"]]
|
||||
else:
|
||||
self.cLog(20, "Doing retry")
|
||||
doneFlag = False
|
||||
# TODO: Resend to specific node
|
||||
self.send(task["packet"])
|
||||
await_thread = asyncio.create_task(
|
||||
self.awaitResponse(task["pid"])
|
||||
)
|
||||
|
||||
await asyncio.sleep(1)
|
||||
currentTask = {
|
||||
"ob": await_thread,
|
||||
"pid": str(self.cpid),
|
||||
"packet": task["packet"],
|
||||
}
|
||||
currentTask["retry"] = retry
|
||||
self.tasks[task["pid"]] = currentTask
|
||||
else:
|
||||
del self.tasks[task["pid"]]
|
||||
|
||||
async def announce(self):
|
||||
while True:
|
||||
self.cLog(10, "Announce")
|
||||
await self.sendAnnounce()
|
||||
await asyncio.sleep(180)
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
Layer 0 data transmission
|
||||
===============================
|
||||
|
||||
.. autoclass:: Transmission.transmission.Transmitter
|
||||
:members:
|
||||
|
|
@ -0,0 +1 @@
|
|||
sphinx-build -M markdown source docs
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
import os
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, os.path.abspath("../src"))
|
||||
|
||||
# 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 = "PierMesh"
|
||||
copyright = "2024, Agie Ashwood"
|
||||
author = "Agie Ashwood"
|
||||
release = "Proto"
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
||||
extensions = ["sphinx_markdown_builder", "sphinx.ext.autodoc", "sphinx.ext.napoleon"]
|
||||
|
||||
templates_path = ["_templates"]
|
||||
exclude_patterns = []
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||||
|
||||
html_theme = "alabaster"
|
||||
html_static_path = ["_static"]
|
||||
|
||||
|
||||
# Added markdown configuration
|
||||
|
||||
markdown_http_base = "/PierMesh/piermesh/src/branch/main/docs"
|
||||
Binary file not shown.
Binary file not shown.
|
|
@ -0,0 +1,10 @@
|
|||
<!-- PierMesh documentation master file, created by
|
||||
sphinx-quickstart on Fri Jul 26 23:30:55 2024.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive. -->
|
||||
|
||||
# PierMesh documentation
|
||||
|
||||
Add your content using `reStructuredText` syntax. See the
|
||||
[reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html)
|
||||
documentation for details.
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
.. PierMesh documentation master file, created by
|
||||
sphinx-quickstart on Fri Jul 26 23:30:55 2024.
|
||||
|
||||
PierMesh documentation
|
||||
======================
|
||||
|
||||
.. toctree::
|
||||
:caption: Contents:
|
||||
:glob:
|
||||
|
||||
run
|
||||
../ui
|
||||
../Bubble/*
|
||||
../Components/*
|
||||
../Cryptography/*
|
||||
../Filters/*
|
||||
../Packets/*
|
||||
../Transmission/*
|
||||
../webui/*
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=source
|
||||
set BUILDDIR=build
|
||||
|
||||
%SPHINXBUILD% >NUL 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
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
import src.Components.daisy as d
|
||||
import sys
|
||||
|
||||
d._json_to_msg(sys.argv[1])
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
▄▄▄▄▄▄▄▄
|
||||
▄▄▄▄▄▄▄▄
|
||||
▄ ▄▄▄▄▄▄▄▄▄▄▄▄▄▄ ▄
|
||||
█ █ █ █
|
||||
█ █ PIERMESH █ █
|
||||
█ █ █ █
|
||||
▀ ▀▀▀▀▀▀▀▀▀▀▀▀▀▀ ▀
|
||||
▀▀▀▀▀▀▀▀
|
||||
▀▀▀▀▀▀▀▀
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
▄▄▄▄▄▄▄▄▄▄▄▄▄▄
|
||||
▀▀▀▀▀▀▀▀▀▀▀▀▀▀
|
||||
▄▄▄▄▄▄▄▄▄▄▄▄▄▄
|
||||
▀▀▀▀▀▀▀▀▀▀▀▀▀▀
|
||||
|
||||
██ ██ ██████████████ ██ ██
|
||||
██ ██ ██ ██ ██ ██ ██ ██
|
||||
██ ██ ██████████████ ██ ██
|
||||
██ ██ ██ ██ ██ ██ ██ ██
|
||||
██ ██ ██████████████ ██ ██
|
||||
██ ██ ██ ██ ██ ██ ██ ██
|
||||
██ ██ ██████████████ ██ ██
|
||||
|
||||
▄▄▄▄▄▄▄▄▄▄▄▄▄▄
|
||||
▀▀▀▀▀▀▀▀▀▀▀▀▀▀
|
||||
▄▄▄▄▄▄▄▄▄▄▄▄▄▄
|
||||
▀▀▀▀▀▀▀▀▀▀▀▀▀▀
|
||||
▄▄▄▄▄▄▄▄▄▄▄▄
|
||||
▌ PIERMESH ▐
|
||||
▀▀▀▀▀▀▀▀▀▀▀▀
|
||||
|
||||
|
|
@ -0,0 +1,280 @@
|
|||
from meshtastic import logging, os
|
||||
from Filters.base import Filter
|
||||
from Bubble.router import Router
|
||||
from webui.serve import Server
|
||||
from Transmission.transmission import Transmitter
|
||||
import asyncio
|
||||
import sys
|
||||
import time
|
||||
import psutil
|
||||
import logging
|
||||
import datetime
|
||||
from Cryptography.DHEFern import DHEFern
|
||||
from microdot import Request
|
||||
import traceback
|
||||
from ui import TUI
|
||||
import threading, os
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
# Global objects for the PierMesh service and the TUI so we can terminate the associated processes later
|
||||
global nodeOb, tuiOb
|
||||
tuiOb = None
|
||||
nodeOb = None
|
||||
|
||||
# Enable 500 kB files in the webui
|
||||
Request.max_content_length = 1024 * 1024 * 0.5
|
||||
Request.max_body_length = 1024 * 1024 * 0.5
|
||||
|
||||
# Pull startup parameters
|
||||
device, webPort, serverInfoFile, delay, nodeNickname = sys.argv[1:]
|
||||
|
||||
# Set up file based logging
|
||||
logPath = "logs"
|
||||
fileName = datetime.datetime.now().strftime("%m%d%Y_%H%M%S")
|
||||
logFormat = "%(asctime)s [%(threadName)-12.12s] [%(levelname)-5.5s] %(message)s"
|
||||
logging.basicConfig(
|
||||
format=logFormat,
|
||||
level=logging.INFO,
|
||||
filename="{0}/{2}_{1}.log".format(logPath, fileName, nodeNickname),
|
||||
)
|
||||
|
||||
|
||||
class Node:
|
||||
"""
|
||||
Class that handles most of the PierMesh data
|
||||
|
||||
`🔗 Source <https://git.utopic.work/PierMesh/piermesh/src/branch/main/src/run.py>`_
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
self.toLog = []
|
||||
"""
|
||||
We store logs to be processed here
|
||||
|
||||
See Also
|
||||
--------
|
||||
logPassLoop: Loop to handle logging to file and TUI
|
||||
"""
|
||||
actionsList = [f for f in dir(self) if "action" in f]
|
||||
self.actions = {}
|
||||
for a in actionsList:
|
||||
self.actions[a.split("_")[1]] = getattr(self, a)
|
||||
self.cLog(20, "Past action mapping")
|
||||
self.r = Router(self.cLog, nfpath=serverInfoFile)
|
||||
self.cLog(20, "Router initialized")
|
||||
self.onodeID = str(self.r.serverInfo.get()["nodeID"])
|
||||
self.catch = self.r.c
|
||||
self.cache = self.r.cache
|
||||
self.s = None
|
||||
self.todo = []
|
||||
self.f = Filter(self.cache, self.onodeID, self.todo, self.cLog)
|
||||
self.cLog(20, "Filter initialized")
|
||||
# self.cLog(30, sys.argv)
|
||||
self.t = None
|
||||
self.cLog(20, "Cryptography initializing")
|
||||
self.cryptographyInfo = DHEFern(self.cache, nodeNickname, self.cLog)
|
||||
self.cLog(20, "Cryptography initialized")
|
||||
self.processed = []
|
||||
self.proc = psutil.Process(os.getpid())
|
||||
self.mTasks = {}
|
||||
|
||||
def cLog(self, priority: int, message: str):
|
||||
"""
|
||||
Convenience function that logs to the ui and log files
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
||||
priority: int
|
||||
Priority of message to be passed to logging
|
||||
|
||||
message: str
|
||||
Message to log
|
||||
|
||||
Returns
|
||||
-------
|
||||
None
|
||||
"""
|
||||
logging.log(priority, message)
|
||||
self.toLog.append("[{0}]:\n{1}".format(datetime.datetime.now(), message))
|
||||
|
||||
async def monitor(self):
|
||||
"""
|
||||
Monitor and log ram and cpu usage
|
||||
"""
|
||||
while True:
|
||||
if tuiOb != None:
|
||||
if tuiOb.done:
|
||||
print("Terminating PierMesh service...")
|
||||
self.proc.terminate()
|
||||
await asyncio.sleep(10)
|
||||
memmb = self.proc.memory_info().rss / (1024 * 1024)
|
||||
memmb = round(memmb, 2)
|
||||
cpup = self.proc.cpu_percent(interval=1)
|
||||
self.cLog(
|
||||
20,
|
||||
" MEM: {0} mB | CPU: {1} %".format(
|
||||
memmb,
|
||||
cpup,
|
||||
),
|
||||
)
|
||||
# Set cpu and memory usage in the TUI
|
||||
tuiOb.do_set_cpu_percent(float(cpup))
|
||||
tuiOb.do_set_mem(memmb)
|
||||
|
||||
async def fListen(self):
|
||||
"""
|
||||
Loop to watch for tasks to do
|
||||
|
||||
See Also
|
||||
--------
|
||||
Filters.base.sieve: Packet filtering/parsing
|
||||
|
||||
Notes
|
||||
-----
|
||||
We use a common technique here that calls the function from our preloaded actions via dictionary entry
|
||||
"""
|
||||
while True:
|
||||
while len(self.todo) >= 1:
|
||||
todoNow = self.todo.pop()
|
||||
action = todoNow["action"]
|
||||
self.cLog(20, "Action: " + action)
|
||||
data = todoNow["data"]
|
||||
await self.actions[action](data)
|
||||
await asyncio.sleep(1)
|
||||
|
||||
async def action_sendToPeer(self, data: dict):
|
||||
"""
|
||||
Send data to a peer connected to the server
|
||||
|
||||
Parameters
|
||||
----------
|
||||
data: dict
|
||||
Data passed from the filter, this is a generic object so it's similar on all actions here
|
||||
|
||||
See Also
|
||||
--------
|
||||
Filters.Protocols: Protocol based packet filtering
|
||||
|
||||
webui.serve.Server: Runs a light Microdot web server with http/s and websocket functionality
|
||||
|
||||
webui.serve.Server.sendToPeer: Function to actually execute the action
|
||||
"""
|
||||
self.s.sendToPeer(data["recipient"], data["res"])
|
||||
|
||||
async def action_sendCatch(self, data: dict):
|
||||
"""
|
||||
Get catch and return the data to a peer
|
||||
|
||||
See Also
|
||||
--------
|
||||
Bubble.router.Router: Routing class
|
||||
"""
|
||||
res = self.r.getCatch(data["head"], data["body"], fins=data["fins"])
|
||||
self.s.sendToPeer(data["recipient"], res)
|
||||
|
||||
async def action_map(self, data: dict):
|
||||
"""
|
||||
Map new network data to internal network map
|
||||
|
||||
See Also
|
||||
--------
|
||||
Bubble.network.Network: Layered graph etwork representation
|
||||
"""
|
||||
self.r.n.addLookup(data["onodeID"], data["mnodeID"])
|
||||
self.cLog(20, "Lookup addition done")
|
||||
self.r.n.addon(data["onodeID"])
|
||||
|
||||
async def action_initNodeDH(self, data: dict):
|
||||
"""
|
||||
Initialize diffie hellman key exchange
|
||||
|
||||
See Also
|
||||
--------
|
||||
Cryptography.DHEFern.DHEFern: End to end encryption functionality
|
||||
"""
|
||||
if self.cryptographyInfo.getRecord("key", data["onodeID"]) == False:
|
||||
await self.t.initNodeDH(
|
||||
self.cryptographyInfo, int(data["mnodeID"]), data["onodeID"]
|
||||
)
|
||||
|
||||
async def action_keyDeriveDH(self, data: dict):
|
||||
"""
|
||||
Derive key via diffie hellman key exchange
|
||||
"""
|
||||
try:
|
||||
self.cryptographyInfo.keyDerive(
|
||||
data["publicKey"],
|
||||
self.cryptographyInfo.getSalt(),
|
||||
data["recipientNode"],
|
||||
data["params"],
|
||||
)
|
||||
except:
|
||||
self.cLog(30, traceback.format_exc())
|
||||
|
||||
|
||||
async def logPassLoop():
|
||||
"""
|
||||
Loop to pass logs up to the TUI
|
||||
|
||||
See Also
|
||||
--------
|
||||
tui.TUI: TUI implementation
|
||||
"""
|
||||
global tuiOb, nodeOb
|
||||
while True:
|
||||
await asyncio.sleep(1)
|
||||
if tuiOb == None or nodeOb == None:
|
||||
await asyncio.sleep(1)
|
||||
elif tuiOb.done == True:
|
||||
print("Terminating PierMesh service...")
|
||||
nodeOb.proc.terminate()
|
||||
else:
|
||||
ctoLog = [l for l in nodeOb.toLog]
|
||||
for l in ctoLog:
|
||||
tuiOb.do_write_line(l)
|
||||
nodeOb.toLog.pop()
|
||||
|
||||
|
||||
async def main():
|
||||
"""
|
||||
Main method for running the PierMesh service
|
||||
"""
|
||||
global nodeOb
|
||||
try:
|
||||
n = Node()
|
||||
nodeOb = n
|
||||
nodeOb.cLog(20, "Starting up")
|
||||
nodeOb.cLog(20, "Staggering {0} seconds, please wait".format(sys.argv[4]))
|
||||
time.sleep(int(sys.argv[4]))
|
||||
n.t = Transmitter(
|
||||
sys.argv[1], n.f, n.onodeID, n.cache, n.catch, n.cryptographyInfo, n.cLog
|
||||
)
|
||||
n.s = Server(n.t, n.catch, n.onodeID, n.r.n, n.cLog)
|
||||
n.mTasks["list"] = asyncio.create_task(n.fListen())
|
||||
await asyncio.sleep(1)
|
||||
n.mTasks["pct"] = asyncio.create_task(n.t.progressCheck())
|
||||
await asyncio.sleep(1)
|
||||
n.mTasks["mon"] = asyncio.create_task(n.monitor())
|
||||
await asyncio.sleep(1)
|
||||
n.mTasks["announce"] = asyncio.create_task(n.t.announce())
|
||||
await asyncio.sleep(1)
|
||||
await n.s.app.start_server(port=int(sys.argv[2]), debug=True)
|
||||
except KeyboardInterrupt:
|
||||
sys.exit()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
try:
|
||||
t = threading.Thread(target=asyncio.run, args=(main(),))
|
||||
t.start()
|
||||
lplt = threading.Thread(target=asyncio.run, args=(logPassLoop(),))
|
||||
lplt.start()
|
||||
tuiOb = TUI()
|
||||
tuiOb.nodeOb = nodeOb
|
||||
tuiOb.run()
|
||||
except KeyboardInterrupt:
|
||||
nodeOb.cLog(30, "Terminating PierMesh service...")
|
||||
except Exception:
|
||||
nodeOb.cLog(30, sys.gettrace())
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
PierMesh service runner
|
||||
=======================
|
||||
|
||||
.. automodule:: run.main
|
||||
.. autoclass:: run.Node
|
||||
:members:
|
||||
|
|
@ -0,0 +1 @@
|
|||
python run.py /dev/ttyACM1 5000 server2.info 0 falin
|
||||
|
|
@ -0,0 +1 @@
|
|||
./tmp/pypy3.10-v7.3.16-linux64/bin/pypy3.10 run.py /dev/ttyACM1 5000 server2.info 0 falin
|
||||
|
|
@ -0,0 +1 @@
|
|||
python run.py /dev/ttyACM0 5001 server1.info 30 marcille
|
||||
|
|
@ -0,0 +1 @@
|
|||
python -m meshtastic --set lora.region US --port /dev/ttyACM0
|
||||
|
|
@ -0,0 +1,66 @@
|
|||
import base64, uuid, json, sys, lzma, bson, random, msgpack
|
||||
from Packets import Packet, HeaderPacket
|
||||
|
||||
def compressPackets(packets):
|
||||
cpackets = []
|
||||
for packet in packets:
|
||||
cpacket = lzma.compress(packet)
|
||||
cpackets.append(cpacket)
|
||||
return cpackets
|
||||
|
||||
def decompressPackets(packets):
|
||||
cpackets = []
|
||||
for packet in packets:
|
||||
cpacket = lzma.decompress(packet)
|
||||
cpackets.append(cpacket)
|
||||
return cpackets
|
||||
|
||||
# TODO: Sub packets
|
||||
# Sub packets are indicated by a flag in the header
|
||||
# TODO: Sub packets implementation
|
||||
# TODO: Sub packet recursion, collapse
|
||||
# TODO: Determine sub packet per subpackets allowed for header packet size, done, 5, but user ids and subpackets ids must be 6 digit integers
|
||||
# Remove duplicate references to objects
|
||||
# Local db that stores users to lookup for less metadata, daisy
|
||||
# IDS MUST BE 6 DIGITS
|
||||
# location prefix added by node
|
||||
# Check if packet is header by checking if it has sender_id
|
||||
|
||||
# DO NOT CHANGE DATA SIZE UNLESS YOU KNOW WHAT YOURE DOING
|
||||
|
||||
# Moved to Packets/Packets
|
||||
|
||||
def reassemblePackets(packets):
|
||||
#print(packets)
|
||||
packet_count = msgpack.loads(packets[0])["packet_count"]
|
||||
#print("Packet count")
|
||||
#print(packet_count)
|
||||
positions = []
|
||||
for packet in packets:
|
||||
p = msgpack.loads(packet)
|
||||
num = 0
|
||||
if "packet_number" in p:
|
||||
num = p["packet_number"]
|
||||
#print(p)
|
||||
positions.append(num)
|
||||
tpackets = []
|
||||
for it in range(0, len(positions)):
|
||||
tpackets.append(packets[positions.index(it)])
|
||||
packets = tpackets
|
||||
res = b""
|
||||
#print("Reassembling")
|
||||
#print(len(packets))
|
||||
for it in range(len(packets)):
|
||||
if it > 0:
|
||||
#print(it)
|
||||
#print(res)
|
||||
#print(bson.loads(packets[it]).keys())
|
||||
res = res + lzma.decompress(msgpack.loads(packets[it])["data"])
|
||||
#print(len(res))
|
||||
#print(bson.loads(res))
|
||||
#print(res)
|
||||
#print(bson.loads(res))
|
||||
return msgpack.loads(res)
|
||||
|
||||
def raiseSizeError(index):
|
||||
raise ValueError("Field of index: " + str(index) + " too big, maximum is 200 bytes")
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
import socketio
|
||||
from threading import Thread
|
||||
import transmission as t
|
||||
import microplane as m
|
||||
import bson
|
||||
|
||||
@sio.event
|
||||
def send(sid, data):
|
||||
packets = bson.dumps(data)
|
||||
packets = m.getPackets(packets)
|
||||
# TODO: Implement awaitFullResponse
|
||||
threads = []
|
||||
threads.append(Thread(target=t.awaitFullResponse, args=[pid])
|
||||
for p in packets:
|
||||
t.send(interface, p)
|
||||
#awaitResponse(cpid)
|
||||
pid = t.cpid threads.append(Thread(target=t.awaitResponse, args=[pid])
|
||||
threads[-1].start()
|
||||
time.sleep(1)
|
||||
done = True
|
||||
while True:
|
||||
for th in threads:
|
||||
if thread.is_alive():
|
||||
done = False
|
||||
if done:
|
||||
break
|
||||
sio.emit('done', {'data': t.messages[packets[0]["packets_id"]]["fresponse"]}, room=sid)
|
||||
|
||||
mgr = socketio.RedisManager('redis://')
|
||||
sio = socketio.Server(client_manager=mgr)
|
||||
|
|
@ -0,0 +1,193 @@
|
|||
import meshtastic
|
||||
import meshtastic.serial_interface
|
||||
from pubsub import pub
|
||||
import bson
|
||||
import microplane as m
|
||||
import sys
|
||||
import time
|
||||
import asyncio
|
||||
import functools
|
||||
from util import sendData
|
||||
from threading import Thread
|
||||
import webview
|
||||
from Daisy import Catch, Cache
|
||||
from Filters import Base
|
||||
|
||||
tcache = Cache()
|
||||
tcatch = Catch()
|
||||
|
||||
html = False
|
||||
notConnected = True
|
||||
messages = {}
|
||||
acks = {}
|
||||
# Be careful with this
|
||||
cpid = 0
|
||||
# TODO: Filter out non data packets/log them, DONE
|
||||
# TODO: Figure out why the message count is resetting, DONE, the while loop was...looping
|
||||
# TODO: Sending packets across multiple nodes/load balancing/distributed packet transmission/reception
|
||||
def onReceive(packet, interface):
|
||||
Base.sieve(packet)
|
||||
tcache.refresh()
|
||||
|
||||
def onConnection(interface, topic=pub.AUTO_TOPIC): # called when we (re)connect to the radio
|
||||
# defaults to broadcast, specify a destination ID if you wish
|
||||
interface.sendData("connect".encode("utf-8"))
|
||||
global notConnected
|
||||
notConnected = False
|
||||
def responseCheck(packet):
|
||||
#print("got response")
|
||||
#print("Checking")
|
||||
#print(packet["decoded"])
|
||||
rid = packet["decoded"]["requestId"]
|
||||
print(rid)
|
||||
# TODO: Set to false on error
|
||||
print(packet["decoded"])
|
||||
if (packet["decoded"]["routing"]["errorReason"] == "MAX_RETRANSMIT"):
|
||||
print("Got ack error")
|
||||
acks[str(rid)] = False
|
||||
else:
|
||||
acks[str(rid)] = True
|
||||
|
||||
# TODO: Threaded send nethod
|
||||
|
||||
def send(interface, packet):
|
||||
global cpid
|
||||
# TODO: Set to confirm receipt, DONE
|
||||
# TODO: Async sendData call
|
||||
# TODO: Fix logging error
|
||||
print("sending")
|
||||
pid = interface.sendData(packet, wantAck=True, onResponse=responseCheck)
|
||||
#pid = await sendData(interface, packet, wantAck=True, onResponse=responseCheck)
|
||||
#pid = await iloop.run_in_executor(None, functools.partial(interface.sendData, interface, packet, wantAck=True, onResponse=responseCheck))
|
||||
# Can I use waitForAckNak on cpid?
|
||||
cpid = pid.id
|
||||
print(cpid)
|
||||
#return pid
|
||||
return True
|
||||
|
||||
def awaitResponse(pid):
|
||||
#pid = interface.sendData(p, wantAck=True, onResponse=responseCheck)["id"]
|
||||
#pid = await loop.run_in_executor(None, send, interface, p)
|
||||
#pid = await loop.run_in_executor(None, functools.partial(interface.sendData, wantAck=True, onResponse=responseCheck), interface, p)
|
||||
print(pid)
|
||||
for i in range(1_000_000_000):
|
||||
time.sleep(5)
|
||||
if str(pid) in acks:
|
||||
print("Response gotten")
|
||||
break
|
||||
print("waiting")
|
||||
return True
|
||||
|
||||
def awaitFullResponse(pid):
|
||||
for i in range(1_000_000_000):
|
||||
time.sleep(5)
|
||||
if pid in messages.keys():
|
||||
if messages[pid]["finished"]:
|
||||
print("Response gotten")
|
||||
break
|
||||
print("waiting")
|
||||
return True
|
||||
|
||||
pub.subscribe(onReceive, "meshtastic.receive")
|
||||
pub.subscribe(onConnection, "meshtastic.connection.established")
|
||||
# By default will try to find a meshtastic device, otherwise provide a device path like /dev/ttyUSB0
|
||||
interface = meshtastic.serial_interface.SerialInterface(sys.argv[-1])
|
||||
# Wait to connect to partner
|
||||
# TODO: use node id to delivery directly
|
||||
while notConnected:
|
||||
time.sleep(5)
|
||||
print("Waiting")
|
||||
if "0" in sys.argv[-1]:
|
||||
tj = [[{"message":"free palestine! free all colonized people!"}], ["the people yearn for freedom"]]
|
||||
j2 = {"message":"free palestine! free all colonized people!", "message2":"free palestine! free all colonized people!"}
|
||||
htmlj = {"html": "<h1>Hello world!</h1>"}
|
||||
htmljl = {"html": ""}
|
||||
with open("test.html", "r") as f:
|
||||
htmljl["html"] = f.read()
|
||||
done = False
|
||||
threads = {}
|
||||
for p in m.getPackets(bson.dumps(htmljl), 600123, 600123, 600124):
|
||||
print(sys.getsizeof(p))
|
||||
#send_thread = Thread(target=send, args=[interface, p])
|
||||
#send_thread.start()
|
||||
send(interface, p)
|
||||
#awaitResponse(cpid)
|
||||
await_thread = Thread(target=awaitResponse, args=[cpid])
|
||||
await_thread.start()
|
||||
cth = {
|
||||
"ob": await_thread,
|
||||
"pid": str(cpid),
|
||||
"packet": p,
|
||||
"retry": False
|
||||
}
|
||||
threads[str(cpid)] = cth
|
||||
# TODO: see if theres a better way to do this
|
||||
time.sleep(10)
|
||||
#await_thread.join()
|
||||
#await_thread.join()
|
||||
#loop = asyncio.new_event_loop()
|
||||
#loopi = asyncio.new_event_loop()
|
||||
#loopi.run_until_complete(send(interface, p))
|
||||
#res = loop.run_until_complete(awaitResponse(cpid))
|
||||
# figure out why it doesnt send before timing out
|
||||
# TODO: running in different threads
|
||||
#pid = send(interface, p).id
|
||||
#loop = asyncio.new_event_loop()
|
||||
#loopi = asyncio.new_event_loop()
|
||||
#loopi.run_until_complete(send(loopi, interface, p))
|
||||
#interface.waitForAckNak()
|
||||
#res = loop.run_until_complete(awaitResponse(interface, p, cpid))
|
||||
#print("Done waiting")
|
||||
#interface.waitForAckNak()
|
||||
# DO NOT RUN UNTIL responseCheck CHECKS FOR ERRORS
|
||||
isDone = False
|
||||
while not isDone:
|
||||
doneFlag = True
|
||||
for th in threads.keys():
|
||||
th = threads[th]
|
||||
if not th["ob"].is_alive:
|
||||
if not acks[th["pid"]]:
|
||||
retry = th["retry"]
|
||||
if retry == False:
|
||||
retry = 1
|
||||
elif retry < 3:
|
||||
retry += 1
|
||||
else:
|
||||
print("Too many retries")
|
||||
break
|
||||
doneFlag = False
|
||||
send(interface, th["packet"])
|
||||
await_thread = Thread(target=awaitResponse, args=[cpid])
|
||||
await_thread.start()
|
||||
cth = {
|
||||
"ob": await_thread,
|
||||
"pid": str(cpid),
|
||||
"packet": p
|
||||
}
|
||||
cth["retry"] = retry
|
||||
threads[str(cpid)] = cth
|
||||
# TODO: see if theres a better way to do this
|
||||
time.sleep(5)
|
||||
if doneFlag:
|
||||
isDone = True
|
||||
|
||||
|
||||
|
||||
|
||||
for it, p in enumerate(m.getPacketsFromFile("r.jpg", 600123, 600123, 600124)):
|
||||
#send(interface, p)
|
||||
#pid = send(interface, p).id
|
||||
#loopi = asyncio.new_event_loop()
|
||||
#loopi.run_until_complete(send(loopi, interface, p))
|
||||
#interface.waitForAckNak()
|
||||
#res = loop.run_until_complete(awaitResponse(interface, p, cpid))
|
||||
#interface.waitForAckNak()
|
||||
#print("Sending packet: " + str(it))
|
||||
break
|
||||
else:
|
||||
while True:
|
||||
if html != False:
|
||||
break
|
||||
pass
|
||||
webview.create_window('Home', html=html)
|
||||
webview.start()
|
||||
|
|
@ -0,0 +1,129 @@
|
|||
from textual.app import App, ComposeResult
|
||||
from textual.widgets import Log, Label, Footer, Header, ProgressBar
|
||||
from textual.binding import Binding
|
||||
from textual.containers import Horizontal, Vertical
|
||||
import sys, os
|
||||
|
||||
global nodeOb
|
||||
nodeOb = None
|
||||
|
||||
|
||||
class TUI(App):
|
||||
"""
|
||||
TUI for PierMesh
|
||||
|
||||
`🔗 Source <https://git.utopic.work/PierMesh/piermesh/src/branch/main/src/ui.py>`_
|
||||
|
||||
Attributes
|
||||
----------
|
||||
visibleLogo: bool
|
||||
Whether the logo is visible or not, used in toggling visibility
|
||||
nodeOb: Node
|
||||
Reference to the Node running the PierMesh service
|
||||
done: bool
|
||||
Whether the TUI has been killed
|
||||
"""
|
||||
|
||||
visibleLogo = True
|
||||
nodeOb = None
|
||||
done = False
|
||||
CSS_PATH = "ui.tcss"
|
||||
BINDINGS = [
|
||||
Binding(key="q", action="quitFull", description="Quit the app", show=True),
|
||||
Binding(
|
||||
key="f",
|
||||
action="toggleFullscreen",
|
||||
description="Full screen the logs",
|
||||
show=True,
|
||||
),
|
||||
]
|
||||
|
||||
def action_toggleFullscreen(self):
|
||||
"""
|
||||
Toggle fullscreen logs by either collapsing width or setting it to it's original size
|
||||
"""
|
||||
if self.visibleLogo:
|
||||
self.query_one("#logo").styles.width = 0
|
||||
else:
|
||||
self.query_one("#logo").styles.width = "50%"
|
||||
self.visibleLogo = not self.visibleLogo
|
||||
|
||||
def action_quitFull(self):
|
||||
"""
|
||||
Kill the whole stack by setting self to done and terminating the thread. We check in run.monitor later and kill the rest of the stack then with psutil
|
||||
|
||||
See Also
|
||||
--------
|
||||
run.monitor
|
||||
"""
|
||||
self.done = True
|
||||
sys.exit("Terminating TUI...")
|
||||
|
||||
def compose(self) -> ComposeResult:
|
||||
"""
|
||||
Build the TUI
|
||||
"""
|
||||
ascii = ""
|
||||
with open("piermesh-mini.ascii", "r") as f:
|
||||
ascii = f.read()
|
||||
"""
|
||||
Load the ascii art for display on the left label
|
||||
"""
|
||||
yield Header(icon="P")
|
||||
yield Label(ascii, classes="largeLabel", name="logo", id="logo")
|
||||
yield Vertical(
|
||||
Log(auto_scroll=True, classes="baseLog"),
|
||||
Label("CPU usage:", name="cpul", id="cpul"),
|
||||
ProgressBar(show_eta=False, show_percentage=True),
|
||||
Label("MEM usage: ", name="meml", id="meml"),
|
||||
)
|
||||
yield Footer()
|
||||
|
||||
def do_write_line(self, logLine: str):
|
||||
"""
|
||||
Write line to the logs panel
|
||||
|
||||
Parameters
|
||||
----------
|
||||
logLine: str
|
||||
Line to log
|
||||
"""
|
||||
log = self.query_one(Log)
|
||||
log.write_line(logLine)
|
||||
|
||||
def do_set_cpu_percent(self, percent: float):
|
||||
"""
|
||||
Set CPU percent in the label and progress bar
|
||||
|
||||
Parameters
|
||||
----------
|
||||
percent: float
|
||||
Percent of the cpu PierMesh is using
|
||||
"""
|
||||
self.query_one("#cpul").update("CPU usage: {0} %".format(str(percent)))
|
||||
pbar = self.query_one(ProgressBar)
|
||||
pbar.progress = percent
|
||||
|
||||
def do_set_mem(self, memmb: float):
|
||||
"""
|
||||
Set memory usage label in the ui
|
||||
|
||||
Parameters
|
||||
----------
|
||||
memmb: float
|
||||
Memory usage of PierMesh in megabytes
|
||||
"""
|
||||
self.query_one("#meml").update("MEM usage: {0} mB".format(str(memmb)))
|
||||
|
||||
def on_mount(self):
|
||||
"""
|
||||
Called at set up, configures the title and the progess bar
|
||||
"""
|
||||
self.title = "PierMesh TUI"
|
||||
self.query_one(ProgressBar).update(total=100)
|
||||
self.query_one(ProgressBar).update(progress=0)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
app = TUI()
|
||||
app.run()
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
TUI application
|
||||
==========================
|
||||
|
||||
.. autoclass:: ui.TUI
|
||||
:members:
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
Screen {
|
||||
layout: horizontal;
|
||||
scrollbar-size: 0 0;
|
||||
}
|
||||
|
||||
.largeLabel {
|
||||
width: 40%;
|
||||
}
|
||||
|
||||
.baseLog {
|
||||
height: 80%;
|
||||
scrollbar-background: $primary-background;
|
||||
scrollbar-corner-color: $primary-background;
|
||||
scrollbar-color: green;
|
||||
scrollbar-size: 0 1;
|
||||
}
|
||||
|
||||
ProgressBar {
|
||||
width: 50%;
|
||||
}
|
||||
Bar > .bar--bar {
|
||||
color: green;
|
||||
}
|
||||
|
|
@ -0,0 +1,40 @@
|
|||
from jinja2 import Environment, FileSystemLoader, select_autoescape
|
||||
import os, markdown2
|
||||
import json, msgpack, subprocess
|
||||
import shutil
|
||||
from distutils.dir_util import copy_tree
|
||||
|
||||
env = Environment(loader=FileSystemLoader("templates"))
|
||||
|
||||
# subprocess.check_call("mmdc -i * -e png")
|
||||
|
||||
# TODO: Generating mmd from docstrings
|
||||
|
||||
for path in os.listdir("diagrams/markdown"):
|
||||
fname = path.split(".")[0]
|
||||
try:
|
||||
subprocess.check_call(
|
||||
"mmdc -i diagrams/markdown/{0} -o res/img/diagrams/{1}.png".format(
|
||||
path, fname
|
||||
),
|
||||
shell=True,
|
||||
)
|
||||
except Exception as e:
|
||||
print("Empty file or other error")
|
||||
|
||||
|
||||
copy_tree("diagrams/markdown", "res/diagrams")
|
||||
copy_tree("res", "build/res")
|
||||
shutil.copyfile("htmx-extensions/src/ws/ws.js", "build/res/js/ws.js")
|
||||
|
||||
tpath = "templates/"
|
||||
|
||||
for path in os.listdir(tpath):
|
||||
if ("base" in path) != True:
|
||||
for t in os.listdir(tpath + path):
|
||||
if os.path.exists("build/" + path) != True:
|
||||
os.makedirs("build/" + path)
|
||||
ipath = tpath + path + "/" + t
|
||||
template = env.get_template(path + "/" + t)
|
||||
with open("build/{0}/{1}".format(path, t), "w") as f:
|
||||
f.write(template.render())
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: "🔵 Bubble"
|
||||
---
|
||||
erDiagram
|
||||
"👥 Peer" |{..o| "🗄️ Server" : "🔌 WS"
|
||||
"👥 Peer" |{..o| "🗄️ Server": "📄 HTTP/S"
|
||||
"🗄️ Server" |o..o| "📤 Transmitter": "❔ Queries"
|
||||
"📤 Transmitter" |o..o| "📻 PierMesh": "📻 send"
|
||||
"📤 Transmitter" |o..o| "📻 PierMesh": "📻 onReceive"
|
||||
"📤 Transmitter" |o..o| "🧽 Sieve": "📻 onReceive"
|
||||
"🧽 Sieve" |o..o| "💿 Cache": "➕ Write"
|
||||
"💿 Cache" |o..o| "👂 fListen": "➕ Write event"
|
||||
"👂 fListen" |o..o| "🗄️ Server": "✉️ Pass message"
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
title: "🐟 Catch"
|
||||
---
|
||||
erDiagram
|
||||
"👥 Peer" |{..o| "🗄️ Server": "🔌 WS"
|
||||
"👥 Peer" |{..o| "🗄️ Server": "📄 HTTP/S"
|
||||
"🗄️ Server" |o..o| "🐟 Catch": "❔ Queries"
|
||||
"📻 PierMesh" |o..o| "🧽 Sieve": "🧽 Filters"
|
||||
"🧽 Sieve" |o..o| "👂 fListen": "👂 Listens for messages"
|
||||
"👂 fListen" |o..o| "🐟 Catch": "❔ Queries"
|
||||
"🐟 Catch" |o..}| "🌼 Daisy": "📄 Store references"
|
||||
"🌼 Daisy" {
|
||||
string filepath
|
||||
dictionary msg
|
||||
}
|
||||
"🌼 Daisy" |o..o| "📁 File system": "📁 CRUD"
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
title: "🌼 Daisy"
|
||||
---
|
||||
erDiagram
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: "📻 PierMesh"
|
||||
---
|
||||
erDiagram
|
||||
"👥 Peer" }|..|{ "🗄️Server" : "🔌 WS"
|
||||
"👥 Peer" }|..|{ "🗄️Server": "📄 HTTP/S"
|
||||
"🗄️Server" |o..o| "🐟 Catch": "❔ Queries"
|
||||
"🗄️Server" |o..o| "💿 Cache": "❔ Queries"
|
||||
"🗄️Server" |o..o| "📤 Transmitter": "❔ Queries"
|
||||
"🐟 Catch" |o..o| "📤 Transmitter": "❔ Queries"
|
||||
"🐟 Catch" |o..o| "👥 Peer": "🔌 WS"
|
||||
"🐟 Catch" |o..o| "📤 Transmitter": "✉️ Sync packet"
|
||||
"💿 Cache" |o..o| "📤 Transmitter": "✉️ Sync packet"
|
||||
"👂 fListen" |o..o| "💿 Cache": "👂 Listen for completed messages"
|
||||
"👂 fListen" |o..o| "👥 Peer": "🔌 WS"
|
||||
"📤 Transmitter" |o..o| "🔽 onReceive": "✉️ Get packet"
|
||||
"🔽 onReceive" |o..o| "🧽 Sieve": "🧽 Filter packet"
|
||||
"🧽 Sieve" |o..o| "💿 Cache": "➕ Push completed messages"
|
||||
"📤 Transmitter" |o..o| "📻 PierMesh": "📻 Send"
|
||||
"📻 PierMesh" |o..o| "🔽 onReceive": "🔽 Receive"
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue