diff options
| -rw-r--r-- | Changes | 5 | ||||
| -rw-r--r-- | LICENSE | 674 | ||||
| -rw-r--r-- | README | 46 | ||||
| -rw-r--r-- | lib/Config/HAProxy.pm | 140 | ||||
| -rw-r--r-- | lib/Config/HAProxy/Iterator.pm | 68 | ||||
| -rw-r--r-- | lib/Config/HAProxy/Node.pm | 137 | ||||
| -rw-r--r-- | lib/Config/HAProxy/Node/Comment.pm | 31 | ||||
| -rw-r--r-- | lib/Config/HAProxy/Node/Empty.pm | 29 | ||||
| -rw-r--r-- | lib/Config/HAProxy/Node/Root.pm | 52 | ||||
| -rw-r--r-- | lib/Config/HAProxy/Node/Section.pm | 153 | ||||
| -rw-r--r-- | lib/Config/HAProxy/Node/Statement.pm | 45 |
11 files changed, 1353 insertions, 27 deletions
@@ -0,0 +1,5 @@ +Revision history for Perl extension Config::HAProxy. + +1.00 Sun Jul 8 19:57:57 2018 + - original revision + @@ -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>. @@ -0,0 +1,46 @@ +Config::HAProxy +=============== + +A parser class that converts the HAProxy configuration file to a parse +tree and provides methods for various operations on this tree, such as: +searching, modifying and saving it to a file. + +EXAMPLE + + use Config::HAProxy; + + # Parse HAProxy configuration file + $cfg = Config::HAProxy->new->parse; + + # Print IP addresses and ports of the configured backends + foreach my $srv (map { $_->select(name => 'server') } + $cfg->tree->select(name => 'backend')) { + print $srv->arg(1),"\n"; + } + + +INSTALLATION + +To install this module type the following: + + perl Makefile.PL + make + make test + make install + +COPYRIGHT AND LICENCE + +Copyright (C) 2018 by Sergey Poznyakoff + +This library 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. + +It 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 library. If not, see <http://www.gnu.org/licenses/>. diff --git a/lib/Config/HAProxy.pm b/lib/Config/HAProxy.pm index 7938bcb..f99bf33 100644 --- a/lib/Config/HAProxy.pm +++ b/lib/Config/HAProxy.pm @@ -179,16 +179,16 @@ sub save { close($fh); my $sb = stat($self->filename); $self->backup; rename($tempfile, $self->filename) or croak "can't rename $tempfile to ".$self->tempfile.": $!"; - # This will fail unless we are root, let it be so. - chown $sb->uid, $sb->gid, $self->filename; # This will succeed: we've created the file, so we're owning it. chmod $sb->mode & 0777, $self->filename; + # This will fail unless we are root, let it be so. + chown $sb->uid, $sb->gid, $self->filename; $self->tree->clear_dirty } sub backup_name { my $self = shift; @@ -212,63 +212,122 @@ sub backup { 1; __END__ =head1 NAME -Config::HAProxy - HAProxy configuration file +Config::HAProxy - Parser for HAProxy configuration file =head1 SYNOPSIS -use Config::HAProxy; -$cfg = new Config::HAProxy($filename); -$cfg->parse; + use Config::HAProxy; + $cfg = new Config::HAProxy($filename); + $cfg->parse; -$name = $cfg->filename; + $name = $cfg->filename; -@frontends = $cfg->select(name => 'frontend'); + @frontends = $cfg->select(name => 'frontend'); -$itr = $cfg->iterator(inorder => 1); -while (defined($node = $itr->next)) { - # do something with $node -} + $itr = $cfg->iterator(inorder => 1); + while (defined($node = $itr->next)) { + # do something with $node + } -$cfg->save; + $cfg->save; -$cfg->write($file_or_handle); + $cfg->write($file_or_handle); -$cfg->backup; -$name = $self->backup_name; + $cfg->backup; + $name = $self->backup_name; -$cfg->reset; -$cfg->push($node); -$node = $cfg->pop; -$node = $cfg->tos; -$node = $cfg->tree; + $cfg->reset; + $cfg->push($node); + $node = $cfg->pop; + $node = $cfg->tos; + $node = $cfg->tree; =head1 DESCRIPTION -FIXME +The B<Config::HAProxy> class is a parser that converts the B<HAProxy> +configuration file to a parse tree and provides methods for various +operations on this tree, such as: searching, modifying and saving it +to a file. + +An object of this class contains a I<parse tree> representing the +configuration read from the file (or created from scratch). Nodes in the +tree can be of four distinct classes: + +=over 4 + +=item Empty + +Represents an empty line. + +=item Comment + +Represents a comment line. + +=item Statement + +Represents a simple statement. + +=item Section + +A container, representing a C<compound statement>, i.e. a statement that +contains multiple sub-statements. Compound statements are: B<global>, +B<defaults>, B<frontend>, and B<backend>. + +=back + +In addition to these four classes, a special class B<Root> is provided, which +represents the topmost node in the parse tree (i.e. the parent of other nodes). + +A set of attributes is associated with each node. Among these, the B<orig> +attribute contains the original line from the configuration file that triggered +creation of this node, and B<locus> contains the location of this line (or +lines, for sections) in the configuration file (as a B<Text::Locus>) object. + +These two attributes are meaningful for all nodes. For statement nodes (simple +statements and sections) the B<kw> attribute contains the statement I<keyword>, +and the B<argv> attribute - its arguments. For example, the statement + + server localhost 127.0.0.1:8080 + +is represented by a node of class B<Config::HAProxy::Node::Statement>, with +C<server> as B<kw> and list (C<localhost>, C<127.0.0.1:8080>) as B<argv>. + +Additionally, section nodes provide methods for accessing their subtrees. + +For a detailed description of the node class and its methods, please refer to +B<Config::HAProxy::Node>. =head1 CONSTRUCTOR $cfg = new Config::HAProxy($filename); Creates and returns a new object for manipulating the HAProxy configuration. Optional B<$filename> specifies the name of the file to read configuration from. It defaults to F</etc/haproxy/haproxy.cfg>. -=head1 THE PARSE TREE +=head2 filename + + $s = $cfg->filename; + +Returns the configuration file name given when creating the object. + +=head1 PARSING =head2 parse $cfg->parse; Reads and parses the configuration file. Croaks if the file does not exist. +Returns B<$cfg>. - +=head1 BUILDING THE PARSE TREE + =head2 reset $cfg->reset; Clears the parse tree. @@ -302,13 +361,13 @@ Returns the last node in the tree. =head1 SAVING =head2 save $cfg->save; -Saves the configuration file. +Saves the parse tree in the configuration file. =head2 write $cfg->write($file, %hash); Writes configuration to the named file or file handle. If B<$file> is the @@ -324,6 +383,37 @@ Arguments with B<$i> greater than or equal to B<@tabstop> are appended to the resulting output, preserving their original offsets. Normally, comments retain their original indentation. However, if the key B<reintent_comments> is present, and its value is evaluated as true, then comments are reindented following the rules described above. +=head1 SEE ALSO + +B<Config::HAProxy::Node>, +B<Config::HAProxy::Node::Section>, +B<Config::HAProxy::Node::Statement>, +B<Config::HAProxy::Iterator>. + +=head1 AUTHOR + +Sergey Poznyakoff, E<lt>gray@gnu.orgE<gt> + +=head1 COPYRIGHT AND LICENSE + +Copyright (C) 2018 by Sergey Poznyakoff + +This library 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. + +It 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 library. If not, see <http://www.gnu.org/licenses/>. + +=cut + + diff --git a/lib/Config/HAProxy/Iterator.pm b/lib/Config/HAProxy/Iterator.pm index 6b0208e..6d80dd9 100644 --- a/lib/Config/HAProxy/Iterator.pm +++ b/lib/Config/HAProxy/Iterator.pm @@ -60,10 +60,78 @@ sub next { } return $self->{_cur}; } 1; +__END__ + +=head1 NAME + +Config::HAProxy::Iterator - Iterate over objects in the parse tree + +=head1 SYNOPSIS + + $cfg = Config::HAProxy->new->parse; + $itr = $cfg->iterator(inorder => 1); + while (defined(my $node = $itr->next)) { + # Do something with $node + } + +=head1 DESCRIPTION + +The iterator object provides a method for iterating over all nodes in the +HAProxy parse tree. The object is returned by the B<iterator> method of +B<Config::HAProxy> and B<Config::HAProxy::Node> objects. The method takes +as optional argument the keyword specifying the order in which the tree nodes +should be traversed. This keyword can be one of the following: + +=over 4 + +=item B<recursive =E<gt> 0> + +No recursion. The traversal will not descend into section nodes. This is the +default. + +=item B<inorder =E<gt> 1> + +The nodes will be traversed in the inorder manner, i.e. the section node +will be visited first, and all its sub-nodes after it. + +=item B<postorder =E<gt> 1> + +The nodes will be traversed in the postorder manner, i.e. for each section +node, its sub-nodes will be visited first, and the node itself afterward. + +=back + +=head1 CONSTRUCTOR + +Note: This section is informative. You never need to create +B<Config::HAProxy::Iterator> objects explicitly. Please use the B<iterator> +method of B<Config::HAProxy> or B<Config::HAProxy::Node> class objects. + + $itr = new Config::HAProxy::Iterator($node, %rec); + +Returns new iterator object for traversing the tree starting from B<$node>, +which must be a B<Config::HAProxy::Node> object. Optional B<%rec> is one of +the keywords discussed above, in section B<DESCRIPTION>. + +=head1 METHODS + +=head2 next + + $node = $itr->next; + +Returns next node in the traversal sequence. If all nodes were visited, returns +B<undef>. + +=head1 SEE ALSO + +B<HAProxy::Config>, B<HAProxy::Config::Node>. + +=cut + diff --git a/lib/Config/HAProxy/Node.pm b/lib/Config/HAProxy/Node.pm index be09538..8210067 100644 --- a/lib/Config/HAProxy/Node.pm +++ b/lib/Config/HAProxy/Node.pm @@ -94,6 +94,143 @@ sub is_root { 0 } sub is_section { 0 } sub is_statement { 0 } sub is_empty { 0 } sub is_comment { 0 } 1; +__END__ + +=head1 NAME + +Config::HAProxy::Node - Abstract HAProxy configuration node + +=head1 DESCRIPTION + +The class B<Config::HAProxy::Node> represents an abstract node in the +HAProxy configuration parse tree. It serves as a base class for classes +representing configuration tree, section, simple statement, comment and +empty line. + +=head1 CONSTRUCTOR + + $obj = new Config::HAProxy::Node(%args); + +Returns new object. B<%args> can contain the following keys: + +=over 4 + +=item B<kw> + +Configuration keyword (string), + +=item B<argv> + +Reference to the list of arguments. + +=item B<orig> + +Original text as read from the configuration file. + +=item B<locus> + +Locus (a B<Text::Locus> object) where this statement occurred. + +=item B<parent> + +Parent node. + +=back + +=head1 METHODS + +=head2 B<kw>, B<argv>, B<orig>, B<locus>, B<parent> + +These methods return the corresponding field of the node. When called +with an argument, they set the field prior to returning it. The B<argv> +method returns array of strings and takes as its argument a reference to +the array of strings: + + @a = $node->argv; + + $node->argv([@a]); + +=head2 index + +Index (0-based) of this node in the parent node. + +=head2 arg + + $a = $node->arg($n) + +Returns the B<$n>th argument (0-based) from the argument list. + +=head2 drop + + $node->drop; + +Removes this node and destroys it. + +=head2 iterator + + $itr = $node->iterator(@args); + +Returns the iterator for this node. See B<Config::HAProxy::Iterator> for +a detailed discussion. + +=head2 depth + + $n = $node->depth; + +Returns the depth of this node in the configuration tree. Depth is the +number of parent nodes between the root of tree and this node. Top-level +nodes have depth 0. + +=head2 root + + $root_node = $node->root; + +Returns the root node of the parse tree this node belongs to. + +=head2 as_string + + $s = $node->as_string; + +Returns canonical string representation of this node. The canonical +representation consists of the keyword followed by arguments delimited +with horizontal space characters. + +=head1 ABSTRACT METHODS + +Derived classes must overload at least one of the following methods: + +=head2 is_root + +True if the node is a root node, false otherwise. + +=head2 is_section + +True if the node represents a section (i.e. contains subnodes). + +=head2 is_statement + +True if the node is a simple statement. + +=head2 is_empty + +True if the node represents an empty line. + +=head2 is_comment + +True if the node represents a comment. + +=head1 SEE ALSO + +B<Config::HAProxy::Node::Comment>, +B<Config::HAProxy::Node::Empty>, +B<Config::HAProxy::Node::Root>, +B<Config::HAProxy::Node::Section>, +B<Config::HAProxy::Node::Statement>, +B<Config::HAProxy::Iterator>, +B<Config::HAProxy>, +B<Text::Locus>. + +=cut diff --git a/lib/Config/HAProxy/Node/Comment.pm b/lib/Config/HAProxy/Node/Comment.pm index 5d7ef88..17a513b 100644 --- a/lib/Config/HAProxy/Node/Comment.pm +++ b/lib/Config/HAProxy/Node/Comment.pm @@ -1,6 +1,37 @@ package Config::HAProxy::Node::Comment; use parent 'Config::HAProxy::Node'; +=head1 NAME + +Config::HAProxy::Node::Comment - comment node in HAProxy configuration + +=head1 DESCRIPTION + +Objects of this class represent comments in HAProxy configuration file. + +=head1 METHODS + +=head2 is_comment + +Returns true. + +=head2 orig + +Returns original line as it appeared in the configuration file. + +=head2 locus + +Returns the location of this statement in the configuration file (the +B<Text::Locus> object). + +=head1 SEE ALSO + +B<Config::HAProxy::Node>, B<Text::Locus>. + +=cut + sub is_comment { 1 } 1; + + diff --git a/lib/Config/HAProxy/Node/Empty.pm b/lib/Config/HAProxy/Node/Empty.pm index bee0f2e..19ce5da 100644 --- a/lib/Config/HAProxy/Node/Empty.pm +++ b/lib/Config/HAProxy/Node/Empty.pm @@ -1,6 +1,35 @@ package Config::HAProxy::Node::Empty; use parent 'Config::HAProxy::Node'; +=head1 NAME + +Config::HAProxy::Node::Empty - empty HAProxy configuration node + +=head1 DESCRIPTION + +Objects of this class represent empty lines in HAProxy configuration file. + +=head1 METHODS + +=head2 is_empty + +Always true. + +=head2 orig + +Returns original line as it appeared in the configuration file. + +=head2 locus + +Returns the location of this statement in the configuration file (the +B<Text::Locus> object). + +=head1 SEE ALSO + +B<Config::HAProxy::Node>, B<Text::Locus>. + +=cut + sub is_empty { 1 } 1; diff --git a/lib/Config/HAProxy/Node/Root.pm b/lib/Config/HAProxy/Node/Root.pm index 656bb9f..ca6e575 100644 --- a/lib/Config/HAProxy/Node/Root.pm +++ b/lib/Config/HAProxy/Node/Root.pm @@ -1,31 +1,81 @@ package Config::HAProxy::Node::Root; use strict; use warnings; use parent 'Config::HAProxy::Node::Section'; use Carp; +=head1 NAME + +Config::HAProxy::Node::Root - root node of HAProxy configuration parse tree + +=head1 DESCRIPTION + +Objects of this class represent the topmost node in HAProxy configuration tree. +Each parse tree contains exactly one object of this class. This node can be +reached from every node in the tree by following its B<parent> attribute +and is returned by the B<tree> method of B<Config::HAProxy> class. + +=cut + sub new { my $class = shift; my $self = $class->SUPER::new(@_); $self->{dirty} = 0; return $self; } +=head1 METHODS + +=head2 is_root + +Always true. + +=head2 is_dirty + + $bool = $node->is_dirty; + +Returns true if the tree is C<dirty>, i.e. it was modified since it has been +created from the disk configuration file. + +=cut + sub is_dirty { my $self = shift; return $self->{dirty} } +=head2 mark_dirty + + $node->mark_dirty; + +Sets the C<dirty> attribute. + +=cut + sub mark_dirty { my $self = shift; $self->{dirty} = 1; } +=head2 clear_dirty + + $node->clear_dirty; + +Clears the C<dirty> attribute. + +=cut + sub clear_dirty { my $self = shift; $self->{dirty} = 0; } - + +=head1 SEE ALSO + +B<Config::HAProxy::Node>. + +=cut + 1; diff --git a/lib/Config/HAProxy/Node/Section.pm b/lib/Config/HAProxy/Node/Section.pm index c332155..3ef1cf0 100644 --- a/lib/Config/HAProxy/Node/Section.pm +++ b/lib/Config/HAProxy/Node/Section.pm @@ -1,41 +1,113 @@ package Config::HAProxy::Node::Section; use strict; use warnings; use parent 'Config::HAProxy::Node'; use Carp; +=head1 NAME + +Config::HAProxy::Node::Section - HAProxy configuration section + +=head1 DESCRIPTION + +Objects of this class represent a C<section> in the HAProxy configuration file. +A section is a statement that can contain sub-statements. The following +statements form sections: B<global>, B<defaults>, B<frontend>, and B<backend>. + +=cut + sub new { my $class = shift; my $self = $class->SUPER::new(@_); $self->{_tree} = []; return $self; } +=head1 ATTRIBUTES + +=head2 is_section + +Always true. + +=cut + sub is_section { 1 } +=head1 METHODS + +=head2 kw + +Returns the configuration keyword. + +=head2 argv + +Returns the list of arguments to the configuration keyword. + +=head2 arg + + $s = $node->arg($n) + +Returns the B<$n>th argument. + +=head2 orig + +Returns original line as it appeared in the configuration file. + +=head2 locus + +Returns the location of this statement in the configuration file (the +B<Text::Locus> object). + +=head2 append_node + + $section->append_node(@nodes); + +Takes a list of objects of B<Config::HAProxy::Node> derived classes as +arguments. Adds these objects after the last node in the subtree in this +section. + +=cut + sub append_node { my $self = shift; my $n = @{$self->{_tree}}; push @{$self->{_tree}}, map { $_->parent($self); $_->index($n++); $_ } @_; } +=head2 append_node_nonempty + + $section->append_node_nonempty(@nodes); + +Same as B<append_node>, but adds new nodes after the last non-empty +node in the subtree. + +=cut + sub append_node_nonempty { my $self = shift; my $n = $#{$self->{_tree}}; while ($n >= 0 && $self->{_tree}[$n]->is_empty) { $n--; } $self->insert_node($n+1, @_); } - + +=head2 insert_node + + $section->insert_node($idx, @nodes); + +Inserts B<@nodes> after subnode in position B<$idx> (0-based). + +=cut + sub insert_node { my $self = shift; my $n = shift; my $i = $n; splice @{$self->{_tree}}, $n, 0, map { @@ -45,30 +117,59 @@ sub insert_node { } @_; for (; $i < @{$self->{_tree}}; $i++) { $self->{_tree}[$i]->index($i); } } +=head2 delete_node + + $section->delete_node($i); + +Deletes B<$i>th subnode from the B<$section>. + +=cut + sub delete_node { my ($self, $n) = @_; splice @{$self->{_tree}}, $n, 1; for (; $n < @{$self->{_tree}}; $n++) { $self->{_tree}[$n]->index($n); } $self->root->mark_dirty; } +=head2 tree + + @nodes = $section->tree; + +Returns subnodes as a list of B<Config::HAProxy::Node> derived objects. + + $node = $section->tree($i); + +Returns B<$i>th subnode from the B<$section>. + +=cut + sub tree { my ($self, $n) = @_; if ($n) { return undef if $n >= @{$self->{_tree}}; return $self->{_tree}[$n]; } return @{shift->{_tree}} }; +=head2 ends_in_empty + + $bool = $section->ends_in_empty + +Returns true if the last node in the list of sub-nodes in B<$section> is +an empty node. + +=cut + sub ends_in_empty { my $self = shift; while ($self->is_section) { $self = $self->tree(-1); } return $self->is_empty; @@ -107,12 +208,56 @@ my %match = ( my $node = shift; return $node->is_comment; } } ); +=head2 select + + @nodes = $section->select(%cond); + +Returns nodes from B<$section> that match conditions in B<%cond>. Valid +conditions are: + +=over 4 + +=item B<name =E<gt>> I<$s> + +Node matches if its keyword (B<kw>) equals I<$s>. + +=item B<arg =E<gt>> B<{ n =E<gt>> I<$n>, B<v> =E<gt> I<$s> B<}> + +Node mathches if its I<$n>th argument equals I<$s>. + +=item B<section =E<gt>> I<$bool> + +Node matches if it is (or is not, if I<$bool> is false) a section. + +=item B<statement =E<gt>> I<$bool> + +Node matches if it is (not) a simple statement. + +=item B<comment =E<gt>> I<$bool> + +Node matches if it is (not) a comment. + +=back + +Multiple conditions are checked in the order of their appearance in the +argument list and are joined by the short-circuit logical C<and>. + +For example, to return all B<frontend> statements: + + @fe = $section->select(name => 'frontend'); + +To return the frontend named C<in>: + + ($fe) = $section->select( name => 'frontend', + arg => { n => 0, v => 'in' } ); + +=cut sub select { my $self = shift; my @prog; while (my $p = shift) { my $arg = shift or croak "missing argument"; @@ -135,9 +280,15 @@ sub _test_node { return 0 unless &{$f}($node); } } return 1; } +=head1 SEE ALSO + +B<Config::HAProxy::Node>, B<Config::HAProxy>, B<Text::Locus>. + +=cut + 1; diff --git a/lib/Config/HAProxy/Node/Statement.pm b/lib/Config/HAProxy/Node/Statement.pm index abf0e50..305c529 100644 --- a/lib/Config/HAProxy/Node/Statement.pm +++ b/lib/Config/HAProxy/Node/Statement.pm @@ -1,6 +1,51 @@ package Config::HAProxy::Node::Statement; use parent 'Config::HAProxy::Node'; +=head1 NAME + +Config::HAProxy::Node::Statement - simple statement node in HAProxy tree + +=head1 DESCRIPTION + +Objects of this class represent simple statements in HAProxy configuration +file. A C<simple statement> is any statement excepting: B<global>, B<defaults>, +B<frontend>, and B<backend>. + +=head1 METHODS + +=head2 is_statement + +Returns true. + +=head2 kw + +Returns the configuration keyword. + +=head2 argv + +Returns the list of arguments to the configuration keyword. + +=head2 arg + + $s = $node->arg($n) + +Returns the B<$n>th argument. + +=head2 orig + +Returns original line as it appeared in the configuration file. + +=head2 locus + +Returns the location of this statement in the configuration file (the +B<Text::Locus> object). + +=head1 SEE ALSO + +B<Config::HAProxy::Node>, B<Config::HAProxy>, B<Text::Locus>. + +=cut + sub is_statement { 1 } 1; |