tAdd zuper as part of arm-sdk repo. - arm-sdk - os build toolkit for various embedded devices
HTML git clone https://git.parazyd.org/arm-sdk
DIR Log
DIR Files
DIR Refs
DIR Submodules
DIR README
DIR LICENSE
---
DIR commit 5c4f4428d944b04cc5c15d14bbc2c2badc531a80
DIR parent 947b17ad388e5d6230097e61769ce3e5166029ba
HTML Author: parazyd <parazyd@dyne.org>
Date: Wed, 23 Dec 2020 09:17:02 +0100
Add zuper as part of arm-sdk repo.
Diffstat:
A lib/zuper/COPYING.txt | 674 +++++++++++++++++++++++++++++++
A lib/zuper/Makefile | 10 ++++++++++
A lib/zuper/README.md | 149 +++++++++++++++++++++++++++++++
A lib/zuper/zuper | 1099 +++++++++++++++++++++++++++++++
A lib/zuper/zuper.init | 39 +++++++++++++++++++++++++++++++
5 files changed, 1971 insertions(+), 0 deletions(-)
---
DIR diff --git a/lib/zuper/COPYING.txt b/lib/zuper/COPYING.txt
t@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://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
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
DIR diff --git a/lib/zuper/Makefile b/lib/zuper/Makefile
t@@ -0,0 +1,10 @@
+DESTDIR?=
+PREFIX?=/usr
+
+all:
+ @echo "Nothing to be make. Make install to ${DESTDIR}${PREFIX}/share/zuper"
+
+install:
+ install -d ${DESTDIR}${PREFIX}/share/zuper
+ install -p -m 644 zuper ${DESTDIR}${PREFIX}/share/zuper/zuper
+ install -p -m 644 zuper.init ${DESTDIR}${PREFIX}/share/zuper/zuper.init
DIR diff --git a/lib/zuper/README.md b/lib/zuper/README.md
t@@ -0,0 +1,149 @@
+```
+ _ _ _ _ _
+(_)(_)(_)(_)(_)
+ _(_)_ _ _ _ _ _ _ _ _ _ _ _ _
+ _(_) (_) (_) (_)(_)(_)(_)_ (_)(_)(_)(_)(_)_ _ (_)(_)
+ _(_) (_) (_) (_) (_(_) _ _ _ (_)(_)(_)
+ _(_) (_) (_) (_) (_(_)(_)(_)(_)(_)(_)
+ _ (_) _ _ (_)_ _ _(_)_(_) _ _ _(_(_)_ _ _ _ (_)
+(_)(_)(_)(_)(_)(_)(_)(_) (_(_)(_)(_)(_) (_)(_)(_)(_) (_)
+ (_)
+ (_)
+```
+
+**Z**sh **U**ltimate **P**rogrammer's **E**xtensions **R**efurbished
+
+# Introduction
+
+Zuper is a minimalist library of extensions for Zsh programming,
+because believe it or not Zsh is so slick and powerful that it can be
+used as a programming language.
+
+# Features
+
+ - key/value store on files mapped to associative arrays
+ - consul k/v integration using native get/set over ztcp
+ - nifty messaging using colors and intl support (gettext)
+ - procedural flow debugging functions and variable monitor
+ - clean exit and destructors registration
+ - improved temp file handling
+ - more to come...
+
+# Requirements
+
+Zuper requires the following programs to be installed:
+
+```
+zsh curl sed awk hexdump
+```
+
+# Usage
+
+Documentation is still lacking, however to use Zuper in Zsh scripts
+one must first source its main library `zuper`, then declare global
+variables and arrays, then source `zuper.init` and at the end of the
+program call `endgame` for a clean exit. Example test program:
+
+```zsh
+#!/usr/bin/env zsh
+
+# switch on debugging output
+DEBUG=1
+
+# switch logging into test.log
+LOG=test.log
+
+##### INIT
+# load our zuper library
+source zuper
+# declare a custom global variable
+vars+=(myvar)
+# assign a default value to our global variable
+myvar=${myvar:-ok}
+# declare a global associative map
+maps+=(mymap)
+# conclude the init phase
+source zuper.init
+#####
+
+# register the zdump debug function to be executed on exit
+destruens+=(zdump)
+
+
+# declare a custom function to print it out
+testfun() {
+ # register the function in the debug flow
+ fn "testfun"
+ # print out with nice green colors
+ notice "Custom var: $myvar"
+ # create a tempfile
+ ztmp && mytmp=$ztmpfile
+ # put the value into the tempfile
+ print $myvar >> $mytmp
+ # print out the path to the tempfile
+ act "Temp file: $mytmp"
+ # print out the contents of the tempfile
+ act "Content: `cat $mytmp`"
+ # the tempfile will be deleted in endgame()
+ # but can also be delete earlier here, optionally
+}
+
+
+# call our custom function
+testfun
+
+# we use words and their md5
+mymap=(
+ lorem f737a087bca81f69a6048ec744c73e41
+ ipsum 02063b9bf9d6e15ad61226fa4584aae0
+ dolor 5f20730ddc7a1fedbf265358f0ce4f26
+)
+
+# save the map into a file
+zkv.save mymap test.map
+
+# free the map
+mymap=()
+
+# re-declare the map
+typeset -A mymap
+# re-load saved contents
+zkv.load test.map
+# dump contents
+for i in ${(k)mymap}; do
+ print "$i \t ${mymap[$i]}"
+done
+
+# end of the program (will call destructors)
+```
+
+
+# Deployment
+
+Here we reference applications where zuper is used succesfully:
+
+ - Devuan Simple Development Toolkit https://git.devuan.org/groups/sdk
+ - Dowse IoT awareness OS http://dyne.org/software/dowse
+ - Jaro Mail terminal email http://dyne.org/software/jaro-mail
+
+If you use it, let us know! http://dyne.org/contact
+
+# License
+
+Zuper is designed, developed and maintained by Denis Roio <jaromil@dyne.org>
+
+Zuper is Copyright (C) 2015 by the Dyne.org foundation
+
+This source code is free software; you can redistribute it and/or
+modify it under the terms of the GNU Public License as published by
+the Free Software Foundation; either version 3 of the License, or (at
+your option) any later version.
+
+This source code 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. Please refer to
+the GNU Public License for more details.
+
+You should have received a copy of the GNU Public License along with
+this source code; if not, write to: Free Software Foundation, Inc.,
+675 Mass Ave, Cambridge, MA 02139, USA.
DIR diff --git a/lib/zuper/zuper b/lib/zuper/zuper
t@@ -0,0 +1,1099 @@
+#!/usr/bin/env zsh
+## -*- origami-fold-style: triple-braces -*-
+#
+# Zuper - Zsh Ultimate Programmer's Extensions Refurbished
+#
+# Copyright (C) 2015 Dyne.org Foundation
+#
+# Zuper is designed, written and maintained by Denis Roio <jaromil@dyne.org>
+#
+# This source code is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This source code 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.
+# Please refer to the GNU Public License for more details.
+#
+# You should have received a copy of the GNU Public License along with
+# this source code; if not, write to:
+# Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+
+if [[ ! -z ${zuper_version} ]]; then
+ warning "zuper version ::1 version:: was already loaded -- doing nothing" ${zuper_version}
+ return;
+fi
+
+
+##########################
+typeset -aU vars
+typeset -aU arrs
+typeset -aU maps
+
+typeset -aU funs
+
+vars=(DEBUG QUIET LOG)
+arrs=(req freq)
+
+vars+=(zuper_version)
+zuper_version=0.4
+
+# load necessary zsh extensions
+zmodload zsh/regex
+zmodload zsh/system
+zmodload zsh/net/tcp
+zmodload zsh/mapfile
+
+# {{{ Messaging
+
+# Messaging function with pretty coloring
+autoload colors
+colors
+
+vars+=(last_act last_func last_notice)
+
+function _msg() {
+ local msg="$2"
+ local i
+ command -v gettext 1>/dev/null 2>/dev/null && msg="$(gettext -s "$2")"
+ for i in {3..${#}}; do
+ msg=${(S)msg//::$(($i - 2))*::/$*[$i]}
+ done
+
+ local command="print -P"
+ local progname="$fg[magenta]${PROGRAM##*/}$reset_color"
+ local message="$fg_bold[normal]$fg_no_bold[normal]$msg$reset_color"
+ local -i returncode
+
+ case "$1" in
+ inline)
+ command+=" -n"; pchars=" > "; pcolor="yellow"
+ ;;
+ message)
+ last_act="$msg"
+ pchars=" . "; pcolor="white"; message="$fg_no_bold[$pcolor]$msg$reset_color"
+ ;;
+ verbose)
+ last_func="$msg"
+ pchars="[D]"; pcolor="blue"
+ ;;
+ success)
+ last_notice="$msg"
+ pchars="(*)"; pcolor="green"; message="$fg_no_bold[$pcolor]$msg$reset_color"
+ ;;
+ warning)
+ pchars="[W]"; pcolor="yellow"; message="$fg_no_bold[$pcolor]$msg$reset_color"
+ ;;
+ failure)
+ pchars="[E]"; pcolor="red"; message="$fg_no_bold[$pcolor]$msg$reset_color"
+ returncode=1
+ ;;
+ print)
+ progname=""
+ ;;
+ *)
+ pchars="[F]"; pcolor="red"
+ message="Developer oops! Usage: _msg MESSAGE_TYPE \"MESSAGE_CONTENT\""
+ returncode=127
+ zerr
+ ;;
+ esac
+ ${=command} "${progname} $fg_bold[$pcolor]$pchars$reset_color ${message}$color[reset_color]" >&2
+
+ # write the log if its configured
+ [[ "$LOG" = "" ]] || {
+ touch $LOG || return $?
+ ${=command} "${progname} $fg_bold[$pcolor]$pchars$reset_color ${message}$color[reset_color]" >> $LOG
+ }
+
+ return $returncode
+}
+
+function _message say act() {
+ local notice="message"
+ [[ "$1" = "-n" ]] && shift && notice="inline"
+ [[ $QUIET = 1 ]] || _msg "$notice" $@
+ return 0
+}
+
+function _verbose xxx func() {
+ [[ $DEBUG = 1 ]] && _msg verbose $@
+ return 0
+}
+
+function _success yes notice() {
+ [[ $QUIET = 1 ]] || _msg success $@
+ return 0
+}
+
+function _warning no warn warning() {
+ [[ $QUIET = 1 ]] || _msg warning $@
+ return 0
+}
+
+function _failure fatal die error() {
+ # typeset -i exitcode=${exitv:-1}
+ [[ $QUIET = 1 ]] || _msg failure $@
+ return 1
+}
+
+function _print() {
+ [[ $QUIET = 1 ]] || _msg print $@
+ return 0
+}
+
+# }}} Messaging
+
+# {{{ Debugging
+
+fn() {
+ fun="$@"
+ req=()
+ freq=()
+ func "$fun"
+}
+
+zerr() {
+ error "error in: ${fun:-$last_notice}"
+ [[ "$last_func" = "" ]] || warn "called in: $last_func"
+ [[ "$last_act" = "" ]] || warn "called in: $last_act"
+ [[ "$last_notice" = "" ]] || warn "called in: $last_notice"
+ # [[ "$fun" = "" ]] || warn "called in: $fun"
+ TRAPEXIT() {
+ error "error reported, operation aborted."
+ }
+ return 1
+}
+
+
+function ckreq reqck() {
+ err=0
+ for v in $req; do
+ [[ "${(P)v}" = "" ]] && {
+ warn "${fun[(ws: :)1]}(): required setting is blank: $v"
+ err=1
+ }
+ done
+
+ [[ $err = 1 ]] && return $err
+
+ for f in $freq; do
+ # exists and has size greater than zero
+ [[ -s $f ]] || {
+ warn "required file empty: $f"
+ err=1
+ }
+ done
+ [[ $err == 1 ]] && zerr
+ return $err
+}
+
+# dump all variables, arrays and maps declared as global in zuper
+# do not print out what is empty
+zdump() {
+ fn zdump
+ [[ ${#vars} -gt 0 ]] && {
+ print "Global variables:"
+ for _v in $vars; do
+ _c=${(P)_v}
+ [[ "$_c" = "" ]] ||
+ print " $_v = \t $_c"
+ done
+ }
+ [[ ${#arrs} -gt 0 ]] && {
+ print "Global arrays:"
+ for _a in $arrs; do
+ _c=${(P)_a}
+ [[ "$_c" = "" ]] ||
+ print " $_a \t ( ${(P)_a} )"
+ done
+ }
+ [[ ${#maps} -gt 0 ]] && {
+ print "Global maps:"
+ for _m in $maps; do
+ [[ "${(Pv)_m}" = "" ]] || {
+ print " $_m [key] \t ( ${(Pk)_m} )"
+ print " $_m [val] \t ( ${(Pv)_m} )"
+ }
+ done
+ }
+}
+
+# handy wrappers for throw/catch execution of blocks where we need the
+# program to exit on any error (non-zero) returned by any function
+throw() { function TRAPZERR() { zerr; return 1 } }
+catch() { function TRAPZERR() { } }
+
+##########################
+# Endgame handling
+
+arrs+=(destruens)
+
+# Trap functions for the endgame event
+# TRAPINT() { endgame INT; return $? }
+# TRAPEXIT() { endgame EXIT; return $? }
+TRAPHUP() { endgame HUP; return $? }
+TRAPQUIT() { endgame QUIT; return $? }
+TRAPABRT() { endgame ABORT; return $? }
+TRAPKILL() { endgame KILL; return $? }
+# TRAPPIPE() { endgame PIPE; return $? }
+TRAPTERM() { endgame TERM; return $? }
+TRAPSTOP() { endgame STOP; return $? }
+# TRAPZERR() { func "function returns non-zero." }
+
+
+funs+=(__test_fn)
+
+__test_fn(){
+ echo "foo"
+}
+
+function zuper_end endgame() {
+ fn "endgame $*"
+
+ # execute all no matter what
+ TRAPZERR() { }
+
+ # process registered destructors
+ for d in $destruens; do
+ fn "destructor: $d"
+ $d
+ done
+
+ # unset all the variables included in "vars"
+ for v in $vars; do
+ unset $v
+ done
+
+ # unset all the assoc-arrays included in "arrs"
+ for a in $arrs; do
+ unset $a
+ done
+
+ # unset all the maps included in "maps"
+ for m in $maps; do
+ unset $m
+ done
+
+ ## We should also undefine the core zuper functions to make it
+ ## really idempotent. I have added an array "funs" which contains
+ ## the names of the functions to be undefined by endgame/zuper_end
+ ## FIXME!!!! The only "registered" function so far is __test_fn,
+ ## but if we like this we should register all the core zuper
+ ## functions as soon as they are declared
+ for f in $funs; do
+ unfunction $f
+ done
+ unset maps
+ unset arrs
+ unset vars
+ unset funs
+
+ return 0
+}
+
+## This function should reinitialise zuper and all the variables
+# zuper_restart(){
+# endgame
+# source zuper
+# }
+
+
+# Use this to make sure endgame() is called at exit.
+# unlike TRAPEXIT, the zshexit() hook is not called when functions exit.
+function zuper.exit zshexit() { endgame EXIT; return $? }
+
+# }}} Debugging
+
+# {{{ Tempfiles
+
+##########################
+# Temp file handling
+
+vars+=(ztmpfile)
+# ztmp() fills in $ztmpfile global. Caller must copy that variable as
+# it will be overwritten at every call.
+ztmp() {
+ fn ztmp
+
+ ztmpfile=`mktemp`
+ tmpfiles+=($ztmpfile)
+}
+
+vars+=(ztmpdir)
+# ztmpd() fills in $ztmpdir global. Caller must copy that variable as
+# it will be overwritten at every call.
+
+ztmpd() {
+ fn ztmpd
+
+ ztmpdir=`mktemp -d`
+ tmpdirs+=($ztmpdir)
+}
+
+# All tempfiles are freed in endgame()
+_ztmp_destructor() {
+ fn _ztmp_destructor
+
+ for f in $tmpfiles; do
+ rm -f "$f"
+ done
+ for d in $tmpdirs; do
+ [[ $d == "" || ! -d $d ]] && continue
+ pushd $d
+ [[ `pwd` == "/" ]] && {popd; continue}
+ popd
+ rm -rf "$d"
+ done
+
+ tmpfiles=()
+ tmpdirs=()
+}
+
+arrs+=(tmpfiles)
+arrs+=(tmpdirs)
+destruens+=(_ztmp_destructor)
+
+# }}} Tempfiles
+
+# {{{ Strings
+
+# tokenizer, works only with one char length delimiters
+# saves everything in global array tok=()
+arrs+=(tok)
+function string.strtok strtok() {
+ fn "strtok $*"
+ _string="$1"
+ _delim="$2"
+ req=(_string _delim)
+ ckreq || return $?
+
+ tok=()
+ f=0
+ c=0
+ for c in {1..${#_string}}; do
+ if [[ "${_string[(e)$c]}" == "$_delim" ]]; then
+ # check if not empty
+ t="${_string[(e)$(($f + 1)),$(($c - 1))]}"
+ if [[ "$t" == "" ]]; then
+ tok+=("null")
+ else
+ tok+=("$t")
+ fi
+ # save last found
+ f=$c
+ fi
+ done
+ # add last token
+ t=${_string[(e)$(($f + 1)),$c]}
+ if [[ "$t" == "" ]]; then
+ tok+=("null")
+ else
+ tok+=("$t")
+ fi
+}
+
+# remote leading and trailing spaces in a string taken from stdin
+function string.trim trim() {
+ sed -e 's/^[[:space:]]*//g ; s/[[:space:]]*\$//g'
+}
+
+# extract all emails found in a text from stdin
+# outputs them one per line
+function string.extract_emails extract_emails() {
+ awk '{ for (i=1;i<=NF;i++)
+ if ( $i ~ /[[:alnum:]]@[[:alnum:]]/ ) {
+ gsub(/<|>|,/ , "" , $i); print $i } }'
+}
+
+# takes a string as argument, returns success if is an email
+function string.isemail isemail() {
+ [[ "$1" =~ "\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,6}\b" ]] && return 0
+ # print "$1" | grep -q -E '[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,6}' && return 0
+ return 1
+}
+
+# takes a numeric argument and prints out a human readable size
+function string.human_size human_size() {
+ [[ $1 -gt 0 ]] || {
+ error "human_size() called with invalid argument"
+ return 1
+ }
+
+ # we use the binary operation for speed
+ # shift right 10 is divide by 1024
+
+ # gigabytes
+ [[ $1 -gt 1073741824 ]] && {
+ print -n "$(( $1 >> 30 )) GB"
+ return 0
+ }
+
+ # megabytes
+ [[ $1 -gt 1048576 ]] && {
+ print -n "$(( $1 >> 20 )) MB"
+ return 0
+ }
+ # kilobytes
+ [[ $1 -gt 1024 ]] && {
+ print -n "$(( $1 >> 10 )) KB"
+ return 0
+ }
+ # bytes
+ print -n "$1 Bytes"
+ return 0
+}
+
+
+# strips out all html/xml tags (everything between < >)
+function string.html_strip xml_strip html_strip() { sed 's/<[^>]\+>//g' }
+
+# changes stdin string special chars to be shown in html
+function string.escape_html escape_html() {
+ sed -e '
+s/\&/\&/g
+s/>/\>/g
+s/</\</g
+s/"/\"/g
+'
+}
+
+# escapes special chars in urls
+function string.decode_url decode_url urldecode() {
+ sed -e '
+s/%25/%/gi
+s/%20/ /gi
+s/%09/ /gi
+s/%21/!/gi
+s/%22/"/gi
+s/%23/#/gi
+s/%24/\$/gi
+s/%26/\&/gi
+s/%27/'\''/gi
+s/%28/(/gi
+s/%29/)/gi
+s/%2a/\*/gi
+s/%2b/+/gi
+s/%2c/,/gi
+s/%2d/-/gi
+s/%2e/\./gi
+s/%2f/\//gi
+s/%3a/:/gi
+s/%3b/;/gi
+s/%3d/=/gi
+s/%3e//gi
+s/%3f/?/gi
+s/%40/@/gi
+s/%5b/\[/gi
+s/%5c/\\/gi
+s/%5d/\]/gi
+s/%5e/\^/gi
+s/%5f/_/gi
+s/%60/`/gi
+s/%7b/{/gi
+s/%7c/|/gi
+s/%7d/}/gi
+s/%7e/~/gi
+s/%09/ /gi
+'
+}
+
+function helper.encode-url encode_url urlencode() {
+ sed -e '
+s/%/%25/g
+s/ /%20/g
+s/ /%09/g
+s/!/%21/g
+s/"/%22/g
+s/#/%23/g
+s/\$/%24/g
+s/\&/%26/g
+s/'\''/%27/g
+s/(/%28/g
+s/)/%29/g
+s/\*/%2a/g
+s/+/%2b/g
+s/,/%2c/g
+s/-/%2d/g
+s/\./%2e/g
+s/\//%2f/g
+s/:/%3a/g
+s/;/%3b/g
+s//%3e/g
+s/?/%3f/g
+s/@/%40/g
+s/\[/%5b/g
+s/\\/%5c/g
+s/\]/%5d/g
+s/\^/%5e/g
+s/_/%5f/g
+s/`/%60/g
+s/{/%7b/g
+s/|/%7c/g
+s/}/%7d/g
+s/~/%7e/g
+s/ /%09/g
+'
+}
+
+# Check if a version number (semantic format) is greater than the other
+# returns 0 if the first argument is greater or equal than the second.
+function string.version_greatoreq version_greatoreq() {
+ [[ "$(printf '%s\n' "$@" | sort -rV | head -n 1)" = "$1" ]] && return 0
+ return 1
+}
+
+# }}} Strings
+
+# {{{ Networking
+
+# This is only tested on GNU/Linux and makes use of sysfs
+
+# index of all network devices
+arrs+=(net_devices)
+
+# map of ipv4 assigned addresses: [dev addr]
+maps+=(net_ip4_addr)
+# map of ipv6 assigned addresses: [dev addr]
+maps+=(net_ip6_addr)
+
+# map of dhcp served ipv4
+maps+=(ip4dhcps)
+# map of dhcp served ipv6
+maps+=(ip6dhcps)
+
+# map of external ipv4 addresses
+maps+=(net_ip4_exit)
+# map of internal ipv6 addresses
+# maps+=(ip6exits)
+
+net.scan_devices() {
+ for i in ${(f)"$(find /sys/devices/ -name net)"}; do
+ for dev in ${(f)"$(ls --indicator-style=none $i)"}; do
+ # skip the loopback device
+ [[ "$dev" =~ "^lo" ]] && continue
+ func "found network device: $dev"
+ net_devices+=($dev)
+ done
+ done
+
+ # return error if no device found
+ if [[ ${#net_devices} = 0 ]]; then return 1
+ else
+ act "${#net_devices} devices found: ${net_devices}"
+ return 0
+ fi
+}
+
+net.scan_addresses() {
+ [[ ${#net_devices} = 0 ]] && {
+ error "No network device found."
+ func "Have you ran net.scan_devices() first?"
+ return 1
+ }
+
+ for dev in ${net_devices}; do
+ # check ipv4 connections
+ conn=`ip addr show $dev | awk '/inet / {print $2}'`
+ [[ "$conn" = "" ]] || {
+ net_ip4_addr+=($dev $conn) }
+ # check ipv6 connections
+ conn=`ip addr show $dev | awk '/inet6/ {print $2}'`
+ [[ "$conn" = "" ]] || {
+ net_ip6_addr+=($dev $conn) }
+ done
+
+ # list ipv4
+ act "${#net_ip4_addr} ipv4 connected devices found"
+ for c in ${(k)net_ip4_addr}; do
+ act " $c ${net_ip4_addr[$c]}"
+ done
+
+ # list ipv6
+ act "${#net_ip6_addr} ipv6 connected devices found"
+ for c in ${(k)net_ip6_addr}; do
+ act " $c ${net_ip6_addr[$c]}"
+ done
+ # find out network addresses
+
+ return 0
+}
+
+net.scan_exits() {
+ # just ipv4 for now, also we use curl to drive the call over the
+ # specific interface, but if that wouldn't matter then rest.get is
+ # better to avoid this dependency
+
+ for dev in ${(k)net_ip4_addr}; do
+ addr=`curl --silent --interface $dev https://api.ipify.org`
+ if [[ "$?" != "0" ]]; then
+ error "curl returns $?: $addr"
+ else
+ [[ "$addr" = "" ]] || {
+ notice "$dev external ip: $addr"
+ net_ip4_exit+=($dev $addr)
+ }
+ fi
+ done
+
+ for dev in ${(k)net_ip6_addr}; do
+ addr=`curl --silent --ipv6 --interface $dev https://api.ipify.org`
+ if [[ $? != 0 ]]; then
+ error "curl returns $?: $addr"
+ else
+ [[ "$addr" = "" ]] || {
+ notice "$dev external ip: $addr"
+ net_ip4_exit+=($dev $addr)
+ }
+ fi
+ done
+
+}
+
+# }}} Networking
+
+# {{{ Key/Value filesave
+
+# optional: define zkv=1 on source
+
+##########################
+# Key/Value file storage using ZSh associative maps
+
+
+# load a map from a file
+# map must be already instantiated with typeset -A by called
+# name of map is defined inside the file
+function zkv.load() {
+ fn "zkv-load $*"
+
+ file=$1
+ [[ "$file" = "" ]] && {
+ error "zkv-open() missing argument: file-path"
+ zerr
+ return 1 }
+ [[ -r "$file" ]] || {
+ error "zkv-open() file not found $file"
+ zerr
+ return 1 }
+ [[ -s "$file" ]] || {
+ error "zkv-open() file is empty"
+ zerr
+ return 1 }
+
+ source $file
+}
+
+# save a map in a file
+# $1 = name of the map associative array
+# $2 = full path to the file
+function zkv.save() {
+ fn "zkv.save $*"
+
+ _map=$1
+ _path=$2
+ [[ "$_path" = "" ]] && {
+ error "zkv.save() missing argument: map-name path-to-file"
+ zerr
+ return 1
+ }
+ [[ -r $_path ]] && {
+ func "zkv.close() overwriting $_path"
+ func "backup turd left behind: ${_path}~"
+ mv $_path $_path~
+ }
+ touch $_path
+
+ # wondering about http://www.zsh.org/mla/users/2015/msg00286.html
+ # meanwhile solved using a double array, wasting a full map memcpy
+ _karr=(${(Pk)_map})
+ _varr=(${(Pv)_map})
+ _num="${#_karr}"
+ for c in {1..$_num}; do
+ # can also be cat here, however for speed we use builtins
+ # switch to cat if compatibility is an issue
+ sysread -o 1 <<EOF >> $_path
+$_map+=("${_karr[$c]}" "${(v)_varr[$c]}")
+EOF
+ done
+ func "$_num key/values stored in $_path"
+}
+
+
+# }}} Key/Value filesave
+
+# {{{ Get/Set REST API
+
+########
+# Restful API client (WIP, needs more testing)
+# there is a clear zsh optimization here in get/set kv
+# using zsh/tcp instead of spawning curl
+# and perhaps querying with one call using ?recursive
+
+vars+=(rest_reply_body rest_reply_header)
+maps+=(rest_header)
+
+function rest.put() {
+ fn "rest.put $*"
+
+ # $1 = hostname
+ # $2 = port
+ # $3 = path
+ # value from stdin |
+
+ # to check if the http service is running is up to the caller
+
+ _host=${1} # ip address
+ _port=${2}
+ _path=${3}
+ sysread _v
+
+ req=(_host)
+ ckreq || return $?
+
+ if ztcp $_host $_port; then
+
+ # TODO: work out various parsers, this one works with consul.io
+
+ _fd=$REPLY
+ # func "tcp open on fd $fd"
+ cat <<EOF >& $_fd
+PUT ${_path} HTTP/1.1
+User-Agent: Zuper/$zuper_version
+Host: ${_host}:${_port}
+Accept: */*
+Content-Length: ${#_v}
+Content-Type: application/x-www-form-urlencoded
+
+EOF
+
+ print -n "$_v" >& $_fd
+
+ sysread -i $_fd _res
+
+ # close connection
+ ztcp -c $_fd
+
+ [[ "$_res" =~ "true" ]] || {
+ warn "failed PUT on restful key/value"
+ warn "host: ${_host}"
+ warn "port: ${_port}"
+ warn "path: ${_path}"
+ warn "value: $_v"
+ print - "$_res"
+ zerr
+ return 1
+ }
+
+ else
+ error "cannot connect to restful service: $_host:$_port"
+ zerr
+ return 1
+ fi
+
+ return 0
+
+}
+
+function rest.get() {
+ fn "rest.get $*"
+
+ _host=${1}
+ _port=${2}
+ _path=${3}
+
+ req=(_host _port)
+ ckreq || return $?
+
+ ztcp $_host $_port || {
+ zerr
+ return 1
+ }
+
+ _fd=$REPLY
+
+ # TODO: work out various parsers, this one works with consul.io
+
+ cat <<EOF >& $_fd
+GET ${_path} HTTP/1.1
+User-Agent: Zuper/$zuper_version
+Host: $_host:$_port
+Accept: */*
+
+EOF
+
+ # read header response
+ rest_reply=`sysread -i $_fd -o 1`
+
+ for i in "${(f)rest_reply}"; do
+ print $i | hexdump -C
+ # first line is the response code
+
+ [[ "$i" -regex-match "\x0d\x0a$" ]] && {
+ func BLANK
+ break }
+
+ # # save other lines in map for fast retrieval
+ # _field=${i[(ws@:@)1]}
+ # func "$_field - header field parsed"
+ # rest_header[$_field]="${i[(ws@:@)2]}"
+
+ # c=$(( $c + 1 ))
+ done
+ # rest_reply_header="${(f)$(cat <&$_fd)}"
+
+ func "${#rest_reply_header} bytes response header stored in rest_reply_header"
+ # | awk -F: '
+ #/"Value":/ { gsub(/"|}]/,"",$7) ; print $7 }' | base64 -d
+
+ # TODO: read content-length and use it here
+
+ rest_reply_body="${(f)$(sysread -i $_fd -o 1)}"
+ func "${#rest_reply_body} bytes response body stored in rest_reply_body"
+
+ # close connection
+ ztcp -c $_fd
+
+ return 0
+
+}
+
+
+# }}} Get/Set REST API
+
+# {{{ Parse commandline options
+
+# for example usage, see Tomb http://tomb.dyne.org
+vars+=(subcommand)
+arrs+=(option_main option_params)
+maps+=(option option_subcommands)
+
+# Hi, dear developer! Are you trying to add a new subcommand, or
+# to add some options? Well, keep in mind that option names are
+# global: they cannot bear a different meaning or behaviour across
+# subcommands. The only exception is "-o" which means: "options
+# passed to the local subcommand", and thus can bear a different
+# meaning for different subcommands.
+#
+# For example, "-s" means "size" and accepts one argument. If you
+# are tempted to add an alternate option "-s" (e.g., to mean
+# "silent", and that doesn't accept any argument) DON'T DO IT!
+#
+# There are two reasons for that:
+# I. Usability; users expect that "-s" is "size"
+# II. Option parsing WILL EXPLODE if you do this kind of bad
+# things (it will complain: "option defined more than once")
+#
+# If you want to use the same option in multiple commands then you
+# can only use the non-abbreviated long-option version like:
+# -force and NOT -f
+
+option.is_set() {
+
+ # Check whether a commandline option is set.
+ #
+ # Synopsis: option_is_set -flag [out]
+ #
+ # First argument is the commandline flag (e.g., "-s").
+ # If the second argument is present and set to 'out', print out the
+ # result: either 'set' or 'unset' (useful for if conditions).
+ #
+ # Return 0 if is set, 1 otherwise
+ local -i r # the return code (0 = set, 1 = unset)
+
+ [[ -n ${(k)option[$1]} ]];
+ r=$?
+
+ [[ $2 == "out" ]] && {
+ [[ $r == 0 ]] && { print 'set' } || { print 'unset' }
+ }
+
+ return $r;
+}
+# Print the option value matching the given flag
+# Unique argument is the commandline flag (e.g., "-s").
+option.value() {
+ print -n - "${option[$1]}"
+}
+option.parse() {
+
+ ### Detect subcommand
+ local -aU every_opts #every_opts behave like a set; that is, an array with unique elements
+ for optspec in ${option_subcommands}${option_main}; do
+ for opt in ${=optspec}; do
+ every_opts+=${opt}
+ done
+ done
+ local -a oldstar
+ oldstar=("${(@)argv}")
+ #### detect early: useful for --option-parsing
+ zparseopts -M -D -Adiscardme ${every_opts}
+ if [[ -n ${(k)discardme[--option-parsing]} ]]; then
+ print $1
+ if [[ -n "$1" ]]; then
+ return 1
+ fi
+ return 0
+ fi
+ unset discardme
+ if ! zparseopts -M -E -D -Adiscardme ${every_opts}; then
+ _failure "Command parses error."
+ return 1
+ fi
+ unset discardme
+ subcommand=${1}
+ if [[ -z $subcommand ]]; then
+ subcommand="__empty"
+ fi
+
+ if [[ -z ${(k)option_subcommands[$subcommand]} ]]; then
+ subcommand="__unknown:$subcommand"
+ # _warning "There's no such command \"::1 subcommand::\"." $subcommand
+ # _failure "Please try -h for help."
+ fi
+ argv=("${(@)oldstar}")
+ unset oldstar
+
+ ### Parsing global + command-specific options
+ # zsh magic: ${=string} will split to multiple arguments when spaces occur
+ set -A cmd_opts ${option_main} ${=option_subcommands[$subcommand]}
+ # if there is no option, we don't need parsing
+ if [[ -n $cmd_opts ]]; then
+ zparseopts -M -E -D -Aoption ${cmd_opts}
+ if [[ $? != 0 ]]; then
+ _warning "Some error occurred during option processing."
+ _failure "See zuper option.parse for more info."
+ return 1
+ fi
+ fi
+ #build option_params (array of arguments) and check if there are unrecognized options
+ ok=0
+ option_params=()
+ for arg in $*; do
+ if [[ $arg == '--' || $arg == '-' ]]; then
+ ok=1
+ continue #it shouldn't be appended to option_params
+ elif [[ $arg[1] == '-' ]]; then
+ if [[ $ok == 0 ]]; then
+ _failure "Unrecognized option ::1 arg:: for subcommand ::2 subcommand::" $arg $subcommand
+ return 1
+ fi
+ fi
+ option_params+=$arg
+ done
+ # First parameter actually is the subcommand: delete it and shift
+ [[ $subcommand != '__empty' ]] && { option_params[1]=(); shift }
+
+ ### End parsing command-specific options
+
+ [[ "$option_params" == "" ]] && {
+ func "arg command: ::1 subcommand::" $subcommand
+ } || {
+ func "arg command: ::1 subcommand:: ::2 param::" $subcommand $option_params
+ }
+
+}
+
+# Later: process subcommand
+# case "$subcommand" in
+# help)
+# print "TODO: help"
+# ;;
+# __empty)
+# zdump
+# ;;
+
+# # Reject unknown command and suggest help
+# *)
+# _warning "Command \"::1 subcommand::\" not recognized." $subcommand
+# _message "Try -h for help."
+# return 1
+# ;;
+# esac
+
+# }}}
+
+# {{{ Helpers
+
+function helper.isfound isfound() {
+ command -v $1 1>/dev/null 2>/dev/null
+ return $?
+}
+
+# faster substitute for cat
+function helper.printfile printfile() {
+ print ${mapfile[$1]}
+}
+
+# }}} Helpers
+
+# {{{ Config
+
+# This is not a full config parser, but its a mechanism to read single
+# sections of configuration files that are separated using various
+# syntax methods. The only method supported is now org-mode whose
+# sections start with #+ . It fills in the global array
+# $config_section which can be read out to a file or interpreted in
+# memory, whatever syntax it may contain.
+
+vars+=(config_section_type)
+arrs+=(config_section)
+config_section_type=org-mode
+
+config.section_type() {
+ fn config.section.type
+ _type=$1
+ req=(_type)
+ ckreq || return $?
+
+ case $_type in
+ org-mode)
+ config_section_type=org-mode
+ ;;
+ *)
+ error "Unknown config type:$_type"
+ return 1
+ ;;
+ esac
+
+ act "$_type config section parser initialized"
+ return 0
+
+}
+
+# fills in contents of section in array config_section
+config.section_read() {
+ fn config.section.read
+ _file=$1
+ _section=$2
+ req=(_file _section)
+ freq=($_file)
+ ckreq || return $?
+
+ case $config_section_type in
+ org-mode)
+ _contents=`awk '
+BEGIN { found=0 }
+/^#\+ '"$_section"'$/ { found=1; next }
+/^#\+/ { if(found==1) exit 0 }
+/^$/ { next }
+{ if(found==1) print $0 }
+' $_file`
+
+ ;;
+ *)
+ error "Unknown config type:$_type"
+ ;;
+ esac
+
+ config_section=()
+ for c in ${(f)_contents}; do
+ config_section+=("$c")
+ done
+ return 0
+
+}
+
+# }}} Config
DIR diff --git a/lib/zuper/zuper.init b/lib/zuper/zuper.init
t@@ -0,0 +1,39 @@
+##########################
+# Zuper Init
+
+# initialize globals only after sourcing everything
+# since zlibs may contain more variable declarations
+for _v in $vars; do
+ typeset -h $_v
+done
+for _a in $arrs; do
+ typeset -aU $_a
+done
+for _m in $maps; do
+ typeset -A $_m
+done
+
+# reset defaults
+DEBUG=${DEBUG:-0}
+QUIET=${QUIET:-0}
+LOG=${LOG:-""}
+req=()
+freq=()
+last_act=()
+last_func=()
+last_notice=()
+tmpfiles=()
+config_section=()
+config_section_type=${config_section_type:-org-mode}
+
+option_subcommands[__empty]=""
+option_subcommands[__unknown]=""
+
+
+
+func "Zuper $zuper_version initialized"
+func "${#vars} global variables registered"
+func "${#arrs} global arrays registered"
+func "${#maps} global maps registered"
+
+