wes/skyweave
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit of mico-framework refactor. Original monolithic script still exists in /src

Browse Source
This commit is contained in:
wes
2025-06-07 23:59:53 -04:00
parent ed94ee9a92
commit eaa1f5ce53
12 changed files with 2009 additions and 245 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
Regular → Executable
View File
LICENSE
+666 -224
View File
@@ -1,232 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright © 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.
skyweave
Copyright (C) 2025 wes
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/>.
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:
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
skyweave Copyright (C) 2025 wes
<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.
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”.
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/>.
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/philosophy/why-not-lgpl.html>.
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>.
README.md
+251 -20
View File
@@ -1,24 +1,255 @@
**Project: RVLink MV2400 Custom Control API (skyweave.lua)**
# Skyweave API Framework
This repository contains `skyweave.lua`, a custom CGI application written in Lua for the OpenWrt-based RVLink MV2402 roof-mounted internet unit. The primary goal is to achieve direct, programmatic control over the MV2402's networking functionalities, independent of the original indoor controller unit (RV2458).
## 1. Overview
**Key Features & Objectives:**
* Bypass indoor unit orchestration by disabling proprietary services (`wtpd`, `heart_beat`).
* Implement a Lua CGI API (`skyweave.lua`) for:
* Wi-Fi client (STA) connection management (SSID, BSSID, encryption, key).
* Wi-Fi scanning using `iwinfo`.
* Retrieval of system logs (raw and parsed with SHA256 hashes).
* Fetching detailed network and system status (replicating `guide_config`, live IP/DNS/gateway, etc.).
* Utilize standard OpenWrt tools (`uci`, `logread`, `iwinfo`, `ubus`, shell commands) for backend operations.
* Based on reverse engineering insights from the original `webmgnt` C firmware (analyzed with Ghidra).
* Facilitates advanced WAN management, failover, and integration with downstream routers like MikroTik.
This document describes the refactored Skyweave API framework, a lightweight Lua micro-framework designed for the RVLink MV2400 Roof Unit (COMFAST CF-E5 derivative) running a legacy OpenWrt version with Lua 5.1. It replaces the original monolithic `skyweave.lua` script with a more modular, extensible, and maintainable architecture.
**Prerequisites & Setup on MV2400:**
* **`opkg` Configuration:** The default `opkg.conf` on the MV2402 likely needs to be updated to point to valid OpenWrt Chaos Calmer 15.05 package repositories (e.g., `http://archive.openwrt.org/chaos_calmer/15.05/ar71xx/generic/packages/`) to enable package installation.
* **Essential Packages:** After fixing `opkg`, install the following:
* `lua`: The Lua interpreter.
* `uhttpd`: OpenWrt's web server, to run Lua CGI scripts.
* `sha256sum`: For generating SHA256 hashes (part of `coreutils-sha256sum` or `coreutils` depending on the feed) if not already present.
* **JSON Library:** This project uses a pure Lua JSON library (`rxi/json.lua`). The `json.lua` file needs to be manually placed in a Lua library path on the device, typically `/usr/lib/lua/`.
The primary goal of this refactoring is to decouple request routing and handling from the business logic of individual API endpoints, making it easier to add, remove, or modify endpoints.
This project empowers users with enhanced control and automation capabilities for the RVLink system.
## 2. Architecture
The framework is structured across several key directories and files:
* **/app/cgi_scripts/skyweave.lua** (source): This is the main CGI script. For deployment, it should be placed at **`/www/cgi-bin/skyweave.lua`** and be made executable. It is run by the `uhttpd` web server (with Lua CGI support enabled via `/etc/config/uhttpd`).
* **Note for Deployment**: Ensure `uhttpd` is configured to handle `.lua` scripts as CGI, and the `lua` interpreter is available at `#!/usr/bin/lua`.
* **/app/skyweave/** (source): This directory contains all core framework modules. For deployment, this entire directory should be copied to **`/usr/lib/lua/skyweave/`** on the target system.
* `router.lua`: The routing engine. It maps incoming requests to the appropriate handler functions.
* `request.lua`: Handles parsing of incoming HTTP requests (method, query, headers, body) into a `request_context` table.
* `response.lua`: Provides helper functions for sending standardized JSON responses (success and error).
* `utils.lua`: A collection of common utility functions (e.g., command execution, UCI interaction, string parsing).
* **/app/skyweave/handlers/**: This directory houses the business logic for individual API endpoints. Each `.lua` file typically groups related handlers.
* Examples: `network.lua`, `system.lua`, `wifi.lua`.
* **/app/lib/**: Contains external Lua libraries.
* `json.lua`: The rxi/json.lua library. For deployment, this file (from `/app/lib/json.lua` in the repository) should be copied to **`/usr/lib/lua/json.lua`** on the target system.
### Lua Module Loading & Execution
The main CGI script (`/www/cgi-bin/skyweave.lua` after deployment) relies on Lua's standard `package.path` mechanism to find modules. It uses `require` calls like `require("skyweave.router")` and `require("json")`. This requires:
1. The `skyweave` framework modules to be located at `/usr/lib/lua/skyweave/`.
2. The `json.lua` library to be located at `/usr/lib/lua/json.lua`.
3. The OpenWrt Lua interpreter's `package.path` to include `/usr/lib/lua/?.lua` and `/usr/lib/lua/?/init.lua` (which is typical).
The script does **not** perform any local `package.path` manipulation.
## 3. Key Framework Components
### 3.1. Router (`skyweave/router.lua`)
The router is responsible for directing incoming requests to the correct handler function. It maintains a routing table where each route is defined by an HTTP method (e.g., "GET", "POST") and a conceptual path key (e.g., "/network_config").
A key feature for backward compatibility is its ability to translate query parameters from the original API style (e.g., `?get_config=status` or `?set_config=wifi`) into these internal method/path keys for routing.
The router now also supports dispatching based on the URL path (via the CGI `PATH_INFO` variable). If a request like `/cgi-bin/skyweave.lua/network/config` is made, and `PATH_INFO` is correctly passed by the uhttpd server as `/network/config`, the router will use this path directly to find a matching route. This `PATH_INFO`-based routing is prioritized over the query parameter method.
### 3.2. Request Context (`skyweave/request.lua`)
Instead of direct CGI variable manipulation, all handler functions receive a single Lua table called `request_context`. This table contains pre-parsed information about the request:
* `request.method`: The HTTP request method (e.g., "GET", "POST").
* `request.path`: The PATH_INFO component of the URL (if provided by `uhttpd` from the web server configuration).
* `request.query`: A table of parsed query string parameters.
* `request.headers`: A table of HTTP headers.
* `request.raw_body`: The raw request body as a string.
* `request.body`: If the `Content-Type` is `application/json` and a JSON library is available, this field contains the parsed JSON body as a Lua table. Otherwise, it's `nil`.
* `request.body_parse_error`: Contains an error message if JSON parsing of the body failed.
### 3.3. Response Helpers (`skyweave/response.lua`)
To ensure consistent API output, two main helper functions are provided:
* `response.json(data_table, http_status_code)`: Sends a successful JSON response. `http_status_code` defaults to 200.
* `response.error(error_message, http_status_code, internal_error_code)`: Sends a JSON error response. `http_status_code` defaults to 500, and `internal_error_code` defaults to -1.
Both functions automatically set the `Content-Type: application/json` header and the CGI `Status:` header (e.g., "Status: 200 OK").
## 4. API Endpoints
This section describes how to add new API endpoints and how they can be accessed.
### 4.1. Create/Update Handler Function
1. **Location**: Create a new Lua module or open an existing one in the `/app/skyweave/handlers/` directory (e.g., `/app/skyweave/handlers/myfeature.lua`).
2. **Structure**:
```lua
-- /app/skyweave/handlers/myfeature.lua
local myfeature_handler = {}
-- Handler function
function myfeature_handler.get_custom_data(request_context)
-- Access request data via request_context
local item_id = request_context.query.id
if not item_id then
return { errCode = -100, errMsg = "Item ID is required" }
end
-- Your business logic here...
local data = { id = item_id, value = "Some data for " .. item_id }
return data -- This will be sent as a JSON response
end
return myfeature_handler
```
3. **Function Signature**: The handler function must accept a single argument, `request_context`.
4. **Return Value**:
* For a successful synchronous response, return a Lua table. This table will be automatically encoded as JSON.
* To indicate an error handled within the function, return a table with `errCode` and `errMsg` fields.
* To trigger a 204 No Content response, return `nil`.
* For asynchronous tasks, see Section 5.
### 4.2. Register Route
1. **Edit Main Dispatcher**: Open `/app/cgi_scripts/skyweave.lua`.
2. **Require Handler Module**: Add a `require` statement for your new handler module:
```lua
local myfeature_handlers = require("skyweave.handlers.myfeature")
```
3. **Add Route**: In the "Register Routes" section, call `router:add_route()`:
```lua
-- Example: Map GET ?get_config=custom_data to myfeature_handler.get_custom_data
router:add_route("GET", "/custom_data", myfeature_handlers.get_custom_data)
```
The `path_key` (e.g., `"/custom_data"`) will be matched if the router derives this key either from a `PATH_INFO` like `/custom_data` in the URL (e.g. `/www/cgi-bin/skyweave.lua/custom_data`), or from a query parameter like `?get_config=custom_data` (as per the logic in `determine_route_key_from_request`).
## 5. Asynchronous Task Pattern
For operations that may take a long time (e.g., restarting services, applying complex configurations), handlers can initiate an asynchronous task. This prevents the HTTP request from timing out.
To use this pattern, a handler function should return a special Lua table:
```lua
function network_handler.set_connect_wifi(request_context)
-- ... (validation and command setup) ...
local uci_commands = "uci set wireless.wwan.ssid='MyNetwork'; uci commit wireless; wifi"
return {
async = true, -- Required: signals an asynchronous task
command = uci_commands, -- Required: the shell command to execute
response = { -- Required: the immediate JSON response
errCode = 0,
errMsg = "WiFi connection command accepted. Will apply in background."
}
}
end
```
The framework will:
1. Immediately send the content of the `response` field as a JSON response to the client (typically with an HTTP 202 Accepted status).
2. Execute the `command` string in the system shell in the background. The execution is wrapped like this: `(sleep 2; <your_command_here>) >/dev/null 2>&1 &`. The `sleep 2` provides a brief buffer before execution.
## 6. Dependencies
* **Lua 5.1**
* **JSON Library**: The framework modules now use `require("json")` to load the JSON library. It is assumed that `lua-cjson` is not available or not preferred. For deployment, the file `/app/lib/json.lua` (which is rxi/json.lua) must be copied to a standard Lua path on the target OpenWrt system and named `json.lua` (e.g., copy `/app/lib/json.lua` to `/usr/lib/lua/json.lua`).
## 7. Original Script Analysis Summary
The original `skyweave.lua` was a monolithic script handling all API logic. This refactoring introduced:
* **Decoupled Routing Engine**: Clear separation of routing from handler logic.
* **Request Abstraction**: Unified `request_context` object.
* **Standardized Response Helpers**: Consistent JSON output.
* **Formalized Asynchronous Task Pattern**: Standard way for handlers to perform background tasks.
* **Modular Code Structure**: Improved organization and maintainability.
## 8. Example Refactored Handler: `set_connect_wifi`
The `set_connect_wifi` handler in `/app/skyweave/handlers/network.lua` demonstrates using the `request_context.body` for POST data and the asynchronous task return pattern:
```lua
-- In /app/skyweave/handlers/network.lua
local utils = require("skyweave.utils")
local network_handler = {}
-- ... (other handlers like get_network_config) ...
function network_handler.set_connect_wifi(request_context)
local body = request_context.body
if not body then
return { errCode = -29, errMsg = "Request body is missing or not valid JSON.", configDone = false }
end
local ssid = body.ssid
-- ... (retrieve other params: bssid, encryption_type, key, device from body) ...
-- ... (validation logic for ssid, encryption_type, key) ...
-- Example: if not ssid or ssid == "" then return { errCode = -30, errMsg = "SSID is required." } end
local commands = {}
local function add_cmd(cmd) table.insert(commands, cmd) end
-- ... (Build UCI commands as strings using add_cmd) ...
-- Example: add_cmd("uci set wireless.wwan.ssid='" .. ssid:gsub("'", "'\\''") .. "'")
add_cmd("uci set wireless.wwan.disabled=0")
add_cmd("uci set wireless.wwan.mode=sta")
-- Add all other necessary UCI commands for setting up Wi-Fi connection
add_cmd("uci commit wireless")
add_cmd("uci commit network")
add_cmd("/etc/init.d/network restartall")
local command_string = table.concat(commands, "; ")
local response_msg = "OK (Configuration accepted. Device will attempt to connect to SSID: " .. ssid .. ")"
-- ... (append BSSID to response_msg if present) ...
return {
async = true,
command = command_string,
response = {
errCode = 0,
errMsg = response_msg,
configDone = true
}
}
end
return network_handler
```
This example illustrates how to access POST data from `request_context.body` and how to structure the return for an asynchronous command execution.
### 4.3. Accessing API Endpoints
API endpoints can be accessed in two ways:
**A. Path-Based URLs (Recommended for clarity):**
This method uses the path part of the URL after the script name.
- Example GET: `curl http://<device_ip>/cgi-bin/skyweave.lua/network_config`
- Example POST: `curl -X POST -d '{\"ssid\":\"MyNet\"}' http://<device_ip>/cgi-bin/skyweave.lua/connect_wifi`
This relies on your uhttpd server correctly setting the `PATH_INFO` environment variable (see Section 9: uhttpd Server Configuration).
**B. Query Parameter-Based URLs (Legacy/Alternative):**
This method uses query parameters like `get_config` or `set_config`.
- Example GET: `curl http://<device_ip>/cgi-bin/skyweave.lua?get_config=network_config`
- Example POST: `curl -X POST -d '{\"ssid\":\"MyNet\"}' http://<device_ip>/cgi-bin/skyweave.lua?set_config=connect_wifi`
## 9. uhttpd Server Configuration for PATH_INFO
The path-based URL feature (e.g., `/cgi-bin/skyweave.lua/network/config`) depends on the `uhttpd`
web server correctly interpreting the part of the URL after the script name as `PATH_INFO`
and passing it as an environment variable to the `skyweave.lua` script.
Standard OpenWrt `uhttpd` configurations for CGI scripts typically support this by default.
Ensure your `/etc/config/uhttpd` includes:
```
config uhttpd main
# ... other main settings ...
option cgi_prefix '/cgi-bin'
config uhttpd cgi
list interpreter '.lua=/usr/bin/lua'
# For OpenWrt 21.02+ or uhttpd versions with rfc_cgi_pathinfo support,
# explicitly enabling it can ensure compliance, though often not needed:
# option rfc_cgi_pathinfo '1'
```
Usually, no special configuration for `PATH_INFO` itself is required beyond enabling CGI for Lua.
**Verifying `PATH_INFO`:**
If you suspect `PATH_INFO` is not being set, you can temporarily add the following
at the beginning of your `/www/cgi-bin/skyweave.lua` script (after deployment):
```lua
print("Content-Type: text/plain")
print("")
print("DEBUG PATH_INFO: " .. (os.getenv("PATH_INFO") or "PATH_INFO is nil"))
os.exit()
```
Then, access a URL like `http://<device_ip>/cgi-bin/skyweave.lua/test/path`. The output
should show `/test/path`. Remember to remove this debugging code afterwards.
cgi_scripts/skyweave.lua
Executable
+78
View File
@@ -0,0 +1,78 @@
#!/usr/bin/lua
-- Main CGI entry point for the Skyweave API.
-- This script is intended to be deployed at /www/cgi-bin/skyweave.lua.
--
-- It assumes that:
-- 1. The skyweave framework modules (router, request, handlers, etc.)
-- are located in /usr/lib/lua/skyweave/
-- (e.g., /usr/lib/lua/skyweave/router.lua).
-- 2. The json.lua library (originally from /app/lib/json.lua) is available
-- in a standard Lua path as 'json.lua' (e.g., /usr/lib/lua/json.lua).
-- package.path is assumed to be configured correctly in the target OpenWrt environment.
local p_response_ok, response_module = pcall(require, "skyweave.response")
-- Try to load json independently for emergency_error, in case response_module loading failed or it doesn't expose json table directly.
local p_json_ok, json_for_emergency = pcall(require, "json")
local function emergency_error(message, status_code)
status_code = status_code or 500
print("Status: " .. status_code)
print("Content-Type: application/json")
print("")
if p_json_ok then
print(json_for_emergency.encode({ errCode = -999, errMsg = "Framework Panic: " .. message }))
else
-- Fallback to a very basic JSON-like string if no JSON encoder is available
print('{"errCode": -999, "errMsg": "Framework Panic: ' .. message:gsub('[\\"]', '\%1') .. '"}')
end
end
local success, load_result = pcall(function()
-- response_module is already attempted to be loaded by pcall above.
-- If p_response_ok is false, response_module is the error object.
if not p_response_ok then
-- If the core response module itself failed, we cannot proceed with normal operations.
-- The error from loading response_module is in 'response_module' variable here.
emergency_error("Core component 'skyweave.response' failed to load: " .. tostring(response_module))
return -- Stop execution
end
local Router = require("skyweave.router")
local request_context_builder = require("skyweave.request")
local network_handlers = require("skyweave.handlers.network")
local system_handlers = require("skyweave.handlers.system")
local wifi_handlers = require("skyweave.handlers.wifi")
local router = Router:new()
router:add_route("GET", "/network_config", network_handlers.get_network_config)
router:add_route("POST", "/connect_wifi", network_handlers.set_connect_wifi)
router:add_route("GET", "/wifi_scan", wifi_handlers.get_wifi_scan)
router:add_route("GET", "/system_log_parsed", system_handlers.get_system_log_parsed)
local request = request_context_builder.create_request_context()
if not request then
-- Use the already loaded response_module if available, otherwise the basic emergency_error
if p_response_ok then
response_module.error("Failed to create request context.", 500)
else
emergency_error("Failed to create request context.", 500)
end
return
end
router:dispatch(request)
end)
if not success then
local error_message = "Critical error in main script execution: " .. tostring(load_result)
-- Use the already loaded response_module if available, otherwise the basic emergency_error
if p_response_ok then
response_module.error(error_message, 500, -999)
else
emergency_error(error_message, 500)
end
end
skyweave/handlers/network.lua
Executable
+156
View File
@@ -0,0 +1,156 @@
-- skyweave/handlers/network.lua
local utils = require("skyweave.utils") -- Updated path
local network_handler = {}
-- Original: function handlers.get_network_config(params)
function network_handler.get_network_config(request_context)
local iface = request_context.query.interface or "wan" -- Default to "wan"
-- Ensure utils are available for these calls
local live_dns_list, live_search_domains = utils.get_live_dns_servers_from_resolv(iface)
local live_gateway_ip, live_gateway_iface = utils.get_default_gateway_from_route()
-- get_live_interface_info returns: address, mask, device, leasetime, error_message
local live_wan_ip, live_wan_netmask, ifname, dhcp_lease_time, err_msg_live_info = utils.get_live_interface_info(iface)
-- Handle potential error from get_live_interface_info if needed, e.g. log err_msg_live_info
local response_data = { errCode = 0, errMsg = "OK"}
response_data.wwan = {
ssid = utils.uci_get("wireless.wwan.ssid") or "",
bssid = utils.uci_get("wireless.wwan.bssid") or "",
encryption = utils.uci_get("wireless.wwan.encryption") or "",
key = utils.uci_get("wireless.wwan.key") or "", -- Consider redacting this for a GET
device = utils.uci_get("wireless.wwan.device") or "",
wan_dns1 = live_dns_list and live_dns_list[1] or "",
wan_dns2 = live_dns_list and live_dns_list[2] or "",
wan_gateway = live_gateway_ip or "",
wan_ip = live_wan_ip or "",
wan_netmask = live_wan_netmask or "",
wan_ifname = ifname or "", -- from get_live_interface_info
wan_iface = iface, -- the logical interface name queried
wan_dhcp_lease_time = dhcp_lease_time or "" -- from get_live_interface_info
}
response_data.lan = {
ipaddr = utils.uci_get("network.lan.ipaddr") or "",
netmask = utils.uci_get("network.lan.netmask") or "",
gateway = utils.uci_get("network.lan.gateway") or "", -- Typically not set for LAN if router
start = utils.uci_get("dhcp.lan.start") or "",
limit = utils.uci_get("dhcp.lan.limit") or "",
leasetime = utils.uci_get("dhcp.lan.leasetime") or "",
domain = utils.uci_get("dhcp.@dnsmasq[0].domain") or "",
ignore = utils.uci_get("dhcp.lan.ignore") or "" -- bool, uci_get returns "0" or "1"
}
return response_data
end
-- Original: function handlers.set_connect_wifi(params) -> params was POST data
function network_handler.set_connect_wifi(request_context)
-- Parameters from POST body
local body = request_context.body
if not body then
return { errCode = -29, errMsg = "Request body is missing or not valid JSON.", configDone = false }
end
local ssid = body.ssid
local bssid = body.bssid -- Optional
local encryption_type = body.encryption or "none"
local key = body.key -- Optional, but required for encrypted types
local sta_device = body.device or "radio0" -- Default device
-- Define UCI configuration sections and interface names (as in original)
local sta_uci_section = "wireless.wwan"
local sta_ifname = "vif-sta0" -- This is the network interface name, not a physical device
-- Validation (as in original)
if not ssid or ssid == "" then
return { errCode = -30, errMsg = "SSID is required.", configDone = false }
end
local supported_encryptions = {
["none"] = true, ["psk"] = true, ["psk2"] = true,
["wep"] = true, ["wep-open"] = true, ["wep-shared"] = true
}
if not supported_encryptions[encryption_type] then
return { errCode = -31, errMsg = "Unsupported encryption type: " .. tostring(encryption_type), configDone = false }
end
if (encryption_type ~= "none" and encryption_type ~= "") and (not key or key == "") then
return { errCode = -32, errMsg = "Key is required for encryption type: " .. encryption_type, configDone = false }
end
local commands = {}
local function add_cmd(cmd)
table.insert(commands, cmd)
end
-- A) Configure Wireless STA Interface
add_cmd("uci set " .. sta_uci_section .. ".disabled=0")
add_cmd("uci set " .. sta_uci_section .. ".mode=sta")
add_cmd("uci set " .. sta_uci_section .. ".ifname='" .. sta_ifname .. "'")
add_cmd("uci set " .. sta_uci_section .. ".device='" .. sta_device .. "'")
add_cmd("uci set " .. sta_uci_section .. ".network=wan") -- Assign this wireless STA to 'wan' logical network
add_cmd("uci set " .. sta_uci_section .. ".ssid='" .. ssid:gsub("'", "'\''") .. "'") -- Sanitize SSID for shell
if bssid and bssid ~= "" then
add_cmd("uci set " .. sta_uci_section .. ".bssid='" .. bssid:gsub("'", "'\''") .. "'") -- Sanitize BSSID
else
add_cmd("uci delete " .. sta_uci_section .. ".bssid")
end
-- B) Configure Wireless Encryption
if encryption_type == "none" then
add_cmd("uci set " .. sta_uci_section .. ".encryption=none")
add_cmd("uci delete " .. sta_uci_section .. ".key")
else -- covers psk, psk2, wep variants
local uci_enc_val = encryption_type
if encryption_type == "wep" then uci_enc_val = "wep-open" end -- Default WEP to open
add_cmd("uci set " .. sta_uci_section .. ".encryption=" .. uci_enc_val)
add_cmd("uci set " .. sta_uci_section .. ".key='" .. (key or ""):gsub("'", "'\''") .. "'") -- Sanitize key
end
-- C) Configure the Network WAN Interface to use DHCP (it's now the STA interface)
add_cmd("uci set network.wan.proto=dhcp")
-- The physical device for network.wan is effectively controlled by wireless.wwan.network='wan'
-- No need to set network.wan.ifname here, as the system handles it.
-- Remove any static IP settings from WAN as it's now DHCP via WiFi STA
add_cmd("uci delete network.wan.ipaddr; uci delete network.wan.netmask; uci delete network.wan.gateway; uci delete network.wan.dns")
add_cmd("uci delete network.wan.ip6addr; uci delete network.wan.ip6gw; uci delete network.wan.ip6prefix")
-- D) Deconflict with LTE Mode (original behavior)
add_cmd("rm -f /etc/lte_mode")
-- E) Commit UCI changes and restart network
add_cmd("uci commit wireless")
add_cmd("uci commit network")
-- The original script had /etc/init.d/network restartall.
-- A more targeted restart might be 'wifi reload && /etc/init.d/network restart wan'
-- or simply '/etc/init.d/network restart'
-- For now, keeping 'restartall' for consistency with original behavior.
add_cmd("/etc/init.d/network restartall")
local command_string = table.concat(commands, "; ")
-- The router will wrap this with (sleep 2; ...) &
local response_msg = "OK (Configuration accepted. Device will attempt to connect to SSID: " .. ssid
if bssid and bssid ~= "" then
response_msg = response_msg .. " | BSSID: " .. bssid .. ")"
else
response_msg = response_msg .. ")"
end
return {
async = true,
command = command_string,
response = {
errCode = 0,
errMsg = response_msg,
configDone = true -- Indicate config was applied, pending connection
}
}
end
return network_handler
skyweave/handlers/system.lua
Executable
+63
View File
@@ -0,0 +1,63 @@
-- skyweave/handlers/system.lua
local utils = require("skyweave.utils") -- Updated path
local system_handler = {}
-- Original function: handlers.get_system_log_parsed(params)
-- Refactored to: system_handler.get_system_log_parsed(request_context)
function system_handler.get_system_log_parsed(request_context)
-- This handler doesn't use specific query parameters or body from request_context for its main logic.
-- It primarily executes 'logread'.
-- utils.execute_command is preferred over io.popen directly for consistency,
-- though the original used io.popen. We'll stick to the original's direct use here
-- as utils.execute_command might not return the handle needed for line-by-line reading
-- if logread output is very large. However, logread is usually read all at once.
-- Let's use utils.execute_command for consistency with other potential commands.
local log_content = utils.execute_command("logread")
if log_content == nil then
-- utils.execute_command might return nil, an empty string, or output.
-- Handle nil case as failure to execute or empty output.
return {
errCode = -20,
errMsg = "Failed to execute logread command or command yielded no output.",
parsed_logs = {},
processing_summary = "Error executing logread."
}
end
local parsed_logs_list = {}
local lines_processed = 0
local lines_failed_parse = 0
if log_content ~= "" then
for line in string.gmatch(log_content, "[^\r\n]+") do -- Match lines not containing CR or LF
if line ~= "" then -- Process non-empty lines
lines_processed = lines_processed + 1
-- Use utils.parse_log_line from the utils module
local parsed_entry = utils.parse_log_line(line)
if parsed_entry.parse_error then
lines_failed_parse = lines_failed_parse + 1
end
table.insert(parsed_logs_list, parsed_entry)
end
end
end
local summary_msg_key = (lines_processed == 0 and log_content == "") and "No log entries found." or
string.format("Processed %d lines. %d lines failed to parse.", lines_processed, lines_failed_parse)
local response_data = {
parsed_logs = parsed_logs_list,
processing_summary = summary_msg_key,
errCode = 0,
errMsg = "OK"
-- The 'configDone = false' from original seems irrelevant here, omitting.
}
return response_data
end
return system_handler
skyweave/handlers/wifi.lua
Executable
+149
View File
@@ -0,0 +1,149 @@
-- skyweave/handlers/wifi.lua
-- No direct utils needed for the core logic of get_wifi_scan,
-- as it uses io.popen for specific parsing needs.
-- local utils = require("../utils")
local wifi_handler = {}
-- Original function: handlers.get_wifi_scan(params)
-- Refactored to: wifi_handler.get_wifi_scan(request_context)
function wifi_handler.get_wifi_scan(request_context)
local ifname = request_context.query.ifname or "radio0" -- Default to radio0
-- Validate ifname to known radio interfaces to prevent command injection
if not (ifname == "radio0" or ifname == "radio1") then
return {
errCode = -11,
errMsg = "Invalid interface name specified: " .. tostring(ifname),
result_count = 0, -- Consistent with original error structure
results = {}
}
end
local command = "iwinfo " .. ifname .. " scan"
local handle = io.popen(command)
if not handle then
return {
errCode = -12,
errMsg = "Failed to execute iwinfo command for " .. tostring(ifname),
result_count = 0,
results = {}
}
end
local output = handle:read("*a")
handle:close()
if output == nil or output == "" then
return {
errCode = 0,
errMsg = "OK (no scan results or empty output from command)", -- Clarified message
result_count = 0,
results = {}
}
end
local results_list = {}
local current_ap_data = nil
-- The parsing logic below is complex and specific to iwinfo output.
-- It's preserved as closely as possible from the original script.
for line in string.gmatch(output, "[^\r\n]+") do
line = line:match("^%s*(.-)%s*$") -- Trim whitespace
local cell_addr = line:match("^Cell %d+%s*-%s*Address:%s*([:%x%dABCDEFabcdef]+)")
if cell_addr then
if current_ap_data and current_ap_data.address then
current_ap_data.ssid = current_ap_data.ssid or ""
current_ap_data.quality = current_ap_data.quality or 0
current_ap_data.encryption = current_ap_data.encryption or "none"
current_ap_data.signal = current_ap_data.signal or 0
current_ap_data.mode = current_ap_data.mode or ""
current_ap_data.channel = current_ap_data.channel -- Keep as nil if not found
table.insert(results_list, current_ap_data)
end
current_ap_data = { address = cell_addr:upper() }
elseif current_ap_data then
local essid_val = line:match("^ESSID:%s*\"(.*)\"")
if not essid_val then
essid_val = line:match("^ESSID:%s*(.+)")
end
local mode_val, channel_val = line:match("^Mode:%s*(%S+)%s*Channel:%s*(%d+)")
local signal_val_dbm, quality_num_str, quality_max_str = line:match("^Signal:%s*([%-?%d]+) dBm%s*Quality:%s*(%d+)/(%d+)")
local encryption_val = line:match("^Encryption:%s*(.+)")
if essid_val then
current_ap_data.ssid = essid_val:match("^%s*(.-)%s*$")
elseif mode_val then
current_ap_data.mode = mode_val
if channel_val then
current_ap_data.channel = tonumber(channel_val)
end
elseif signal_val_dbm then
current_ap_data.signal = tonumber(signal_val_dbm)
if quality_num_str and quality_max_str then
local q_num = tonumber(quality_num_str)
local q_max = tonumber(quality_max_str)
if q_num and q_max and q_max > 0 then
current_ap_data.quality = math.floor((q_num * 100) / q_max)
elseif q_num then
current_ap_data.quality = q_num
end
end
elseif encryption_val then
current_ap_data.encryption = encryption_val:match("^%s*(.-)%s*$")
end
end
end
if current_ap_data and current_ap_data.address then
current_ap_data.ssid = current_ap_data.ssid or ""
current_ap_data.quality = current_ap_data.quality or 0
current_ap_data.encryption = current_ap_data.encryption or "none"
current_ap_data.signal = current_ap_data.signal or 0
current_ap_data.mode = current_ap_data.mode or ""
current_ap_data.channel = current_ap_data.channel
table.insert(results_list, current_ap_data)
end
for _, ap_data in ipairs(results_list) do
ap_data.ssid = ap_data.ssid or ""
-- address should always be there
ap_data.quality = ap_data.quality or 0
ap_data.encryption = ap_data.encryption or "none"
ap_data.signal = ap_data.signal or 0
ap_data.mode = ap_data.mode or ""
-- channel can be nil, or default it: ap_data.channel = ap_data.channel or 0
end
-- The original script had logic for 'excluded_ssids' and 'unique_excluding_known'.
-- This seems like business logic specific to that list, keeping it.
local excluded_ssids = {
["NittanyMtnKOA"] = true,
["NittanyMTNKOA_EXT2"] = true,
["OmnissiahsReach"] = true
}
local unique_excluding_known = 0
for _, ap_data in ipairs(results_list) do
if not excluded_ssids[ap_data.ssid] then
unique_excluding_known = unique_excluding_known + 1
end
end
return {
unique_BSSIDs = #results_list,
foreign_networks = unique_excluding_known,
results = results_list,
errCode = 0,
errMsg = "OK",
-- 'configDone = false' from original seems less relevant here,
-- but keeping it if it's an expected part of this specific endpoint's contract.
configDone = false
}
end
return wifi_handler
skyweave/request.lua
Executable
+103
View File
@@ -0,0 +1,103 @@
-- skyweave/request.lua
local json = require("json") -- Assuming json.lua is in a standard Lua path e.g. /usr/lib/lua
-- Removed local parse_query_string function, will use utils.parse_query_string
-- local function parse_query_string(query_string)
-- local params = {}
-- if not query_string or query_string == "" then return params end
--
-- for pair in query_string:gmatch("[^&]+") do
-- local key, value = pair:match("([^=]+)=?(.*)")
-- if key then
-- key = key:gsub("+", " "):gsub("%%(%x%x)", function(h) return string.char(tonumber(h, 16)) end)
-- value = value or "" -- Ensure value is a string, even if empty after '='
-- value = value:gsub("+", " "):gsub("%%(%x%x)", function(h) return string.char(tonumber(h, 16)) end)
-- params[key] = value
-- end
-- end
-- return params
-- end
local utils = require("skyweave.utils") -- Updated path
local request_module = {}
function request_module.create_request_context()
local request = {}
request.method = os.getenv("REQUEST_METHOD") or "GET" -- Default to GET if not set
local query_string_env = os.getenv("QUERY_STRING") or ""
request.query = utils.parse_query_string(query_string_env)
-- PATH_INFO is the part of the URL after the script name and before the query string.
-- e.g. /cgi-bin/skyweave.lua/some/path?foo=bar -> /some/path
-- This is dependent on Nginx configuration (e.g. using fastcgi_split_path_info).
-- If not properly set by Nginx, it might be nil or empty.
request.path = os.getenv("PATH_INFO") or "/"
if request.path == "" then request.path = "/" end
request.headers = {}
-- Populate headers using os.getenv for specific, known CGI variables
local content_type_env = os.getenv("CONTENT_TYPE") -- Use different var name to avoid conflict with request.headers.content-type
if content_type_env then request.headers["content-type"] = content_type_env end
local user_agent = os.getenv("HTTP_USER_AGENT")
if user_agent then request.headers["user-agent"] = user_agent end
local accept_header = os.getenv("HTTP_ACCEPT")
if accept_header then request.headers["accept"] = accept_header end
-- Add other common headers if needed, for example:
-- local accept_encoding = os.getenv("HTTP_ACCEPT_ENCODING")
-- if accept_encoding then request.headers["accept-encoding"] = accept_encoding end
--
-- local accept_language = os.getenv("HTTP_ACCEPT_LANGUAGE")
-- if accept_language then request.headers["accept-language"] = accept_language end
--
-- local referer = os.getenv("HTTP_REFERER")
-- if referer then request.headers["referer"] = referer end
--
-- Note: CONTENT_LENGTH is retrieved later via os.getenv("CONTENT_LENGTH") specifically for body processing.
-- It is not typically added to this general request.headers table unless other logic specifically needs it there.
request.raw_body = nil
request.body = nil
request.body_parse_error = nil
if request.method == "POST" or request.method == "PUT" or request.method == "PATCH" then
local content_length_str = os.getenv("CONTENT_LENGTH")
local content_length = tonumber(content_length_str or 0)
if content_length and content_length > 0 then
-- Removed: io.stdin:setvbuf("binary") -- Not supported/needed for JSON POST or general text POST
request.raw_body = io.stdin:read(content_length)
-- Try to parse if content type suggests JSON and JSON lib is available
local content_type = request.headers["content-type"] or ""
if json and content_type:lower():match("application/json") then
if request.raw_body and request.raw_body ~= "" then
local success, decoded_or_error = pcall(json.decode, request.raw_body)
if success then
request.body = decoded_or_error
else
request.body_parse_error = "JSON decode error: " .. tostring(decoded_or_error)
end
else
request.body_parse_error = "Empty body received with application/json Content-Type"
end
else
-- If not JSON or no JSON lib, body remains nil, raw_body has the content.
-- Handlers can inspect raw_body if they expect other content types.
if not json and content_type:lower():match("application/json") then
request.body_parse_error = "Received JSON Content-Type but no JSON library is loaded."
end
end
end
end
return request
end
return request_module
skyweave/response.lua
Executable
+44
View File
@@ -0,0 +1,44 @@
-- skyweave/response.lua
local json = require("json") -- Assuming json.lua is in a standard Lua path e.g. /usr/lib/lua
local response = {}
-- Default HTTP status messages corresponding to codes
local http_status_messages = {
[200] = "200 OK",
[201] = "201 Created",
[204] = "204 No Content",
[400] = "400 Bad Request",
[401] = "401 Unauthorized",
[403] = "403 Forbidden",
[404] = "404 Not Found",
[405] = "405 Method Not Allowed",
[500] = "500 Internal Server Error"
}
function response.json(data_table, http_status_code)
http_status_code = http_status_code or 200
local status_message = http_status_messages[http_status_code] or tostring(http_status_code)
print("Status: " .. status_message)
print("Content-Type: application/json")
print("") -- End of headers
io.stdout:write(json.encode(data_table))
io.stdout:flush()
end
function response.error(error_message, http_status_code, internal_error_code)
http_status_code = http_status_code or 500
internal_error_code = internal_error_code or -1
error_message = error_message or "Unknown error"
local status_message = http_status_messages[http_status_code] or tostring(http_status_code)
print("Status: " .. status_message)
print("Content-Type: application/json")
print("") -- End of headers
io.stdout:write(json.encode({ errCode = internal_error_code, errMsg = error_message }))
io.stdout:flush()
end
return response
skyweave/router.lua
Executable
+134
View File
@@ -0,0 +1,134 @@
-- skyweave/router.lua
local response = require("skyweave.response") -- For sending 404s, errors etc. (Path Confirmed)
local Router = {}
Router.__index = Router
function Router:new()
local instance = {
routes = {} -- Format: { ["GET:/path"] = handler_func }
}
setmetatable(instance, Router)
return instance
end
function Router:add_route(method, path_key, handler_func)
if not method or not path_key or not handler_func then
-- Handle error: log or throw, but for now, just print to stderr for debugging
io.stderr:write("Error: method, path_key, and handler_func are required to add a route.\n")
return
end
local key = method:upper() .. ":" .. path_key
self.routes[key] = handler_func
-- io.stderr:write("Route added: " .. key .. "\n") -- For debugging
end
-- This function translates the original script's query param logic
-- into a method and a conceptual path_key for routing.
local function determine_route_key_from_request(request_context)
local method = request_context.method
local query = request_context.query
local path_info = request_context.path -- From PATH_INFO CGI variable
-- 1. Prioritize PATH_INFO if it is significant (not just "/" or empty)
if path_info and path_info ~= "/" and path_info ~= "" then
-- Ensure it starts with a slash, though PATH_INFO usually does.
if path_info:sub(1,1) == "/" then
return method, path_info
else
return method, "/" .. path_info
end
end
-- 2. Fallback to query parameter based routing (original logic)
-- Based on the original dispatch logic:
-- ?get_config=X -> GET /X
-- ?set_config=X -> POST /X (assuming POST for set operations)
-- ?get_status=X -> GET /X
-- ?run_action=X -> POST /X (assuming POST for actions)
-- ?method=GET&section=X (mbox-config style) -> GET /X
if query.get_config then
return "GET", "/" .. query.get_config
elseif query.set_config then
-- Most 'set' operations imply data being sent, typically via POST.
-- If a specific 'set' needs GET (unusual), a specific route could be added.
return "POST", "/" .. query.set_config
elseif query.get_status then
return "GET", "/" .. query.get_status
elseif query.run_action then
-- Actions usually imply causing a change or process, typically POST.
return "POST", "/" .. query.run_action
elseif query.method and query.method:upper() == "GET" and query.section then
return "GET", "/" .. query.section
end
-- Fallback or error if no known action parameter is found.
-- The main skyweave.lua will likely call this. If it returns nil,
-- main script can decide to return a 400 Bad Request.
-- Alternatively, router:dispatch could handle nil path_key.
return nil, nil
end
function Router:dispatch(request_context)
if not request_context then
response.error("Internal Server Error: No request context provided to dispatcher.", 500)
return
end
local determined_method, determined_path_key = determine_route_key_from_request(request_context)
if not determined_path_key then
-- This means the query parameters didn't match any known patterns
-- from the original script's dispatch logic.
response.error("Bad Request: No valid action or endpoint specified in query parameters.", 400)
return
end
local route_lookup_key = determined_method .. ":" .. determined_path_key
-- io.stderr:write("Dispatching with key: " .. route_lookup_key .. "\n") -- For debugging
local handler_func = self.routes[route_lookup_key]
if handler_func then
local success, result = pcall(handler_func, request_context)
if not success then
-- pcall failed, 'result' contains the error message/object
response.error("Handler Error: " .. tostring(result), 500)
else
-- Handler executed successfully, 'result' is the return value
if type(result) == "table" and result.async == true and result.command and result.response then
-- Asynchronous task pattern
response.json(result.response, 202) -- 202 Accepted
-- Ensure the command is not nil or empty before executing
if result.command and result.command ~= "" then
local bg_command = "(sleep 2; " .. result.command .. ") >/dev/null 2>&1 &"
os.execute(bg_command)
else
io.stderr:write("Async task error: Empty or nil command provided.\n")
-- Optionally, could update client if an error system for async tasks exists.
end
elseif type(result) == "table" and result.errCode then
-- Handler returned a structured error (common in original script)
response.json(result, result.http_status_code or 400) -- Use provided http_status_code or default to 400
elseif type(result) == "table" then
-- Standard synchronous JSON response
response.json(result, 200)
elseif result == nil then
-- Handler returned nil, could mean 204 No Content or an unhandled case.
-- For now, let's assume it's a deliberate No Content.
response.json({}, 204)
else
-- Handler returned something unexpected (e.g. a string directly)
-- This case might need refinement based on actual handler practices.
response.error("Handler returned unexpected data type: " .. type(result), 500)
end
end
else
response.error("Endpoint Not Found: No handler for " .. determined_method .. " " .. determined_path_key, 404)
end
end
return Router
skyweave/utils.lua
Executable
+254
View File
@@ -0,0 +1,254 @@
-- skyweave/utils.lua
local json = require("json") -- Assuming json.lua is in a standard Lua path e.g. /usr/lib/lua
-- The json variable will be nil if 'json' module is not found.
-- Functions using json (like get_live_interface_info) should handle cases where json is nil.
local utils = {}
-- Moved from original main script / request.lua
function utils.parse_query_string(query_string)
local params = {}
if not query_string or query_string == "" then return params end
for pair in query_string:gmatch("[^&]+") do
local key, value = pair:match("([^=]+)=?(.*)")
if key then
key = key:gsub("+", " "):gsub("%%(%x%x)", function(h) return string.char(tonumber(h, 16)) end)
value = value or "" -- Ensure value is a string, even if empty after '='
value = value:gsub("+", " "):gsub("%%(%x%x)", function(h) return string.char(tonumber(h, 16)) end)
params[key] = value
end
end
return params
end
-- Moved from original main script
function utils.execute_command(command)
local file = io.popen(command, "r")
if not file then return nil, "popen failed for command: " .. command end
local output = file:read("*a")
local status = file:close()
-- io.popen returns a file handle or nil on error.
-- file:close() returns true, nil + error message + error number, or nil + exit status for commands.
-- We are interested if the command itself was successful (usually exit code 0)
-- For simplicity, just returning output. Robust error handling would check status.
return output
end
-- Moved from original main script
function utils.uci_run(command_str)
-- Consider adding error checking or return status if needed for os.execute
os.execute(command_str)
end
-- Moved from original main script
function utils.uci_get(path)
if not path or path == "" then return nil end
-- Sanitize path to prevent command injection if it's ever constructed from unsafe input.
-- For now, assuming path is internally generated and safe.
local f = io.popen("uci get " .. path .. " 2>/dev/null")
if f then
local value = f:read("*a")
f:close()
if value then
value = value:match("^%s*(.-)%s*$") -- Trim whitespace
if value ~= "" then
return value
end
end
end
return nil
end
-- Moved from original main script
function utils.calculate_sha256(input_string)
if not input_string then return nil end
-- Escape single quotes for safe use with echo -n 'string'
local sanitized_string = input_string:gsub("'", "'\\''")
local command = "echo -n '" .. sanitized_string .. "' | sha256sum"
local handle = io.popen(command)
if not handle then return nil end
local hash_line = handle:read("*a")
handle:close()
if hash_line then
local hash = hash_line:match("^([a-f0-9]+)") -- sha256sum output is "hash -"
return hash
end
return nil
end
-- From original main script (dependency for parse_log_line)
local months_map = {
Jan="01", Feb="02", Mar="03", Apr="04", May="05", Jun="06",
Jul="07", Aug="08", Sep="09", Oct="10", Nov="11", Dec="12"
}
-- Moved from original main script
function utils.parse_log_line(raw_line)
local entry = {
timestamp_str = "",
datetime_obj = nil, -- Will be YYYY-MM-DDTHH:MM:SS string
facility_level = "",
process_name = nil,
pid = nil,
message = "",
kernel_timestamp = nil,
raw_log = raw_line,
log_hash = utils.calculate_sha256(raw_line), -- Uses self.calculate_sha256
parse_error = nil
}
local ts_dayname, ts_mon, ts_day, ts_time, ts_year, fac_lvl, proc_tag, msg_body =
raw_line:match("^(%a+)%s+(%a+)%s+(%d+)%s+(%d%d:%d%d:%d%d)%s+(%d%d%d%d)%s+([%w%.%-]+)%s*([^:]+):%s*(.*)$")
if ts_year then
entry.timestamp_str = string.format("%s %s %s %s %s", ts_dayname, ts_mon, ts_day, ts_time, ts_year)
local month_num = months_map[ts_mon]
if month_num then
entry.datetime_obj = string.format("%s-%s-%02dT%s", ts_year, month_num, tonumber(ts_day), ts_time)
end
entry.facility_level = fac_lvl
entry.message = msg_body
local proc_name_only, pid_val = proc_tag:match("([^%[]+)%[(%d+)%]")
if proc_name_only and pid_val then
entry.process_name = proc_name_only
entry.pid = tonumber(pid_val)
else
entry.process_name = proc_tag:match("^%s*(.-)%s*$")
end
else
local kern_ts, kern_msg = raw_line:match("^%[%s*(%d+%.?%d*)%s*%]%s*(.*)$")
if kern_ts then
entry.kernel_timestamp = tonumber(kern_ts)
entry.message = kern_msg
entry.facility_level = "kernel.None"
entry.process_name = "kernel"
else
entry.message = raw_line
entry.parse_error = "Unknown log format"
end
end
return entry
end
-- Moved from original main script
function utils.get_live_interface_info(interface_name)
if not interface_name then return nil end
if not json then
-- Or return an error structure indicating JSON lib is missing
return nil, nil, nil, nil, "JSON library not available for get_live_interface_info"
end
local command = "ubus call network.interface." .. interface_name .. " status"
local output = utils.execute_command(command) -- Uses self.execute_command
if not output or output == "" then
return nil -- No output means no IP address found
end
local success, status_data = pcall(json.decode, output)
if success and status_data and status_data["ipv4-address"] and #status_data["ipv4-address"] > 0 then
local ipv4_info = status_data["ipv4-address"][1]
local device = status_data["device"]
local leasetime = status_data["data"] and status_data["data"]["leasetime"] -- Check if data and leasetime exist
return ipv4_info.address, ipv4_info.mask, device, leasetime
elseif not success then
-- Optionally, return the error message from json.decode
return nil, nil, nil, nil, "JSON decode error: " .. tostring(status_data) -- status_data is error msg on pcall failure
end
return nil
end
-- Moved from original main script
function utils.get_live_dns_servers_from_resolv(logical_interface_name)
local dns_servers = {}
local search_domains = {}
-- Ensure logical_interface_name is somewhat safe before using in string matching,
-- though it's typically from internal config.
if not logical_interface_name or not logical_interface_name:match("^[a-zA-Z0-9_%-]+$") then
return dns_servers, search_domains -- Invalid interface name format
end
local file = io.open("/tmp/resolv.conf.auto", "r")
if not file then return dns_servers, search_domains end
local in_target_section = false
local section_start_pattern_str = "# Interface " .. logical_interface_name
for line in file:lines() do
if not in_target_section then
if line:match("^%s*" .. section_start_pattern_str:gsub("%%", "%%%%") .. "%s*$") then -- Escape % for string pattern
in_target_section = true
end
else
if line:match("^%s*# Interface ") and not line:match("^%s*" .. section_start_pattern_str:gsub("%%", "%%%%") .. "%s*$") then
break
end
local ip = line:match("^%s*nameserver%s+([%d%.]+)")
if ip then table.insert(dns_servers, ip) end
local domain_list_str = line:match("^%s*search%s+(.+)")
if domain_list_str then
for domain in domain_list_str:gmatch("[^%s]+") do
table.insert(search_domains, domain)
end
end
end
end
file:close()
return dns_servers, search_domains
end
-- Moved from original main script
function utils.get_default_gateway_from_route()
local file = io.open("/proc/net/route", "r")
if not file then return nil, nil end
local gateway_ip = nil
local interface_name = nil
file:read("*l") -- Skip header
for line in file:lines() do
local iface, dest, gw_hex, flags_hex = line:match("^(%S+)%s+(%S+)%s+(%S+)%s+(%S+)")
if iface and dest and gw_hex and flags_hex then
if dest == "00000000" and gw_hex ~= "00000000" then
local flags_num = tonumber(flags_hex, 16)
-- UG flags (Up and Gateway). Typically 0x3 (binary 11) or 0x1 (binary 01 if not gateway but up)
-- We need bit 1 (value 2 for gateway) to be set.
if flags_num and math.floor(flags_num / 2) % 2 == 1 then -- Checks if the 'Gateway' bit (0x2) is set
-- Lua 5.1 doesn't have bitwise ops directly.
-- (flags_num & 2) ~= 0 is equivalent to checking if the second bit is set.
-- For example, if flags_num = 3 (0011), floor(3/2)%2 = 1%2 = 1. Correct.
-- If flags_num = 1 (0001), floor(1/2)%2 = 0%2 = 0. Correct.
-- If flags_num = 7 (0111), floor(7/2)%2 = 3%2 = 1. Correct.
-- Ensure gw_hex is 8 characters long for safety
if #gw_hex == 8 then
-- Corrected parsing for little-endian hex IP from /proc/net/route
local o4 = tonumber(string.sub(gw_hex, 1, 2), 16)
local o3 = tonumber(string.sub(gw_hex, 3, 4), 16)
local o2 = tonumber(string.sub(gw_hex, 5, 6), 16)
local o1 = tonumber(string.sub(gw_hex, 7, 8), 16)
if o1 and o2 and o3 and o4 then
gateway_ip = string.format("%d.%d.%d.%d", o4, o3, o2, o1)
interface_name = iface
break
end
end
end
end
end
end
file:close()
return gateway_ip, interface_name
end
return utils
skyweave_deploy.sh
Executable
+110
View File
@@ -0,0 +1,110 @@
#!/bin/bash
# skyweave_deploy.sh - Deploy Skyweave API framework
# --- Repository and Local Paths ---
LOCAL_REPO_ROOT="."
LOCAL_CGI_SCRIPT_RELPATH="cgi_scripts/skyweave.lua"
LOCAL_SKYWEAVE_MODULE_DIR_RELPATH="skyweave"
LOCAL_JSON_LIB_RELPATH="lib/json.lua"
# --- Remote Target Paths ---
REMOTE_BASE_DIR="/usr/lib/lua"
REMOTE_CGI_SCRIPT="/www/cgi-bin/skyweave.lua"
REMOTE_SKYWEAVE_MODULE_DIR="${REMOTE_BASE_DIR}/skyweave"
REMOTE_JSON_LIB="${REMOTE_BASE_DIR}/json.lua"
REMOTE_CGI_DIR="/www/cgi-bin"
# --- User-configurable settings ---
SSH_ALIAS="roof-unit"
ROOF_IP="192.168.10.254"
REMOTE_HTTP_PORT="${1:-42069}" # Use first script arg for port, or default
SCP_FLAG_O="-O -o LogLevel=ERROR" # For legacy SCP mode if needed by server
# Colors
GREEN='\033[0;32m'; RED='\033[0;31m'; YELLOW='\033[0;33m'; NC='\033[0m'
echo -e "${YELLOW}Starting Skyweave framework deployment to ${SSH_ALIAS}...${NC}"
echo -e "${YELLOW}(Ensure '${SSH_ALIAS}' is correctly configured in your ~/.ssh/config)${NC}"
echo ""
# === 1. Check Local Source Files and Directories ===
echo -e "${YELLOW}Checking local source files and directories...${NC}"
if [ ! -f "${LOCAL_REPO_ROOT}/${LOCAL_CGI_SCRIPT_RELPATH}" ]; then
echo -e "${RED}Error: Local CGI script ${LOCAL_REPO_ROOT}/${LOCAL_CGI_SCRIPT_RELPATH} not found!${NC}"
exit 1
fi
if [ ! -d "${LOCAL_REPO_ROOT}/${LOCAL_SKYWEAVE_MODULE_DIR_RELPATH}" ]; then
echo -e "${RED}Error: Local Skyweave module directory ${LOCAL_REPO_ROOT}/${LOCAL_SKYWEAVE_MODULE_DIR_RELPATH} not found!${NC}"
exit 1
fi
if [ ! -f "${LOCAL_REPO_ROOT}/${LOCAL_JSON_LIB_RELPATH}" ]; then
echo -e "${RED}Error: Local json.lua library ${LOCAL_REPO_ROOT}/${LOCAL_JSON_LIB_RELPATH} not found!${NC}"
exit 1
fi
echo -e "${GREEN}Local files and directories found.${NC}"
echo ""
# === 2. Create Remote Directories ===
echo -e "${YELLOW}Creating remote directories...${NC}"
ssh -q ${SSH_ALIAS} "mkdir -p ${REMOTE_SKYWEAVE_MODULE_DIR}/handlers ${REMOTE_CGI_DIR}"
if [ $? -ne 0 ]; then
echo -e "${RED}Error: Failed to create remote directories on ${SSH_ALIAS}!${NC}"
exit 1
fi
echo -e "${GREEN}Remote directories ensured.${NC}"
echo ""
# === 3. Deploy Files ===
echo -e "${YELLOW}Deploying json.lua library...${NC}"
scp ${SCP_FLAG_O} "${LOCAL_REPO_ROOT}/${LOCAL_JSON_LIB_RELPATH}" "${SSH_ALIAS}:${REMOTE_JSON_LIB}"
if [ $? -ne 0 ]; then echo -e "${RED}Error: Failed to copy json.lua to ${SSH_ALIAS}!${NC}"; exit 1; fi
echo -e "${GREEN}json.lua deployed.${NC}"
echo ""
echo -e "${YELLOW}Deploying Skyweave module directory (${LOCAL_SKYWEAVE_MODULE_DIR_RELPATH})...${NC}"
scp ${SCP_FLAG_O} -r "${LOCAL_REPO_ROOT}/${LOCAL_SKYWEAVE_MODULE_DIR_RELPATH}/." "${SSH_ALIAS}:${REMOTE_SKYWEAVE_MODULE_DIR}/"
if [ $? -ne 0 ]; then echo -e "${RED}Error: Failed to copy Skyweave module directory to ${SSH_ALIAS}!${NC}"; exit 1; fi
echo -e "${GREEN}Skyweave module directory deployed.${NC}"
echo ""
echo -e "${YELLOW}Deploying main CGI script (${LOCAL_CGI_SCRIPT_RELPATH})...${NC}"
scp ${SCP_FLAG_O} "${LOCAL_REPO_ROOT}/${LOCAL_CGI_SCRIPT_RELPATH}" "${SSH_ALIAS}:${REMOTE_CGI_SCRIPT}"
if [ $? -ne 0 ]; then echo -e "${RED}Error: Failed to copy CGI script to ${SSH_ALIAS}!${NC}"; exit 1; fi
echo -e "${GREEN}Main CGI script deployed.${NC}"
echo ""
# === 4. Set Permissions on Remote Files ===
echo -e "${YELLOW}Setting permissions on remote files...${NC}"
CGI_CHMOD_FAILED=0
ssh -q ${SSH_ALIAS} "chmod +x ${REMOTE_CGI_SCRIPT}" || CGI_CHMOD_FAILED=1
ssh -q ${SSH_ALIAS} "chmod 644 ${REMOTE_JSON_LIB}" || echo -e "${YELLOW}Warning: chmod failed for ${REMOTE_JSON_LIB}.${NC}"
ssh -q ${SSH_ALIAS} "find ${REMOTE_SKYWEAVE_MODULE_DIR} -type d -exec chmod 755 {} \;" || echo -e "${YELLOW}Warning: chmod failed for module dirs in ${REMOTE_SKYWEAVE_MODULE_DIR}.${NC}"
ssh -q ${SSH_ALIAS} "find ${REMOTE_SKYWEAVE_MODULE_DIR} -type f -exec chmod 644 {} \;" || echo -e "${YELLOW}Warning: chmod failed for module files in ${REMOTE_SKYWEAVE_MODULE_DIR}.${NC}"
if [ "$CGI_CHMOD_FAILED" = "1" ]; then
echo -e "${RED}Critical permission setting for CGI script failed. Deployment may not be functional.${NC}"
exit 1
fi
echo -e "${GREEN}Remote permissions set.${NC}"
echo ""
# === 5. Test Deployed API ===
echo -e "${GREEN}All deployment and permission operations complete for ${SSH_ALIAS}!${NC}"
echo "" # Add a newline for spacing before API test
echo -e "${YELLOW}Testing API via http://${ROOF_IP}:${REMOTE_HTTP_PORT}...${NC}"
API_TEST_URL="http://${ROOF_IP}:${REMOTE_HTTP_PORT}/cgi-bin/skyweave.lua?get_config=network_config"
RESPONSE=$(curl -s -X GET "${API_TEST_URL}")
if [ $? -eq 0 ] && [[ "${RESPONSE}" == *'"errCode":0'* ]]; then
echo -e "${GREEN}API test successful!${NC}"
echo -e "Response: ${RESPONSE}"
else
echo -e "${RED}API test failed!${NC}"
echo -e "Curl exit status for ${API_TEST_URL}: $?"
echo -e "Response: ${RESPONSE}"
fi
echo -e "\n${YELLOW}API endpoint: http://${ROOF_IP}:${REMOTE_HTTP_PORT}/cgi-bin/skyweave.lua${NC}"
echo -e "${YELLOW}Example usage: curl -X POST -H \"Content-Type: application/json\" -d '{\"ssid\":\"MyNetwork\",\"key\":\"MyPassword\",\"encryption\":\"psk2\"}' http://${ROOF_IP}:${REMOTE_HTTP_PORT}/cgi-bin/skyweave.lua?set_config=connect_wifi${NC}"
echo ""
echo -e "${GREEN}Deployment script finished.${NC}"