M COPYING => COPYING +201 -674
@@ 1,674 1,201 @@
- GNU GENERAL PUBLIC LICENSE
- Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
- The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users. We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors. You can apply it to
-your programs, too.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
- To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights. Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received. You must make sure that they, too, receive
-or can get the source code. And you must show them these terms so they
-know their rights.
-
- Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
- For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software. For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
- Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so. This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software. The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable. Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products. If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
- Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary. To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- TERMS AND CONDITIONS
-
- 0. Definitions.
-
- "This License" refers to version 3 of the GNU General Public License.
-
- "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
- "The Program" refers to any copyrightable work licensed under this
-License. Each licensee is addressed as "you". "Licensees" and
-"recipients" may be individuals or organizations.
-
- To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy. The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
- A "covered work" means either the unmodified Program or a work based
-on the Program.
-
- To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy. Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
- To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies. Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
- An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License. If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
- 1. Source Code.
-
- The "source code" for a work means the preferred form of the work
-for making modifications to it. "Object code" means any non-source
-form of a work.
-
- A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
- The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form. A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
- The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities. However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work. For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
- The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
- The Corresponding Source for a work in source code form is that
-same work.
-
- 2. Basic Permissions.
-
- All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met. This License explicitly affirms your unlimited
-permission to run the unmodified Program. The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work. This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
- You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force. You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright. Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
- Conveying under any other circumstances is permitted solely under
-the conditions stated below. Sublicensing is not allowed; section 10
-makes it unnecessary.
-
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
- No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
- When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
- 4. Conveying Verbatim Copies.
-
- You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
- You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
- 5. Conveying Modified Source Versions.
-
- You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
- a) The work must carry prominent notices stating that you modified
- it, and giving a relevant date.
-
- b) The work must carry prominent notices stating that it is
- released under this License and any conditions added under section
- 7. This requirement modifies the requirement in section 4 to
- "keep intact all notices".
-
- c) You must license the entire work, as a whole, under this
- License to anyone who comes into possession of a copy. This
- License will therefore apply, along with any applicable section 7
- additional terms, to the whole of the work, and all its parts,
- regardless of how they are packaged. This License gives no
- permission to license the work in any other way, but it does not
- invalidate such permission if you have separately received it.
-
- d) If the work has interactive user interfaces, each must display
- Appropriate Legal Notices; however, if the Program has interactive
- interfaces that do not display Appropriate Legal Notices, your
- work need not make them do so.
-
- A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit. Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
- 6. Conveying Non-Source Forms.
-
- You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
- a) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by the
- Corresponding Source fixed on a durable physical medium
- customarily used for software interchange.
-
- b) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by a
- written offer, valid for at least three years and valid for as
- long as you offer spare parts or customer support for that product
- model, to give anyone who possesses the object code either (1) a
- copy of the Corresponding Source for all the software in the
- product that is covered by this License, on a durable physical
- medium customarily used for software interchange, for a price no
- more than your reasonable cost of physically performing this
- conveying of source, or (2) access to copy the
- Corresponding Source from a network server at no charge.
-
- c) Convey individual copies of the object code with a copy of the
- written offer to provide the Corresponding Source. This
- alternative is allowed only occasionally and noncommercially, and
- only if you received the object code with such an offer, in accord
- with subsection 6b.
-
- d) Convey the object code by offering access from a designated
- place (gratis or for a charge), and offer equivalent access to the
- Corresponding Source in the same way through the same place at no
- further charge. You need not require recipients to copy the
- Corresponding Source along with the object code. If the place to
- copy the object code is a network server, the Corresponding Source
- may be on a different server (operated by you or a third party)
- that supports equivalent copying facilities, provided you maintain
- clear directions next to the object code saying where to find the
- Corresponding Source. Regardless of what server hosts the
- Corresponding Source, you remain obligated to ensure that it is
- available for as long as needed to satisfy these requirements.
-
- e) Convey the object code using peer-to-peer transmission, provided
- you inform other peers where the object code and Corresponding
- Source of the work are being offered to the general public at no
- charge under subsection 6d.
-
- A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
- A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling. In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage. For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product. A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
- "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source. The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
- If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information. But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
- The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed. Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
- Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
- 7. Additional Terms.
-
- "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law. If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
- When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it. (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.) You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
- Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
- a) Disclaiming warranty or limiting liability differently from the
- terms of sections 15 and 16 of this License; or
-
- b) Requiring preservation of specified reasonable legal notices or
- author attributions in that material or in the Appropriate Legal
- Notices displayed by works containing it; or
-
- c) Prohibiting misrepresentation of the origin of that material, or
- requiring that modified versions of such material be marked in
- reasonable ways as different from the original version; or
-
- d) Limiting the use for publicity purposes of names of licensors or
- authors of the material; or
-
- e) Declining to grant rights under trademark law for use of some
- trade names, trademarks, or service marks; or
-
- f) Requiring indemnification of licensors and authors of that
- material by anyone who conveys the material (or modified versions of
- it) with contractual assumptions of liability to the recipient, for
- any liability that these contractual assumptions directly impose on
- those licensors and authors.
-
- All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10. If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term. If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
- If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
- Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
- 8. Termination.
-
- You may not propagate or modify a covered work except as expressly
-provided under this License. Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
- However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
- Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
- Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
- 9. Acceptance Not Required for Having Copies.
-
- You are not required to accept this License in order to receive or
-run a copy of the Program. Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance. However,
-nothing other than this License grants you permission to propagate or
-modify any covered work. These actions infringe copyright if you do
-not accept this License. Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
- 10. Automatic Licensing of Downstream Recipients.
-
- Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License. You are not responsible
-for enforcing compliance by third parties with this License.
-
- An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations. If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
- You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License. For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
- 11. Patents.
-
- A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based. The
-work thus licensed is called the contributor's "contributor version".
-
- A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version. For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
- Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
- In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement). To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
- If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients. "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
- If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
- A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License. You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
- Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
- 12. No Surrender of Others' Freedom.
-
- If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all. For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
- 13. Use with the GNU Affero General Public License.
-
- Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work. The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
- 14. Revised Versions of this License.
-
- The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
- Each version is given a distinguishing version number. If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
- If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
- Later license versions may give you additional or different
-permissions. However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
- 15. Disclaimer of Warranty.
-
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
- 16. Limitation of Liability.
-
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
- 17. Interpretation of Sections 15 and 16.
-
- If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Programs
-
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
- <one line to give the program's name and a brief idea of what it does.>
- Copyright (C) <year> <name of author>
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program. If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
- If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
- <program> Copyright (C) <year> <name of author>
- This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
- This is free software, and you are welcome to redistribute it
- under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License. Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
- You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<https://www.gnu.org/licenses/>.
-
- The GNU General Public License does not permit incorporating your program
-into proprietary programs. If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library. If this is what you want to do, use the GNU Lesser General
-Public License instead of this License. But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
A Makefile => Makefile +63 -0
@@ 0,0 1,63 @@
+PREFIX ?= /usr/local
+BIN_PREFIX ?= ${PREFIX}/bin
+MAN_PREFIX ?= ${PREFIX}/share/man
+
+# Commands to build:
+COMMANDS =
+COMMANDS += go.spiff.io/chisel
+
+# Manpages to install:
+MANPAGES =
+
+GO_TAGS ?=
+
+SQLITE_DEFAULT_OPTIONS += sqlite_json
+SQLITE_DEFAULT_OPTIONS += sqlite_fts5
+SQLITE_DEFAULT_OPTIONS += sqlite_icu
+SQLITE_DEFAULT_OPTIONS += sqlite_omit_load_extension
+SQLITE_OPTIONS ?= ${SQLITE_DEFAULT_OPTIONS}
+GO_TAGS += ${SQLITE_OPTIONS}
+
+EXES =
+
+all:: exe man
+
+exe::
+man::
+
+install-exe::
+install-man::
+install:: install-exe install-man
+
+# Build and install Go commands.
+.for cmd in ${COMMANDS}
+prog_${cmd} = bin/${cmd:T}
+EXES += ${prog_${cmd}}
+
+${prog_${cmd}}::
+ go build -tags ${GO_TAGS:ts,:Q} -v -o ${.TARGET:Q} ${cmd:Q}
+
+exe:: ${prog_${cmd}}
+
+${BIN_PREFIX}/${cmd:T}: ${prog_${cmd}}
+ ${INSTALL} -TD ${prog_${cmd}:Q} ${.TARGET:Q}
+
+install-exe:: ${BIN_PREFIX}/${cmd:T}
+.endfor
+
+# Build and install man pages.
+.for man in ${MANPAGES}
+
+${man}: ${man}.scd
+ scdoc <${man}.scd >${man}
+
+man:: ${man}
+
+${MAN_PREFIX}/man${man:E}/${man}: ${man}
+ ${INSTALL} -TD ${man:Q} ${.TARGET:Q}
+
+install-man:: ${MAN_PREFIX}/man${man:E}/${man}
+.endfor
+
+clean::
+ rm -f ${EXES} ${MANPAGES}
A README.md => README.md +370 -0
@@ 0,0 1,370 @@
+Chisel
+===
+
+Chisel is a database frontend with support for transactions across multiple
+databases and query transformations via jq. Its main use is as a basic JSON API
+frontend to databases and for prototyping API work without the need to write
+a great deal of boilerplate to get started.
+
+Currently, Chisel is a work-in-progress and only its basic functionality is
+implemented. This includes:
+
+ * Listening on multiple addresses, and limiting endpoints to specific
+ addresses.
+ * Connecting to multiple databases for use in endpoints.
+ * Defining HTTP endpoints, with support for both GET- and POST-style requests.
+ * Executing a sequence of queries across one or more database transactions.
+ * Parsing request query and path parameters using jq.
+ * Mapping of database results, and passing database results to subsequent
+ queries in transactions.
+
+Installation
+---
+
+ $ go install go.spiff.io/chisel@latest
+
+Chisel does not currently have version tags, so this will always build
+and install the latest version to your GOBIN (defaults to `~/go/bin`).
+
+To build it locally, you can use `bmake` or `pmake`, which will build
+`chisel` with its default options as `bin/chisel`. This includes
+additional SQLite options that are not present when using `go install`
+on its own.
+
+Otherwise, if you don't care for any of the default options, you can use
+`go build` in the root of the project, which will produce a `chisel`
+binary for you to run.
+
+Usage
+---
+
+Chisel has very few CLI options currently, limited to the following:
+
+Usage of chisel:
+ * `-C` - Print the parsed program config as JSON and exit.
+ * `-c=config.json` - The path to load program config JSON from.
+ (default "config.json")
+ * `-v=level` - Set the log level. May be one of `info` (default),
+ `warn`, `error`, `fatal`, `panic`, `debug`, or `trace`.
+
+Configuration
+---
+
+Chisel is configured using JSON or YAML. Example configuration below uses YAML
+to provide comments alongside the data. The use of either is subject to change,
+possibly to [codf][] later, so bear that in mind. Currently, the top-level
+elements of a Chisel configuration are:
+
+[codf]: https://go.spiff.io/codf
+
+ * `bind` (`[]sockaddr`): A list of addresses and ports to listen for
+ connections on. If none are given, it defaults to `127.0.0.1:8080` (over
+ IPv4 only). Each address is assumed to be IPv4, IPv6, or a Unix domain
+ socket path. Unix domain socket paths must begin with `/` or `.` to identify
+ them as socket paths.
+
+ ```yaml
+ bind:
+ - 127.0.0.1:8080 # IPv4 address and port.
+ - '[::1]:8080' # IPv6 address and port.
+ - /var/run/chisel.s # Unix domain socket.
+ ```
+
+ Sockets in this list may be referred to by index later. Indices are
+ zero-based, so `0` would refer to `127.0.0.1:8080` above, and `1` would
+ refer to the Unix domain socket `/var/run/chisel.s`.
+
+ This may change to provide named socket groups or treat all addresses as
+ dual-stack where possible.
+
+ * `databases` (`[string]database`): A mapping of database names to their
+ configurations. See *Databases* below for the values these are configured
+ with.
+
+ * `endpoints` (`[]endpoint`): A list of endpoint definitions. See *Endpoints*
+ below for the values these are configured with.
+
+### Databases
+
+Every database has a name and a URL. Beyond that, all other values for
+a database are optional, and some are only configurable by setting values in the
+URL (these options are DBMS-specific and handed off to the driver).
+
+A fully-define database connection is provided below for reference:
+
+```yaml
+databases:
+ test:
+ url: sqlite://test.db # sqlite://, mysql://, postgres://
+ # Connection limits:
+ max_idle: 2 # Maximum idle connections.
+ max_idle_time: 0 # Maximum idle connection lifespan.
+ max_open: 0 # Maximum open connections.
+ max_life_time: 0 # Maximum connection lifespan.
+ # Query options:
+ options:
+ try_json: true # Whether to try parsing values as JSON.
+ skip_json: false # Whether to skip all JSON parsing, even for JSON columns.
+ time_format: rfc3339 # The format that times are parsed and rendered in.
+ # Or:
+ time_format: layout
+ time_layout: '06.01.02.15.03.04.000000'
+```
+
+The following options from above are configurable:
+
+ * `url` (`string`): A `postgres://`, `mysql://`, or `sqlite://`
+ database URL. Only limited support is available for SQLite and
+ MySQL. MySQL has the least support due to it lacking an
+ [insert-returning][postgres-insert] statement, while Chisel's
+ support for SQLite does not yet have locking and is experimental. If
+ using MySQL, it is recommended you use MariaDB instead, which has
+ support for an [insert-returning statement][mariadb-insert].
+
+ The format of a database URL is as follows, with optional parts
+ wrapped in square brackets:
+
+ ```
+ driver://[username:[password]@]hostname:port[/dbname][?options]
+ ```
+
+ * `max_idle` and `max_open` (`int`): These control max number of idle
+ and open connections, respectively, for a database. By default, the
+ maximum idle number is `2` and the maximum open is unlimited. These
+ defaults are from Go, and may not always follow Go.
+
+ * `max_idle_time` and `max_life_time` (`duration` string): These
+ control the maximum lifespan of idle and open connections. By
+ default, neither connection has a lifespan and will be open as long
+ as is possible. These are formatted as Go duration strings, such as
+ `5h4m3s2ms1us`.
+
+ * `try_json` (`bool`): If true, Chisel will attempt to parse all
+ retrieved database values as JSON where it looks like it can. This
+ applies to all columns with a text-like type, not only those with
+ a JSON column type. Defaults to false.
+
+ * `skip_json` (`bool`): If true, Chisel will skip parsing JSON on all
+ retrieved database values, including those with JSON column types.
+ This overrides `try_json` and forces it to false. Defaults to false.
+
+ * `time_format` (`enum`): Sets the format of times both parsed from
+ the database and returned in JSON. Time values are not parsed from
+ JSON in HTTP request bodies. May be one of the following values:
+ - `rfc3339` (default) - format times as RFC 3339 date-time
+ strings.
+ - `fsec` - format times as Unix timestamps with sub-second
+ fractional components.
+ - `unixns` - format times as Unix timestamps in nanoseconds.
+ - `unixus` - format times as Unix timestamps in microseconds.
+ - `unixms` - format times as Unix timestamps in milliseconds.
+ - `unix` - format times as Unix timestamps in seconds.
+ - `layout` - format times using the layout string from
+ `time_layout`.
+
+ * `time_layout` (`string`): Sets the Go time layout string to parse
+ and render times when `time_format` is set to `layout`.
+
+[postgres-insert]: https://www.postgresql.org/docs/13/sql-insert.html
+[mariadb-insert]: https://mariadb.com/kb/en/insertreturning/
+
+### Endpoints
+
+Endpoints define the HTTP endpoints served on one or more bind
+addresses. An endpoint has the following top-level values:
+
+ * `bind` (`[]int`): A set of one or more indices from the list of bind
+ addresses. The endpoint will only be served on the addresses
+ corresponding to the indices. The format of this field is subject to
+ change, but may be used to limit certain endpoints to internal
+ interfaces.
+
+ * `method` (`string`, required): An HTTP method, such as `GET` or
+ `POST`.
+
+ * `path` (`string`, required): The HTTP path, rooted at `/`. You may
+ define variable elements of the path by declaring them as `:name`,
+ such as `/things/:id/name`, where `:id` is a path parameter name. To
+ capture all subsequent path elements as a parameter, you can declare
+ the final path element as `*name`, such as `/file/at/*path`, where
+ all path elements after `/file/at/` are captured as the `path`
+ parameter. Path routing is currently handled by [httprouter][], so
+ its behavior determines how paths are currently handled.
+
+ * `body_type` (`enum`): The type of body to expect if `METHOD` is not
+ `GET` or `HEAD`. May be one of the following:
+ - `json` (default): Parse request bodies as JSON. If parsing
+ fails, reject the request.
+ - `string`: Read the body without parsing it and treat it as
+ a string.
+ - `form`: Parse the body as a form. Currently unsupported.
+ - `none`: Do not attempt to read or parse the request body.
+
+ * `query_params`, `path_params` (`[string][]mapping`): Mappings for
+ query and path parameters, respectively. Parameters named in this
+ are transformed with one or more mappings, allowing you to parse
+ parameters as numbers, check if they match a regexp, or other
+ features using jq expressions. For example:
+
+ ```yaml
+ path_params:
+ id:
+ - tonumber | if . <= 0 then error("id must be a positive number") else . end
+ ```
+
+ Note: although you can pass multiple mappings per parameter, this
+ may not be supported in the future.
+
+ * `query` (`query`): Defines the query associated with the endpoint,
+ including transactions and steps. See *Queries* below for more
+ detail.
+
+[httprouter]: https://github.com/julienschmidt/httprouter
+
+### Queries
+
+Queries have two top-level keys: `transactions`, which defines a list of
+transactions that make up an endpoint's queries; and `steps`, which
+defines a list of individual queries against those transactions and the
+transformations and arguments to each.
+
+#### Transactions
+
+Transactions define one or more transactions for an endpoint when
+accessing a database, as well as the isolation level of each
+transaction. This is used to ensure that queries run by chisel have
+appropriate isolation from other queries.
+
+Every transaction defined in an endpoint must be used by at least one
+step in the query.
+
+```yaml
+query:
+ transactions:
+ # 0
+ - db: test
+ isolation: serializable # Has a DBMS-level transaction.
+ # 1
+ - db: test
+ isolation: none # Has no DBMS-level transaction.
+```
+
+ * `db` (`string`): The list of transactions defines the databases that
+ an endpoint accesses and the isolation level of each transaction
+ against the database. The databases are referred to by their names
+ in the root-level `databases` mapping.
+
+ * `isolation` (`enum`): The isolation level of a transaction
+ determines the kind of isolation the database gives the transaction.
+ Not all databases are guaranteed to support all isolation levels (or
+ even support them correctly if they do). Every database has its own
+ default isolation level, and you should consult the DBMS
+ documentation for yours.
+
+ Valid isolation levels are:
+ - `default` (default): Use the DBMS's default isolation level.
+ - `none`: Do not create a transaction and instead run a one-off
+ query against the database. This is useful for single-query
+ endpoints and those that do not need to do things like perform
+ multiple updates or inserts followed by selects.
+ - `read_uncommitted`
+ - `read_committed`
+ - `write_committed`
+ - `repeatable_read`
+ - `snapshot`
+ - `serializable`
+ - `linearizable`
+
+#### Steps
+
+Query steps are the individual query statements, their arguments, and
+the transformations applied to their results.
+
+```yaml
+query:
+ steps:
+ - transaction: 0
+ query: SELECT * FROM builds WHERE id = ? LIMIT 1
+ args:
+ - path: id
+ map: # Output is the first row.
+ - first
+
+ - transaction: 0
+ query: SELECT id AS artifact_id, url AS artifact_url FROM artifacts WHERE build_id = ?
+ args:
+ # Fetch build ID from previous output.
+ - expr: '$context.outputs[0][0].id'
+ map: # Merge outputs.
+ - '{ data: ({ artifacts: . } * $context.outputs[0]) }'
+```
+
+A step is defined by the following fields:
+
+ * `transaction` (`int`): An index into the transactions list defined
+ in the parent query. If not set, defaults to the first transaction
+ as a convenience for single-transaction queries.
+
+ * `query` (`string`, required): The query to run against the
+ transaction. This can use `?` parameters as placeholders for
+ anything the DBMS permits for parameterization. Because this uses
+ [sqlx][] for parameter binding, cases like `col IN (?)` are expanded
+ when list arguments (below) are given.
+
+ * `args` (`[]arg`): The arguments passed to the above query. If the
+ query doesn't take parameters, this must be empty or undefined.
+ Each argument is defined in one of four ways:
+ - A literal value, such as `1`, `"foo"`, or a list of literal values.
+ - `{ path: "key" }` - A mapping binding the argument to the value of
+ a path parameter, defined on the endpoint. If the parameter is not
+ defined, the request fails.
+ - `{ query: "key" }` - A mapping binding the argument to the value
+ of a query parameter. As with path parameters, this must be
+ defined for the request, or the request fails.
+ - `{ expr: "jq" }` - A mapping binding the argument to the result
+ value of a jq expression. Composite return types such as mappings
+ are encoded as JSON, while lists are passed to the query for
+ binding. To ensure that a list is encoded as JSON, the result of
+ the expression should include a final `| tojson` pipeline. An
+ example of this can be seen above in the second step's argument
+ list.
+
+ * `map` (`[]jqexpr`): A list of jq expressions, encoded as strings, to
+ define transformations of the result set into the output of the
+ query step. The output is captured and passed to the next steps for
+ reuse. If this is the final step, the result of the mapping is used
+ as the JSON response body.
+
+ A special case is used to adjust the resulting HTTP status and
+ headers on response, by returning an object of the form:
+
+ ```json
+ {
+ "__response": {
+ "status": 201,
+ "headers": {
+ "x-foobar": ["something"]
+ },
+ "data_key": "actual_body"
+ },
+ "actual_body": {
+ "data": "foobar"
+ }
+ }
+ ```
+
+ Where, in the above case, all values of the `__response` object are
+ optional. If `status` is undefined, it defaults to HTTP 200 (OK).
+
+ If `data_key` is defined, instead of returning the object minus the
+ `__response` key, the response body will be returned using the data
+ found at the expression `.[$data_key]`. So, in the above example,
+ the actual response returned in the response is `{"data":"foobar"}`.
+
+[sqlx]: https://github.com/jmoiron/sqlx
+
+License
+---
+
+Chisel is licensed under the Apache 2.0 license. A copy of this license
+is included with the source code of the project.
M config.go => config.go +78 -48
@@ 1,22 1,22 @@
// chisel - A tool to fetch, transform, and serve data.
-// Copyright (C) 2021 Noel Cower
+// Copyright 2021 Noel Cower
//
-// 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.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
//
-// 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.
+// http://www.apache.org/licenses/LICENSE-2.0
//
-// You should have received a copy of the GNU General Public License
-// along with this program. If not, see <https://www.gnu.org/licenses/>.
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
package main
import (
+ "bytes"
"context"
"database/sql"
"encoding/json"
@@ 36,6 36,12 @@ import (
"gopkg.in/yaml.v3"
)
+func unmarshalStrict(p []byte, dest interface{}) error {
+ dec := hujson.NewDecoder(bytes.NewReader(p))
+ dec.DisallowUnknownFields()
+ return dec.Decode(&dest)
+}
+
type SockAddr struct {
sockaddr.SockAddr
}
@@ 54,10 60,10 @@ func (sa *SockAddr) UnmarshalText(src []byte) error {
}
type Config struct {
- Bind []SockAddr `json:"bind"`
- Databases map[string]*DatabaseDef `json:"databases"`
- Modules map[string]*ModuleDef `json:"modules"`
- Endpoints EndpointDefs `json:"endpoints"`
+ Bind []SockAddr `json:"bind" yaml:"bind"`
+ Databases map[string]*DatabaseDef `json:"databases" yaml:"databases"`
+ Modules map[string]*ModuleDef `json:"modules" yaml:"modules"`
+ Endpoints EndpointDefs `json:"endpoints" yaml:"endpoints"`
}
func (c *Config) Validate() error {
@@ 74,15 80,39 @@ func (c *Config) Validate() error {
return errorOrNil(me)
}
+type QueryOptions struct {
+ TryJSON bool `json:"try_json" yaml:"try_json"`
+ SkipJSON bool `json:"skip_json" yaml:"skip_json"`
+ TimeFormat vdb.TimeFormat `json:"time_format" yaml:"time_format"`
+ TimeLayout string `json:"time_layout,omitempty" yaml:"time_layout,omitempty"` // Used if TimeFormat is TimeCustom.
+
+ BindType int `json:"-" yaml:"-"`
+}
+
+func (q *QueryOptions) QueryOptions() *vdb.QueryOptions {
+ if q == nil {
+ return &vdb.QueryOptions{}
+ }
+ return &vdb.QueryOptions{
+ TryJSON: q.TryJSON,
+ SkipJSON: q.SkipJSON,
+ TimeFormat: q.TimeFormat,
+ TimeLayout: q.TimeLayout,
+ Compact: true,
+ BindType: q.BindType,
+ }
+}
+
type DatabaseDef struct {
- URL string `json:"url"`
+ URL string `json:"url" yaml:"url"`
- MaxIdle int `json:"max_idle"`
- MaxIdleTime Duration `json:"max_idle_time"`
- MaxOpen int `json:"max_open"`
- MaxLifeTime Duration `json:"max_life_time"`
+ MaxIdle int `json:"max_idle" yaml:"max_idle"`
+ MaxIdleTime Duration `json:"max_idle_time" yaml:"max_idle_time"`
+ MaxOpen int `json:"max_open" yaml:"max_open"`
+ MaxLifeTime Duration `json:"max_life_time" yaml:"max_life_time"`
- Options vdb.QueryOptions `json:"options"`
+ Options QueryOptions `json:"options" yaml:"options"`
+ options *vdb.QueryOptions // Converted options.
}
type Duration struct {
@@ 212,14 242,14 @@ type EndpointDefs []*EndpointDef
type ParamMappings map[string]*ParamMapping
type EndpointDef struct {
- Bind IntSet `json:"bind"`
- Method string `json:"method"`
- Path string `json:"path"`
- BodyType BodyType `json:"body_type"`
- QueryParams ParamMappings `json:"query_params"`
- PathParams ParamMappings `json:"path_params"`
+ Bind IntSet `json:"bind" yaml:"bind"`
+ Method string `json:"method" yaml:"method"`
+ Path string `json:"path" yaml:"path"`
+ BodyType BodyType `json:"body_type" yaml:"body_type"`
+ QueryParams ParamMappings `json:"query_params" yaml:"query_params"`
+ PathParams ParamMappings `json:"path_params" yaml:"path_params"`
- Query *QueryDef `json:"query"`
+ Query *QueryDef `json:"query" yaml:"query"`
}
func (ed *EndpointDef) Validate() error {
@@ 240,8 270,8 @@ func (ed *EndpointDef) Validate() error {
}
type QueryDef struct {
- Transactions []*TransactionDef `json:"transactions"`
- Steps []*StepDef `json:"steps"`
+ Transactions []*TransactionDef `json:"transactions" yaml:"transactions"`
+ Steps []*StepDef `json:"steps" yaml:"steps"`
}
func (qd *QueryDef) Validate() error {
@@ 272,26 302,26 @@ func (qd *QueryDef) Validate() error {
}
type StepDef struct {
- Transaction int `json:"transaction"`
- Query string `json:"query"`
- Args ArgDefs `json:"args"`
- Map Mapping `json:"map"`
+ Transaction int `json:"transaction" yaml:"transaction"`
+ Query string `json:"query" yaml:"query"`
+ Args ArgDefs `json:"args" yaml:"args"`
+ Map Mapping `json:"map" yaml:"map"`
}
type TransactionDef struct {
- DB string `json:"db"`
- Isolation IsolationLevel `json:"isolation"`
+ DB string `json:"db" yaml:"db"`
+ Isolation IsolationLevel `json:"isolation" yaml:"isolation"`
}
type ParamMapping struct {
- Map Mapping `json:"map"`
+ Map Mapping `json:"map" yaml:"map"`
}
type ArgDefs []ArgDef
func (ads *ArgDefs) UnmarshalJSON(src []byte) error {
var defs []json.RawMessage
- if err := hujson.Unmarshal(src, &defs); err != nil {
+ if err := unmarshalStrict(src, &defs); err != nil {
return err
}
@@ 379,7 409,7 @@ func UnmarshalArgDefYAML(node *yaml.Node) (ArgDef, error) {
func UnmarshalArgDef(blob json.RawMessage) (ArgDef, error) {
var m map[string]json.RawMessage
- if hujson.Unmarshal(blob, &m) == nil {
+ if unmarshalStrict(blob, &m) == nil {
if m == nil {
return ArgLiteral{Literal: nil}, nil
}
@@ 395,19 425,19 @@ func UnmarshalArgDef(blob json.RawMessage) (ArgDef, error) {
switch key {
case "path":
var ref PathParamRef
- if err := hujson.Unmarshal(value, &ref.Name); err != nil {
+ if err := unmarshalStrict(value, &ref.Name); err != nil {
return nil, fmt.Errorf("error unmarshaling path arg def: %w", err)
}
return ref, nil
case "query":
var ref QueryParamRef
- if err := hujson.Unmarshal(value, &ref.Name); err != nil {
+ if err := unmarshalStrict(value, &ref.Name); err != nil {
return nil, fmt.Errorf("error unmarshaling query arg def: %w", err)
}
return ref, nil
case "expr":
var expr Expr
- if err := hujson.Unmarshal(value, &expr); err != nil {
+ if err := unmarshalStrict(value, &expr); err != nil {
return nil, fmt.Errorf("error unmarshaling expr arg def: %w", err)
}
return ExprParam{&expr}, nil
@@ 417,7 447,7 @@ func UnmarshalArgDef(blob json.RawMessage) (ArgDef, error) {
}
lit := ArgLiteral{}
- if err := hujson.Unmarshal(blob, &lit.Literal); err != nil {
+ if err := unmarshalStrict(blob, &lit.Literal); err != nil {
return nil, fmt.Errorf("error unmarshaling arg def as literal: %w", err)
}
@@ 435,7 465,7 @@ func (a ArgLiteral) MarshalJSON() ([]byte, error) {
func (ArgLiteral) param() {}
type PathParamRef struct {
- Name string `json:"path"`
+ Name string `json:"path" yaml:"path"`
}
func (p PathParamRef) Value() (interface{}, error) {
@@ 445,13 475,13 @@ func (p PathParamRef) Value() (interface{}, error) {
func (PathParamRef) param() {}
type QueryParamRef struct {
- Name string `json:"query"`
+ Name string `json:"query" yaml:"query"`
}
func (QueryParamRef) param() {}
type ExprParam struct {
- Expr *Expr `json:"expr"`
+ Expr *Expr `json:"expr" yaml:"expr"`
}
func (ExprParam) param() {}
@@ 615,7 645,7 @@ func (is IntSet) MarshalYAML() (interface{}, error) {
func (is *IntSet) UnmarshalJSON(src []byte) error {
var ints []int
- if err := hujson.Unmarshal(src, &ints); err != nil {
+ if err := unmarshalStrict(src, &ints); err != nil {
return err
}
m := make(IntSet, len(ints))
@@ 700,7 730,7 @@ func (ss StringSet) MarshalYAML() (interface{}, error) {
func (ss *StringSet) UnmarshalJSON(src []byte) error {
var strs []string
- if err := hujson.Unmarshal(src, &strs); err != nil {
+ if err := unmarshalStrict(src, &strs); err != nil {
return err
}
m := make(StringSet, len(strs))
M config.json => config.json +32 -28
@@ 1,71 1,75 @@
-// NOTE: currently using hujson, so comments and trailing commas are permitted.
{
- // HTTP server bind addrs.
"bind": [
"127.0.0.1:8080"
],
- // Databases to connect to.
"databases": {
"test": {
- // TODO: detect and add a lock around all sqlite transactions.
"url": "sqlite://test.db",
"options": {
"try_json": true
}
}
- }, // (databases)
+ },
"endpoints": [
- // List all.
{
"method": "GET",
- "path": "/foo",
+ "path": "/builds",
"query": {
"transactions": [
- { "db": "test", "isolation": "none" }
+ {
+ "db": "test",
+ "isolation": "none"
+ }
],
"steps": [
{
"transaction": 0,
- "query": "select * from foo",
+ "query": "select * from builds",
"map": [
- // Wrap result array in data object.
"{ data: . }"
]
}
- ] // (steps)
- } // (query)
- }, // (List all)
-
- // Fetch by ID.
+ ]
+ }
+ },
{
"method": "GET",
- "path": "/foo/:id",
+ "path": "/builds/:id",
"path_params": {
"id": {
- // Parse :id parameter as a number.
- "map": [ "tonumber" ] // NB: tonumber is a jq expression.
+ "map": [
+ "tonumber",
+ "if . <= 0 then error(\"id must be a positive number\") else . end"
+ ]
}
},
"query": {
"transactions": [
- { "db": "test", "isolation": "none" }
+ {
+ "db": "test",
+ "isolation": "none"
+ }
],
"steps": [
{
- "query": "select * from foo where id = ? limit 1",
+ "query": "select * from builds where id = ? limit 1",
"args": [
- // Take the ID from the path and pass it as the first argument.
- { "path": "id" }
+ {
+ "path": "id"
+ }
],
+ "map": [ "first" ]
+ },
+ {
+ "query": "select 1234 as artifact_id, 'http://foobar' as artifact_url",
"map": [
- // Wrap first result in data object.
- "if length == 0 then { __response: { status: 404 } } else { data: first } end"
+ "{ data: ({ artifacts: . } * $context.outputs[0]) }"
]
}
- ] // (steps)
- } // (query)
- } // (Fetch by ID)
- ] // (endpoints)
+ ]
+ }
+ }
+ ]
}
M db.go => db.go +10 -11
@@ 1,18 1,17 @@
// chisel - A tool to fetch, transform, and serve data.
-// Copyright (C) 2021 Noel Cower
+// Copyright 2021 Noel Cower
//
-// 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.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
//
-// 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.
+// http://www.apache.org/licenses/LICENSE-2.0
//
-// You should have received a copy of the GNU General Public License
-// along with this program. If not, see <https://www.gnu.org/licenses/>.
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
package main
M driver_mysql.go => driver_mysql.go +10 -11
@@ 1,18 1,17 @@
// chisel - A tool to fetch, transform, and serve data.
-// Copyright (C) 2021 Noel Cower
+// Copyright 2021 Noel Cower
//
-// 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.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
//
-// 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.
+// http://www.apache.org/licenses/LICENSE-2.0
//
-// You should have received a copy of the GNU General Public License
-// along with this program. If not, see <https://www.gnu.org/licenses/>.
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
//go:build !omit_mysql
M driver_postgres.go => driver_postgres.go +10 -11
@@ 1,18 1,17 @@
// chisel - A tool to fetch, transform, and serve data.
-// Copyright (C) 2021 Noel Cower
+// Copyright 2021 Noel Cower
//
-// 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.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
//
-// 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.
+// http://www.apache.org/licenses/LICENSE-2.0
//
-// You should have received a copy of the GNU General Public License
-// along with this program. If not, see <https://www.gnu.org/licenses/>.
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
//go:build !omit_postgres
M driver_sqlite.go => driver_sqlite.go +10 -11
@@ 1,18 1,17 @@
// chisel - A tool to fetch, transform, and serve data.
-// Copyright (C) 2021 Noel Cower
+// Copyright 2021 Noel Cower
//
-// 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.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
//
-// 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.
+// http://www.apache.org/licenses/LICENSE-2.0
//
-// You should have received a copy of the GNU General Public License
-// along with this program. If not, see <https://www.gnu.org/licenses/>.
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
//go:build cgo && !omit_sqlite
M go.mod => go.mod +1 -1
@@ 11,7 11,7 @@ require (
github.com/rs/zerolog v1.23.0
github.com/tailscale/hujson v0.0.0-20210818175511-7360507a6e88
go.spiff.io/flagenv v0.1.0
- go.spiff.io/sql v0.2.0
+ go.spiff.io/sql v0.3.0
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
golang.org/x/sys v0.0.0-20210820121016-41cdb8703e55
gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
M go.sum => go.sum +2 -2
@@ 58,8 58,8 @@ github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9dec
go.spiff.io/flagenv v0.1.0 h1:t1EfA+0BAnfOw0KowRHhoB5ulRoZbjb0Z784TTbk3MU=
go.spiff.io/flagenv v0.1.0/go.mod h1:p7RQDlskcHpXWuYJNzFAG+5/69ApnPfNfNdVY8pJGP8=
go.spiff.io/go-ini v0.2.0/go.mod h1:h4CttGw62dZCr2s9w4nlYF2jl4jJei7/yUfBg9ieeng=
-go.spiff.io/sql v0.2.0 h1:OxdsfnZ7LPbt1uWcZPnw7BvA5thd2CRKwUzyswvOibs=
-go.spiff.io/sql v0.2.0/go.mod h1:tDVltWwvXhphp87vrmPNNWqyPa/SQ76bD/mECurUV+g=
+go.spiff.io/sql v0.3.0 h1:a+saiHSsR77A8Q6xy8bGd+lsI56Byh0tcLHF2eCe71I=
+go.spiff.io/sql v0.3.0/go.mod h1:HdCAftRIgCB0usMnyMp9qqFomEMnpjjclcP6SHkGxx4=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
M handler.go => handler.go +13 -14
@@ 1,18 1,17 @@
// chisel - A tool to fetch, transform, and serve data.
-// Copyright (C) 2021 Noel Cower
+// Copyright 2021 Noel Cower
//
-// 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.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
//
-// 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.
+// http://www.apache.org/licenses/LICENSE-2.0
//
-// You should have received a copy of the GNU General Public License
-// along with this program. If not, see <https://www.gnu.org/licenses/>.
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
package main
@@ 118,7 117,7 @@ func (h *Handler) Get(w http.ResponseWriter, req *http.Request, pathParams httpr
params, err := h.ParseParams(req, pathParams)
if err != nil {
log.Trace().Err(err).Msg("Error parsing parameters. Request aborted.")
- http.Error(w, "bad request", http.StatusBadRequest)
+ http.Error(w, "bad request: "+err.Error(), http.StatusBadRequest)
return
}
@@ 355,7 354,7 @@ func (h *Handler) computeResponse(ctx context.Context, log zerolog.Logger, w htt
log.Error().Err(err).Msg("Failed to expand IN(?) arguments.")
return nil, err
}
- query = sqlx.Rebind(t.db.Options.BindType, query)
+ query = sqlx.Rebind(t.db.options.BindType, query)
rows, err := t.QueryContext(ctx, query, args...)
defer rows.Close()
@@ 365,7 364,7 @@ func (h *Handler) computeResponse(ctx context.Context, log zerolog.Logger, w htt
return nil, err
}
- results, err := vdb.ScanRows(ctx, rows, &t.db.Options)
+ results, err := vdb.ScanRows(ctx, rows, t.db.options)
if err != nil {
http.Error(w, "internal server error", http.StatusInternalServerError)
log.Error().Err(err).Msg("Failed to scan result set.")
M main.go => main.go +20 -15
@@ 1,22 1,22 @@
// chisel - A tool to fetch, transform, and serve data.
-// Copyright (C) 2021 Noel Cower
+// Copyright 2021 Noel Cower
//
-// 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.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
//
-// 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.
+// http://www.apache.org/licenses/LICENSE-2.0
//
-// You should have received a copy of the GNU General Public License
-// along with this program. If not, see <https://www.gnu.org/licenses/>.
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
package main
import (
+ "bytes"
"context"
"encoding/json"
"errors"
@@ 65,9 65,9 @@ func Main(ctx context.Context, fs *flag.FlagSet, args []string) int {
printConfigAndExit bool
)
- fs.StringVar(&configPath, "c", configPath, "The path to load program config JSON from.")
+ fs.StringVar(&configPath, "c", configPath, "The `path` to load program config JSON or YAML from.")
fs.BoolVar(&printConfigAndExit, "C", printConfigAndExit, "Print the parsed program config and exit.")
- fs.Func("v", "Set the log level.", func(v string) error {
+ fs.Func("v", "Set the log `level`.", func(v string) error {
lev, err := zerolog.ParseLevel(v)
if err == nil {
logLevel = lev
@@ 132,6 132,7 @@ func Main(ctx context.Context, fs *flag.FlagSet, args []string) int {
return 1
}
dbe.Options.BindType = bindType
+ dbe.options = dbe.Options.QueryOptions()
pool, err := sqlx.Open(driver, dsn)
if err != nil {
@@ 286,9 287,13 @@ func readConfigFile(path string) (*Config, error) {
var conf *Config
switch filepath.Ext(path) {
case ".yaml", ".yml":
- err = yaml.Unmarshal(data, &conf)
+ dec := yaml.NewDecoder(bytes.NewReader(data))
+ dec.KnownFields(true)
+ err = dec.Decode(&conf)
default:
- err = hujson.Unmarshal(data, &conf)
+ dec := hujson.NewDecoder(bytes.NewReader(data))
+ dec.DisallowUnknownFields()
+ err = dec.Decode(&conf)
}
if err != nil {
return nil, fmt.Errorf("error parsing config file: %w", err)