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 @@ | |||
1 | Revision history for Perl extension Config::HAProxy. | ||
2 | |||
3 | 1.00 Sun Jul 8 19:57:57 2018 | ||
4 | - original revision | ||
5 | |||
@@ -0,0 +1,674 @@ | |||
1 | GNU GENERAL PUBLIC LICENSE | ||
2 | Version 3, 29 June 2007 | ||
3 | |||
4 | Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> | ||
5 | Everyone is permitted to copy and distribute verbatim copies | ||
6 | of this license document, but changing it is not allowed. | ||
7 | |||
8 | Preamble | ||
9 | |||
10 | The GNU General Public License is a free, copyleft license for | ||
11 | software and other kinds of works. | ||
12 | |||
13 | The licenses for most software and other practical works are designed | ||
14 | to take away your freedom to share and change the works. By contrast, | ||
15 | the GNU General Public License is intended to guarantee your freedom to | ||
16 | share and change all versions of a program--to make sure it remains free | ||
17 | software for all its users. We, the Free Software Foundation, use the | ||
18 | GNU General Public License for most of our software; it applies also to | ||
19 | any other work released this way by its authors. You can apply it to | ||
20 | your programs, too. | ||
21 | |||
22 | When we speak of free software, we are referring to freedom, not | ||
23 | price. Our General Public Licenses are designed to make sure that you | ||
24 | have the freedom to distribute copies of free software (and charge for | ||
25 | them if you wish), that you receive source code or can get it if you | ||
26 | want it, that you can change the software or use pieces of it in new | ||
27 | free programs, and that you know you can do these things. | ||
28 | |||
29 | To protect your rights, we need to prevent others from denying you | ||
30 | these rights or asking you to surrender the rights. Therefore, you have | ||
31 | certain responsibilities if you distribute copies of the software, or if | ||
32 | you modify it: responsibilities to respect the freedom of others. | ||
33 | |||
34 | For example, if you distribute copies of such a program, whether | ||
35 | gratis or for a fee, you must pass on to the recipients the same | ||
36 | freedoms that you received. You must make sure that they, too, receive | ||
37 | or can get the source code. And you must show them these terms so they | ||
38 | know their rights. | ||
39 | |||
40 | Developers that use the GNU GPL protect your rights with two steps: | ||
41 | (1) assert copyright on the software, and (2) offer you this License | ||
42 | giving you legal permission to copy, distribute and/or modify it. | ||
43 | |||
44 | For the developers' and authors' protection, the GPL clearly explains | ||
45 | that there is no warranty for this free software. For both users' and | ||
46 | authors' sake, the GPL requires that modified versions be marked as | ||
47 | changed, so that their problems will not be attributed erroneously to | ||
48 | authors of previous versions. | ||
49 | |||
50 | Some devices are designed to deny users access to install or run | ||
51 | modified versions of the software inside them, although the manufacturer | ||
52 | can do so. This is fundamentally incompatible with the aim of | ||
53 | protecting users' freedom to change the software. The systematic | ||
54 | pattern of such abuse occurs in the area of products for individuals to | ||
55 | use, which is precisely where it is most unacceptable. Therefore, we | ||
56 | have designed this version of the GPL to prohibit the practice for those | ||
57 | products. If such problems arise substantially in other domains, we | ||
58 | stand ready to extend this provision to those domains in future versions | ||
59 | of the GPL, as needed to protect the freedom of users. | ||
60 | |||
61 | Finally, every program is threatened constantly by software patents. | ||
62 | States should not allow patents to restrict development and use of | ||
63 | software on general-purpose computers, but in those that do, we wish to | ||
64 | avoid the special danger that patents applied to a free program could | ||
65 | make it effectively proprietary. To prevent this, the GPL assures that | ||
66 | patents cannot be used to render the program non-free. | ||
67 | |||
68 | The precise terms and conditions for copying, distribution and | ||
69 | modification follow. | ||
70 | |||
71 | TERMS AND CONDITIONS | ||
72 | |||
73 | 0. Definitions. | ||
74 | |||
75 | "This License" refers to version 3 of the GNU General Public License. | ||
76 | |||
77 | "Copyright" also means copyright-like laws that apply to other kinds of | ||
78 | works, such as semiconductor masks. | ||
79 | |||
80 | "The Program" refers to any copyrightable work licensed under this | ||
81 | License. Each licensee is addressed as "you". "Licensees" and | ||
82 | "recipients" may be individuals or organizations. | ||
83 | |||
84 | To "modify" a work means to copy from or adapt all or part of the work | ||
85 | in a fashion requiring copyright permission, other than the making of an | ||
86 | exact copy. The resulting work is called a "modified version" of the | ||
87 | earlier work or a work "based on" the earlier work. | ||
88 | |||
89 | A "covered work" means either the unmodified Program or a work based | ||
90 | on the Program. | ||
91 | |||
92 | To "propagate" a work means to do anything with it that, without | ||
93 | permission, would make you directly or secondarily liable for | ||
94 | infringement under applicable copyright law, except executing it on a | ||
95 | computer or modifying a private copy. Propagation includes copying, | ||
96 | distribution (with or without modification), making available to the | ||
97 | public, and in some countries other activities as well. | ||
98 | |||
99 | To "convey" a work means any kind of propagation that enables other | ||
100 | parties to make or receive copies. Mere interaction with a user through | ||
101 | a computer network, with no transfer of a copy, is not conveying. | ||
102 | |||
103 | An interactive user interface displays "Appropriate Legal Notices" | ||
104 | to the extent that it includes a convenient and prominently visible | ||
105 | feature that (1) displays an appropriate copyright notice, and (2) | ||
106 | tells the user that there is no warranty for the work (except to the | ||
107 | extent that warranties are provided), that licensees may convey the | ||
108 | work under this License, and how to view a copy of this License. If | ||
109 | the interface presents a list of user commands or options, such as a | ||
110 | menu, a prominent item in the list meets this criterion. | ||
111 | |||
112 | 1. Source Code. | ||
113 | |||
114 | The "source code" for a work means the preferred form of the work | ||
115 | for making modifications to it. "Object code" means any non-source | ||
116 | form of a work. | ||
117 | |||
118 | A "Standard Interface" means an interface that either is an official | ||
119 | standard defined by a recognized standards body, or, in the case of | ||
120 | interfaces specified for a particular programming language, one that | ||
121 | is widely used among developers working in that language. | ||
122 | |||
123 | The "System Libraries" of an executable work include anything, other | ||
124 | than the work as a whole, that (a) is included in the normal form of | ||
125 | packaging a Major Component, but which is not part of that Major | ||
126 | Component, and (b) serves only to enable use of the work with that | ||
127 | Major Component, or to implement a Standard Interface for which an | ||
128 | implementation is available to the public in source code form. A | ||
129 | "Major Component", in this context, means a major essential component | ||
130 | (kernel, window system, and so on) of the specific operating system | ||
131 | (if any) on which the executable work runs, or a compiler used to | ||
132 | produce the work, or an object code interpreter used to run it. | ||
133 | |||
134 | The "Corresponding Source" for a work in object code form means all | ||
135 | the source code needed to generate, install, and (for an executable | ||
136 | work) run the object code and to modify the work, including scripts to | ||
137 | control those activities. However, it does not include the work's | ||
138 | System Libraries, or general-purpose tools or generally available free | ||
139 | programs which are used unmodified in performing those activities but | ||
140 | which are not part of the work. For example, Corresponding Source | ||
141 | includes interface definition files associated with source files for | ||
142 | the work, and the source code for shared libraries and dynamically | ||
143 | linked subprograms that the work is specifically designed to require, | ||
144 | such as by intimate data communication or control flow between those | ||
145 | subprograms and other parts of the work. | ||
146 | |||
147 | The Corresponding Source need not include anything that users | ||
148 | can regenerate automatically from other parts of the Corresponding | ||
149 | Source. | ||
150 | |||
151 | The Corresponding Source for a work in source code form is that | ||
152 | same work. | ||
153 | |||
154 | 2. Basic Permissions. | ||
155 | |||
156 | All rights granted under this License are granted for the term of | ||
157 | copyright on the Program, and are irrevocable provided the stated | ||
158 | conditions are met. This License explicitly affirms your unlimited | ||
159 | permission to run the unmodified Program. The output from running a | ||
160 | covered work is covered by this License only if the output, given its | ||
161 | content, constitutes a covered work. This License acknowledges your | ||
162 | rights of fair use or other equivalent, as provided by copyright law. | ||
163 | |||
164 | You may make, run and propagate covered works that you do not | ||
165 | convey, without conditions so long as your license otherwise remains | ||
166 | in force. You may convey covered works to others for the sole purpose | ||
167 | of having them make modifications exclusively for you, or provide you | ||
168 | with facilities for running those works, provided that you comply with | ||
169 | the terms of this License in conveying all material for which you do | ||
170 | not control copyright. Those thus making or running the covered works | ||
171 | for you must do so exclusively on your behalf, under your direction | ||
172 | and control, on terms that prohibit them from making any copies of | ||
173 | your copyrighted material outside their relationship with you. | ||
174 | |||
175 | Conveying under any other circumstances is permitted solely under | ||
176 | the conditions stated below. Sublicensing is not allowed; section 10 | ||
177 | makes it unnecessary. | ||
178 | |||
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. | ||
180 | |||
181 | No covered work shall be deemed part of an effective technological | ||
182 | measure under any applicable law fulfilling obligations under article | ||
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or | ||
184 | similar laws prohibiting or restricting circumvention of such | ||
185 | measures. | ||
186 | |||
187 | When you convey a covered work, you waive any legal power to forbid | ||
188 | circumvention of technological measures to the extent such circumvention | ||
189 | is effected by exercising rights under this License with respect to | ||
190 | the covered work, and you disclaim any intention to limit operation or | ||
191 | modification of the work as a means of enforcing, against the work's | ||
192 | users, your or third parties' legal rights to forbid circumvention of | ||
193 | technological measures. | ||
194 | |||
195 | 4. Conveying Verbatim Copies. | ||
196 | |||
197 | You may convey verbatim copies of the Program's source code as you | ||
198 | receive it, in any medium, provided that you conspicuously and | ||
199 | appropriately publish on each copy an appropriate copyright notice; | ||
200 | keep intact all notices stating that this License and any | ||
201 | non-permissive terms added in accord with section 7 apply to the code; | ||
202 | keep intact all notices of the absence of any warranty; and give all | ||
203 | recipients a copy of this License along with the Program. | ||
204 | |||
205 | You may charge any price or no price for each copy that you convey, | ||
206 | and you may offer support or warranty protection for a fee. | ||
207 | |||
208 | 5. Conveying Modified Source Versions. | ||
209 | |||
210 | You may convey a work based on the Program, or the modifications to | ||
211 | produce it from the Program, in the form of source code under the | ||
212 | terms of section 4, provided that you also meet all of these conditions: | ||
213 | |||
214 | a) The work must carry prominent notices stating that you modified | ||
215 | it, and giving a relevant date. | ||
216 | |||
217 | b) The work must carry prominent notices stating that it is | ||
218 | released under this License and any conditions added under section | ||
219 | 7. This requirement modifies the requirement in section 4 to | ||
220 | "keep intact all notices". | ||
221 | |||
222 | c) You must license the entire work, as a whole, under this | ||
223 | License to anyone who comes into possession of a copy. This | ||
224 | License will therefore apply, along with any applicable section 7 | ||
225 | additional terms, to the whole of the work, and all its parts, | ||
226 | regardless of how they are packaged. This License gives no | ||
227 | permission to license the work in any other way, but it does not | ||
228 | invalidate such permission if you have separately received it. | ||
229 | |||
230 | d) If the work has interactive user interfaces, each must display | ||
231 | Appropriate Legal Notices; however, if the Program has interactive | ||
232 | interfaces that do not display Appropriate Legal Notices, your | ||
233 | work need not make them do so. | ||
234 | |||
235 | A compilation of a covered work with other separate and independent | ||
236 | works, which are not by their nature extensions of the covered work, | ||
237 | and which are not combined with it such as to form a larger program, | ||
238 | in or on a volume of a storage or distribution medium, is called an | ||
239 | "aggregate" if the compilation and its resulting copyright are not | ||
240 | used to limit the access or legal rights of the compilation's users | ||
241 | beyond what the individual works permit. Inclusion of a covered work | ||
242 | in an aggregate does not cause this License to apply to the other | ||
243 | parts of the aggregate. | ||
244 | |||
245 | 6. Conveying Non-Source Forms. | ||
246 | |||
247 | You may convey a covered work in object code form under the terms | ||
248 | of sections 4 and 5, provided that you also convey the | ||
249 | machine-readable Corresponding Source under the terms of this License, | ||
250 | in one of these ways: | ||
251 | |||
252 | a) Convey the object code in, or embodied in, a physical product | ||
253 | (including a physical distribution medium), accompanied by the | ||
254 | Corresponding Source fixed on a durable physical medium | ||
255 | customarily used for software interchange. | ||
256 | |||
257 | b) Convey the object code in, or embodied in, a physical product | ||
258 | (including a physical distribution medium), accompanied by a | ||
259 | written offer, valid for at least three years and valid for as | ||
260 | long as you offer spare parts or customer support for that product | ||
261 | model, to give anyone who possesses the object code either (1) a | ||
262 | copy of the Corresponding Source for all the software in the | ||
263 | product that is covered by this License, on a durable physical | ||
264 | medium customarily used for software interchange, for a price no | ||
265 | more than your reasonable cost of physically performing this | ||
266 | conveying of source, or (2) access to copy the | ||
267 | Corresponding Source from a network server at no charge. | ||
268 | |||
269 | c) Convey individual copies of the object code with a copy of the | ||
270 | written offer to provide the Corresponding Source. This | ||
271 | alternative is allowed only occasionally and noncommercially, and | ||
272 | only if you received the object code with such an offer, in accord | ||
273 | with subsection 6b. | ||
274 | |||
275 | d) Convey the object code by offering access from a designated | ||
276 | place (gratis or for a charge), and offer equivalent access to the | ||
277 | Corresponding Source in the same way through the same place at no | ||
278 | further charge. You need not require recipients to copy the | ||
279 | Corresponding Source along with the object code. If the place to | ||
280 | copy the object code is a network server, the Corresponding Source | ||
281 | may be on a different server (operated by you or a third party) | ||
282 | that supports equivalent copying facilities, provided you maintain | ||
283 | clear directions next to the object code saying where to find the | ||
284 | Corresponding Source. Regardless of what server hosts the | ||
285 | Corresponding Source, you remain obligated to ensure that it is | ||
286 | available for as long as needed to satisfy these requirements. | ||
287 | |||
288 | e) Convey the object code using peer-to-peer transmission, provided | ||
289 | you inform other peers where the object code and Corresponding | ||
290 | Source of the work are being offered to the general public at no | ||
291 | charge under subsection 6d. | ||
292 | |||
293 | A separable portion of the object code, whose source code is excluded | ||
294 | from the Corresponding Source as a System Library, need not be | ||
295 | included in conveying the object code work. | ||
296 | |||
297 | A "User Product" is either (1) a "consumer product", which means any | ||
298 | tangible personal property which is normally used for personal, family, | ||
299 | or household purposes, or (2) anything designed or sold for incorporation | ||
300 | into a dwelling. In determining whether a product is a consumer product, | ||
301 | doubtful cases shall be resolved in favor of coverage. For a particular | ||
302 | product received by a particular user, "normally used" refers to a | ||
303 | typical or common use of that class of product, regardless of the status | ||
304 | of the particular user or of the way in which the particular user | ||
305 | actually uses, or expects or is expected to use, the product. A product | ||
306 | is a consumer product regardless of whether the product has substantial | ||
307 | commercial, industrial or non-consumer uses, unless such uses represent | ||
308 | the only significant mode of use of the product. | ||
309 | |||
310 | "Installation Information" for a User Product means any methods, | ||
311 | procedures, authorization keys, or other information required to install | ||
312 | and execute modified versions of a covered work in that User Product from | ||
313 | a modified version of its Corresponding Source. The information must | ||
314 | suffice to ensure that the continued functioning of the modified object | ||
315 | code is in no case prevented or interfered with solely because | ||
316 | modification has been made. | ||
317 | |||
318 | If you convey an object code work under this section in, or with, or | ||
319 | specifically for use in, a User Product, and the conveying occurs as | ||
320 | part of a transaction in which the right of possession and use of the | ||
321 | User Product is transferred to the recipient in perpetuity or for a | ||
322 | fixed term (regardless of how the transaction is characterized), the | ||
323 | Corresponding Source conveyed under this section must be accompanied | ||
324 | by the Installation Information. But this requirement does not apply | ||
325 | if neither you nor any third party retains the ability to install | ||
326 | modified object code on the User Product (for example, the work has | ||
327 | been installed in ROM). | ||
328 | |||
329 | The requirement to provide Installation Information does not include a | ||
330 | requirement to continue to provide support service, warranty, or updates | ||
331 | for a work that has been modified or installed by the recipient, or for | ||
332 | the User Product in which it has been modified or installed. Access to a | ||
333 | network may be denied when the modification itself materially and | ||
334 | adversely affects the operation of the network or violates the rules and | ||
335 | protocols for communication across the network. | ||
336 | |||
337 | Corresponding Source conveyed, and Installation Information provided, | ||
338 | in accord with this section must be in a format that is publicly | ||
339 | documented (and with an implementation available to the public in | ||
340 | source code form), and must require no special password or key for | ||
341 | unpacking, reading or copying. | ||
342 | |||
343 | 7. Additional Terms. | ||
344 | |||
345 | "Additional permissions" are terms that supplement the terms of this | ||
346 | License by making exceptions from one or more of its conditions. | ||
347 | Additional permissions that are applicable to the entire Program shall | ||
348 | be treated as though they were included in this License, to the extent | ||
349 | that they are valid under applicable law. If additional permissions | ||
350 | apply only to part of the Program, that part may be used separately | ||
351 | under those permissions, but the entire Program remains governed by | ||
352 | this License without regard to the additional permissions. | ||
353 | |||
354 | When you convey a copy of a covered work, you may at your option | ||
355 | remove any additional permissions from that copy, or from any part of | ||
356 | it. (Additional permissions may be written to require their own | ||
357 | removal in certain cases when you modify the work.) You may place | ||
358 | additional permissions on material, added by you to a covered work, | ||
359 | for which you have or can give appropriate copyright permission. | ||
360 | |||
361 | Notwithstanding any other provision of this License, for material you | ||
362 | add to a covered work, you may (if authorized by the copyright holders of | ||
363 | that material) supplement the terms of this License with terms: | ||
364 | |||
365 | a) Disclaiming warranty or limiting liability differently from the | ||
366 | terms of sections 15 and 16 of this License; or | ||
367 | |||
368 | b) Requiring preservation of specified reasonable legal notices or | ||
369 | author attributions in that material or in the Appropriate Legal | ||
370 | Notices displayed by works containing it; or | ||
371 | |||
372 | c) Prohibiting misrepresentation of the origin of that material, or | ||
373 | requiring that modified versions of such material be marked in | ||
374 | reasonable ways as different from the original version; or | ||
375 | |||
376 | d) Limiting the use for publicity purposes of names of licensors or | ||
377 | authors of the material; or | ||
378 | |||
379 | e) Declining to grant rights under trademark law for use of some | ||
380 | trade names, trademarks, or service marks; or | ||
381 | |||
382 | f) Requiring indemnification of licensors and authors of that | ||
383 | material by anyone who conveys the material (or modified versions of | ||
384 | it) with contractual assumptions of liability to the recipient, for | ||
385 | any liability that these contractual assumptions directly impose on | ||
386 | those licensors and authors. | ||
387 | |||
388 | All other non-permissive additional terms are considered "further | ||
389 | restrictions" within the meaning of section 10. If the Program as you | ||
390 | received it, or any part of it, contains a notice stating that it is | ||
391 | governed by this License along with a term that is a further | ||
392 | restriction, you may remove that term. If a license document contains | ||
393 | a further restriction but permits relicensing or conveying under this | ||
394 | License, you may add to a covered work material governed by the terms | ||
395 | of that license document, provided that the further restriction does | ||
396 | not survive such relicensing or conveying. | ||
397 | |||
398 | If you add terms to a covered work in accord with this section, you | ||
399 | must place, in the relevant source files, a statement of the | ||
400 | additional terms that apply to those files, or a notice indicating | ||
401 | where to find the applicable terms. | ||
402 | |||
403 | Additional terms, permissive or non-permissive, may be stated in the | ||
404 | form of a separately written license, or stated as exceptions; | ||
405 | the above requirements apply either way. | ||
406 | |||
407 | 8. Termination. | ||
408 | |||
409 | You may not propagate or modify a covered work except as expressly | ||
410 | provided under this License. Any attempt otherwise to propagate or | ||
411 | modify it is void, and will automatically terminate your rights under | ||
412 | this License (including any patent licenses granted under the third | ||
413 | paragraph of section 11). | ||
414 | |||
415 | However, if you cease all violation of this License, then your | ||
416 | license from a particular copyright holder is reinstated (a) | ||
417 | provisionally, unless and until the copyright holder explicitly and | ||
418 | finally terminates your license, and (b) permanently, if the copyright | ||
419 | holder fails to notify you of the violation by some reasonable means | ||
420 | prior to 60 days after the cessation. | ||
421 | |||
422 | Moreover, your license from a particular copyright holder is | ||
423 | reinstated permanently if the copyright holder notifies you of the | ||
424 | violation by some reasonable means, this is the first time you have | ||
425 | received notice of violation of this License (for any work) from that | ||
426 | copyright holder, and you cure the violation prior to 30 days after | ||
427 | your receipt of the notice. | ||
428 | |||
429 | Termination of your rights under this section does not terminate the | ||
430 | licenses of parties who have received copies or rights from you under | ||
431 | this License. If your rights have been terminated and not permanently | ||
432 | reinstated, you do not qualify to receive new licenses for the same | ||
433 | material under section 10. | ||
434 | |||
435 | 9. Acceptance Not Required for Having Copies. | ||
436 | |||
437 | You are not required to accept this License in order to receive or | ||
438 | run a copy of the Program. Ancillary propagation of a covered work | ||
439 | occurring solely as a consequence of using peer-to-peer transmission | ||
440 | to receive a copy likewise does not require acceptance. However, | ||
441 | nothing other than this License grants you permission to propagate or | ||
442 | modify any covered work. These actions infringe copyright if you do | ||
443 | not accept this License. Therefore, by modifying or propagating a | ||
444 | covered work, you indicate your acceptance of this License to do so. | ||
445 | |||
446 | 10. Automatic Licensing of Downstream Recipients. | ||
447 | |||
448 | Each time you convey a covered work, the recipient automatically | ||
449 | receives a license from the original licensors, to run, modify and | ||
450 | propagate that work, subject to this License. You are not responsible | ||
451 | for enforcing compliance by third parties with this License. | ||
452 | |||
453 | An "entity transaction" is a transaction transferring control of an | ||
454 | organization, or substantially all assets of one, or subdividing an | ||
455 | organization, or merging organizations. If propagation of a covered | ||
456 | work results from an entity transaction, each party to that | ||
457 | transaction who receives a copy of the work also receives whatever | ||
458 | licenses to the work the party's predecessor in interest had or could | ||
459 | give under the previous paragraph, plus a right to possession of the | ||
460 | Corresponding Source of the work from the predecessor in interest, if | ||
461 | the predecessor has it or can get it with reasonable efforts. | ||
462 | |||
463 | You may not impose any further restrictions on the exercise of the | ||
464 | rights granted or affirmed under this License. For example, you may | ||
465 | not impose a license fee, royalty, or other charge for exercise of | ||
466 | rights granted under this License, and you may not initiate litigation | ||
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that | ||
468 | any patent claim is infringed by making, using, selling, offering for | ||
469 | sale, or importing the Program or any portion of it. | ||
470 | |||
471 | 11. Patents. | ||
472 | |||
473 | A "contributor" is a copyright holder who authorizes use under this | ||
474 | License of the Program or a work on which the Program is based. The | ||
475 | work thus licensed is called the contributor's "contributor version". | ||
476 | |||
477 | A contributor's "essential patent claims" are all patent claims | ||
478 | owned or controlled by the contributor, whether already acquired or | ||
479 | hereafter acquired, that would be infringed by some manner, permitted | ||
480 | by this License, of making, using, or selling its contributor version, | ||
481 | but do not include claims that would be infringed only as a | ||
482 | consequence of further modification of the contributor version. For | ||
483 | purposes of this definition, "control" includes the right to grant | ||
484 | patent sublicenses in a manner consistent with the requirements of | ||
485 | this License. | ||
486 | |||
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free | ||
488 | patent license under the contributor's essential patent claims, to | ||
489 | make, use, sell, offer for sale, import and otherwise run, modify and | ||
490 | propagate the contents of its contributor version. | ||
491 | |||
492 | In the following three paragraphs, a "patent license" is any express | ||
493 | agreement or commitment, however denominated, not to enforce a patent | ||
494 | (such as an express permission to practice a patent or covenant not to | ||
495 | sue for patent infringement). To "grant" such a patent license to a | ||
496 | party means to make such an agreement or commitment not to enforce a | ||
497 | patent against the party. | ||
498 | |||
499 | If you convey a covered work, knowingly relying on a patent license, | ||
500 | and the Corresponding Source of the work is not available for anyone | ||
501 | to copy, free of charge and under the terms of this License, through a | ||
502 | publicly available network server or other readily accessible means, | ||
503 | then you must either (1) cause the Corresponding Source to be so | ||
504 | available, or (2) arrange to deprive yourself of the benefit of the | ||
505 | patent license for this particular work, or (3) arrange, in a manner | ||
506 | consistent with the requirements of this License, to extend the patent | ||
507 | license to downstream recipients. "Knowingly relying" means you have | ||
508 | actual knowledge that, but for the patent license, your conveying the | ||
509 | covered work in a country, or your recipient's use of the covered work | ||
510 | in a country, would infringe one or more identifiable patents in that | ||
511 | country that you have reason to believe are valid. | ||
512 | |||
513 | If, pursuant to or in connection with a single transaction or | ||
514 | arrangement, you convey, or propagate by procuring conveyance of, a | ||
515 | covered work, and grant a patent license to some of the parties | ||
516 | receiving the covered work authorizing them to use, propagate, modify | ||
517 | or convey a specific copy of the covered work, then the patent license | ||
518 | you grant is automatically extended to all recipients of the covered | ||
519 | work and works based on it. | ||
520 | |||
521 | A patent license is "discriminatory" if it does not include within | ||
522 | the scope of its coverage, prohibits the exercise of, or is | ||
523 | conditioned on the non-exercise of one or more of the rights that are | ||
524 | specifically granted under this License. You may not convey a covered | ||
525 | work if you are a party to an arrangement with a third party that is | ||
526 | in the business of distributing software, under which you make payment | ||
527 | to the third party based on the extent of your activity of conveying | ||
528 | the work, and under which the third party grants, to any of the | ||
529 | parties who would receive the covered work from you, a discriminatory | ||
530 | patent license (a) in connection with copies of the covered work | ||
531 | conveyed by you (or copies made from those copies), or (b) primarily | ||
532 | for and in connection with specific products or compilations that | ||
533 | contain the covered work, unless you entered into that arrangement, | ||
534 | or that patent license was granted, prior to 28 March 2007. | ||
535 | |||
536 | Nothing in this License shall be construed as excluding or limiting | ||
537 | any implied license or other defenses to infringement that may | ||
538 | otherwise be available to you under applicable patent law. | ||
539 | |||
540 | 12. No Surrender of Others' Freedom. | ||
541 | |||
542 | If conditions are imposed on you (whether by court order, agreement or | ||
543 | otherwise) that contradict the conditions of this License, they do not | ||
544 | excuse you from the conditions of this License. If you cannot convey a | ||
545 | covered work so as to satisfy simultaneously your obligations under this | ||
546 | License and any other pertinent obligations, then as a consequence you may | ||
547 | not convey it at all. For example, if you agree to terms that obligate you | ||
548 | to collect a royalty for further conveying from those to whom you convey | ||
549 | the Program, the only way you could satisfy both those terms and this | ||
550 | License would be to refrain entirely from conveying the Program. | ||
551 | |||
552 | 13. Use with the GNU Affero General Public License. | ||
553 | |||
554 | Notwithstanding any other provision of this License, you have | ||
555 | permission to link or combine any covered work with a work licensed | ||
556 | under version 3 of the GNU Affero General Public License into a single | ||
557 | combined work, and to convey the resulting work. The terms of this | ||
558 | License will continue to apply to the part which is the covered work, | ||
559 | but the special requirements of the GNU Affero General Public License, | ||
560 | section 13, concerning interaction through a network will apply to the | ||
561 | combination as such. | ||
562 | |||
563 | 14. Revised Versions of this License. | ||
564 | |||
565 | The Free Software Foundation may publish revised and/or new versions of | ||
566 | the GNU General Public License from time to time. Such new versions will | ||
567 | be similar in spirit to the present version, but may differ in detail to | ||
568 | address new problems or concerns. | ||
569 | |||
570 | Each version is given a distinguishing version number. If the | ||
571 | Program specifies that a certain numbered version of the GNU General | ||
572 | Public License "or any later version" applies to it, you have the | ||
573 | option of following the terms and conditions either of that numbered | ||
574 | version or of any later version published by the Free Software | ||
575 | Foundation. If the Program does not specify a version number of the | ||
576 | GNU General Public License, you may choose any version ever published | ||
577 | by the Free Software Foundation. | ||
578 | |||
579 | If the Program specifies that a proxy can decide which future | ||
580 | versions of the GNU General Public License can be used, that proxy's | ||
581 | public statement of acceptance of a version permanently authorizes you | ||
582 | to choose that version for the Program. | ||
583 | |||
584 | Later license versions may give you additional or different | ||
585 | permissions. However, no additional obligations are imposed on any | ||
586 | author or copyright holder as a result of your choosing to follow a | ||
587 | later version. | ||
588 | |||
589 | 15. Disclaimer of Warranty. | ||
590 | |||
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY | ||
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT | ||
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY | ||
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, | ||
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM | ||
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF | ||
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. | ||
599 | |||
600 | 16. Limitation of Liability. | ||
601 | |||
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING | ||
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS | ||
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY | ||
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE | ||
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF | ||
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD | ||
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), | ||
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF | ||
610 | SUCH DAMAGES. | ||
611 | |||
612 | 17. Interpretation of Sections 15 and 16. | ||
613 | |||
614 | If the disclaimer of warranty and limitation of liability provided | ||
615 | above cannot be given local legal effect according to their terms, | ||
616 | reviewing courts shall apply local law that most closely approximates | ||
617 | an absolute waiver of all civil liability in connection with the | ||
618 | Program, unless a warranty or assumption of liability accompanies a | ||
619 | copy of the Program in return for a fee. | ||
620 | |||
621 | END OF TERMS AND CONDITIONS | ||
622 | |||
623 | How to Apply These Terms to Your New Programs | ||
624 | |||
625 | If you develop a new program, and you want it to be of the greatest | ||
626 | possible use to the public, the best way to achieve this is to make it | ||
627 | free software which everyone can redistribute and change under these terms. | ||
628 | |||
629 | To do so, attach the following notices to the program. It is safest | ||
630 | to attach them to the start of each source file to most effectively | ||
631 | state the exclusion of warranty; and each file should have at least | ||
632 | the "copyright" line and a pointer to where the full notice is found. | ||
633 | |||
634 | <one line to give the program's name and a brief idea of what it does.> | ||
635 | Copyright (C) <year> <name of author> | ||
636 | |||
637 | This program is free software: you can redistribute it and/or modify | ||
638 | it under the terms of the GNU General Public License as published by | ||
639 | the Free Software Foundation, either version 3 of the License, or | ||
640 | (at your option) any later version. | ||
641 | |||
642 | This program is distributed in the hope that it will be useful, | ||
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
645 | GNU General Public License for more details. | ||
646 | |||
647 | You should have received a copy of the GNU General Public License | ||
648 | along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
649 | |||
650 | Also add information on how to contact you by electronic and paper mail. | ||
651 | |||
652 | If the program does terminal interaction, make it output a short | ||
653 | notice like this when it starts in an interactive mode: | ||
654 | |||
655 | <program> Copyright (C) <year> <name of author> | ||
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. | ||
657 | This is free software, and you are welcome to redistribute it | ||
658 | under certain conditions; type `show c' for details. | ||
659 | |||
660 | The hypothetical commands `show w' and `show c' should show the appropriate | ||
661 | parts of the General Public License. Of course, your program's commands | ||
662 | might be different; for a GUI interface, you would use an "about box". | ||
663 | |||
664 | You should also get your employer (if you work as a programmer) or school, | ||
665 | if any, to sign a "copyright disclaimer" for the program, if necessary. | ||
666 | For more information on this, and how to apply and follow the GNU GPL, see | ||
667 | <http://www.gnu.org/licenses/>. | ||
668 | |||
669 | The GNU General Public License does not permit incorporating your program | ||
670 | into proprietary programs. If your program is a subroutine library, you | ||
671 | may consider it more useful to permit linking proprietary applications with | ||
672 | the library. If this is what you want to do, use the GNU Lesser General | ||
673 | Public License instead of this License. But first, please read | ||
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>. | ||
@@ -0,0 +1,46 @@ | |||
1 | Config::HAProxy | ||
2 | =============== | ||
3 | |||
4 | A parser class that converts the HAProxy configuration file to a parse | ||
5 | tree and provides methods for various operations on this tree, such as: | ||
6 | searching, modifying and saving it to a file. | ||
7 | |||
8 | EXAMPLE | ||
9 | |||
10 | use Config::HAProxy; | ||
11 | |||
12 | # Parse HAProxy configuration file | ||
13 | $cfg = Config::HAProxy->new->parse; | ||
14 | |||
15 | # Print IP addresses and ports of the configured backends | ||
16 | foreach my $srv (map { $_->select(name => 'server') } | ||
17 | $cfg->tree->select(name => 'backend')) { | ||
18 | print $srv->arg(1),"\n"; | ||
19 | } | ||
20 | |||
21 | |||
22 | INSTALLATION | ||
23 | |||
24 | To install this module type the following: | ||
25 | |||
26 | perl Makefile.PL | ||
27 | make | ||
28 | make test | ||
29 | make install | ||
30 | |||
31 | COPYRIGHT AND LICENCE | ||
32 | |||
33 | Copyright (C) 2018 by Sergey Poznyakoff | ||
34 | |||
35 | This library is free software; you can redistribute it and/or modify it | ||
36 | under the terms of the GNU General Public License as published by the | ||
37 | Free Software Foundation; either version 3 of the License, or (at your | ||
38 | option) any later version. | ||
39 | |||
40 | It is distributed in the hope that it will be useful, | ||
41 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
42 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
43 | GNU General Public License for more details. | ||
44 | |||
45 | You should have received a copy of the GNU General Public License along | ||
46 | 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 | |||
@@ -182,10 +182,10 @@ sub save { | |||
182 | $self->backup; | 182 | $self->backup; |
183 | rename($tempfile, $self->filename) | 183 | rename($tempfile, $self->filename) |
184 | or croak "can't rename $tempfile to ".$self->tempfile.": $!"; | 184 | or croak "can't rename $tempfile to ".$self->tempfile.": $!"; |
185 | # This will fail unless we are root, let it be so. | ||
186 | chown $sb->uid, $sb->gid, $self->filename; | ||
187 | # This will succeed: we've created the file, so we're owning it. | 185 | # This will succeed: we've created the file, so we're owning it. |
188 | chmod $sb->mode & 0777, $self->filename; | 186 | chmod $sb->mode & 0777, $self->filename; |
187 | # This will fail unless we are root, let it be so. | ||
188 | chown $sb->uid, $sb->gid, $self->filename; | ||
189 | 189 | ||
190 | $self->tree->clear_dirty | 190 | $self->tree->clear_dirty |
191 | } | 191 | } |
@@ -215,39 +215,90 @@ __END__ | |||
215 | 215 | ||
216 | =head1 NAME | 216 | =head1 NAME |
217 | 217 | ||
218 | Config::HAProxy - HAProxy configuration file | 218 | Config::HAProxy - Parser for HAProxy configuration file |
219 | 219 | ||
220 | =head1 SYNOPSIS | 220 | =head1 SYNOPSIS |
221 | 221 | ||
222 | use Config::HAProxy; | 222 | use Config::HAProxy; |
223 | $cfg = new Config::HAProxy($filename); | 223 | $cfg = new Config::HAProxy($filename); |
224 | $cfg->parse; | 224 | $cfg->parse; |
225 | 225 | ||
226 | $name = $cfg->filename; | 226 | $name = $cfg->filename; |
227 | 227 | ||
228 | @frontends = $cfg->select(name => 'frontend'); | 228 | @frontends = $cfg->select(name => 'frontend'); |
229 | 229 | ||
230 | $itr = $cfg->iterator(inorder => 1); | 230 | $itr = $cfg->iterator(inorder => 1); |
231 | while (defined($node = $itr->next)) { | 231 | while (defined($node = $itr->next)) { |
232 | # do something with $node | 232 | # do something with $node |
233 | } | 233 | } |
234 | 234 | ||
235 | $cfg->save; | 235 | $cfg->save; |
236 | 236 | ||
237 | $cfg->write($file_or_handle); | 237 | $cfg->write($file_or_handle); |
238 | 238 | ||
239 | $cfg->backup; | 239 | $cfg->backup; |
240 | $name = $self->backup_name; | 240 | $name = $self->backup_name; |
241 | 241 | ||
242 | $cfg->reset; | 242 | $cfg->reset; |
243 | $cfg->push($node); | 243 | $cfg->push($node); |
244 | $node = $cfg->pop; | 244 | $node = $cfg->pop; |
245 | $node = $cfg->tos; | 245 | $node = $cfg->tos; |
246 | $node = $cfg->tree; | 246 | $node = $cfg->tree; |
247 | 247 | ||
248 | =head1 DESCRIPTION | 248 | =head1 DESCRIPTION |
249 | 249 | ||
250 | FIXME | 250 | The B<Config::HAProxy> class is a parser that converts the B<HAProxy> |
251 | configuration file to a parse tree and provides methods for various | ||
252 | operations on this tree, such as: searching, modifying and saving it | ||
253 | to a file. | ||
254 | |||
255 | An object of this class contains a I<parse tree> representing the | ||
256 | configuration read from the file (or created from scratch). Nodes in the | ||
257 | tree can be of four distinct classes: | ||
258 | |||
259 | =over 4 | ||
260 | |||
261 | =item Empty | ||
262 | |||
263 | Represents an empty line. | ||
264 | |||
265 | =item Comment | ||
266 | |||
267 | Represents a comment line. | ||
268 | |||
269 | =item Statement | ||
270 | |||
271 | Represents a simple statement. | ||
272 | |||
273 | =item Section | ||
274 | |||
275 | A container, representing a C<compound statement>, i.e. a statement that | ||
276 | contains multiple sub-statements. Compound statements are: B<global>, | ||
277 | B<defaults>, B<frontend>, and B<backend>. | ||
278 | |||
279 | =back | ||
280 | |||
281 | In addition to these four classes, a special class B<Root> is provided, which | ||
282 | represents the topmost node in the parse tree (i.e. the parent of other nodes). | ||
283 | |||
284 | A set of attributes is associated with each node. Among these, the B<orig> | ||
285 | attribute contains the original line from the configuration file that triggered | ||
286 | creation of this node, and B<locus> contains the location of this line (or | ||
287 | lines, for sections) in the configuration file (as a B<Text::Locus>) object. | ||
288 | |||
289 | These two attributes are meaningful for all nodes. For statement nodes (simple | ||
290 | statements and sections) the B<kw> attribute contains the statement I<keyword>, | ||
291 | and the B<argv> attribute - its arguments. For example, the statement | ||
292 | |||
293 | server localhost 127.0.0.1:8080 | ||
294 | |||
295 | is represented by a node of class B<Config::HAProxy::Node::Statement>, with | ||
296 | C<server> as B<kw> and list (C<localhost>, C<127.0.0.1:8080>) as B<argv>. | ||
297 | |||
298 | Additionally, section nodes provide methods for accessing their subtrees. | ||
299 | |||
300 | For a detailed description of the node class and its methods, please refer to | ||
301 | B<Config::HAProxy::Node>. | ||
251 | 302 | ||
252 | =head1 CONSTRUCTOR | 303 | =head1 CONSTRUCTOR |
253 | 304 | ||
@@ -257,15 +308,23 @@ Creates and returns a new object for manipulating the HAProxy configuration. | |||
257 | Optional B<$filename> specifies the name of the file to read configuration | 308 | Optional B<$filename> specifies the name of the file to read configuration |
258 | from. It defaults to F</etc/haproxy/haproxy.cfg>. | 309 | from. It defaults to F</etc/haproxy/haproxy.cfg>. |
259 | 310 | ||
260 | =head1 THE PARSE TREE | 311 | =head2 filename |
312 | |||
313 | $s = $cfg->filename; | ||
314 | |||
315 | Returns the configuration file name given when creating the object. | ||
316 | |||
317 | =head1 PARSING | ||
261 | 318 | ||
262 | =head2 parse | 319 | =head2 parse |
263 | 320 | ||
264 | $cfg->parse; | 321 | $cfg->parse; |
265 | 322 | ||
266 | Reads and parses the configuration file. Croaks if the file does not exist. | 323 | Reads and parses the configuration file. Croaks if the file does not exist. |
324 | Returns B<$cfg>. | ||
267 | 325 | ||
268 | 326 | =head1 BUILDING THE PARSE TREE | |
327 | |||
269 | =head2 reset | 328 | =head2 reset |
270 | 329 | ||
271 | $cfg->reset; | 330 | $cfg->reset; |
@@ -305,7 +364,7 @@ Returns the last node in the tree. | |||
305 | 364 | ||
306 | $cfg->save; | 365 | $cfg->save; |
307 | 366 | ||
308 | Saves the configuration file. | 367 | Saves the parse tree in the configuration file. |
309 | 368 | ||
310 | =head2 write | 369 | =head2 write |
311 | 370 | ||
@@ -327,3 +386,34 @@ Normally, comments retain their original indentation. However, if the | |||
327 | key B<reintent_comments> is present, and its value is evaluated as true, | 386 | key B<reintent_comments> is present, and its value is evaluated as true, |
328 | then comments are reindented following the rules described above. | 387 | then comments are reindented following the rules described above. |
329 | 388 | ||
389 | =head1 SEE ALSO | ||
390 | |||
391 | B<Config::HAProxy::Node>, | ||
392 | B<Config::HAProxy::Node::Section>, | ||
393 | B<Config::HAProxy::Node::Statement>, | ||
394 | B<Config::HAProxy::Iterator>. | ||
395 | |||
396 | =head1 AUTHOR | ||
397 | |||
398 | Sergey Poznyakoff, E<lt>gray@gnu.orgE<gt> | ||
399 | |||
400 | =head1 COPYRIGHT AND LICENSE | ||
401 | |||
402 | Copyright (C) 2018 by Sergey Poznyakoff | ||
403 | |||
404 | This library is free software; you can redistribute it and/or modify it | ||
405 | under the terms of the GNU General Public License as published by the | ||
406 | Free Software Foundation; either version 3 of the License, or (at your | ||
407 | option) any later version. | ||
408 | |||
409 | It is distributed in the hope that it will be useful, | ||
410 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
411 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
412 | GNU General Public License for more details. | ||
413 | |||
414 | You should have received a copy of the GNU General Public License along | ||
415 | with this library. If not, see <http://www.gnu.org/licenses/>. | ||
416 | |||
417 | =cut | ||
418 | |||
419 | |||
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 | |||
@@ -63,6 +63,74 @@ sub next { | |||
63 | } | 63 | } |
64 | 64 | ||
65 | 1; | 65 | 1; |
66 | __END__ | ||
67 | |||
68 | =head1 NAME | ||
69 | |||
70 | Config::HAProxy::Iterator - Iterate over objects in the parse tree | ||
71 | |||
72 | =head1 SYNOPSIS | ||
73 | |||
74 | $cfg = Config::HAProxy->new->parse; | ||
75 | $itr = $cfg->iterator(inorder => 1); | ||
76 | while (defined(my $node = $itr->next)) { | ||
77 | # Do something with $node | ||
78 | } | ||
79 | |||
80 | =head1 DESCRIPTION | ||
81 | |||
82 | The iterator object provides a method for iterating over all nodes in the | ||
83 | HAProxy parse tree. The object is returned by the B<iterator> method of | ||
84 | B<Config::HAProxy> and B<Config::HAProxy::Node> objects. The method takes | ||
85 | as optional argument the keyword specifying the order in which the tree nodes | ||
86 | should be traversed. This keyword can be one of the following: | ||
87 | |||
88 | =over 4 | ||
89 | |||
90 | =item B<recursive =E<gt> 0> | ||
91 | |||
92 | No recursion. The traversal will not descend into section nodes. This is the | ||
93 | default. | ||
94 | |||
95 | =item B<inorder =E<gt> 1> | ||
96 | |||
97 | The nodes will be traversed in the inorder manner, i.e. the section node | ||
98 | will be visited first, and all its sub-nodes after it. | ||
99 | |||
100 | =item B<postorder =E<gt> 1> | ||
101 | |||
102 | The nodes will be traversed in the postorder manner, i.e. for each section | ||
103 | node, its sub-nodes will be visited first, and the node itself afterward. | ||
104 | |||
105 | =back | ||
106 | |||
107 | =head1 CONSTRUCTOR | ||
108 | |||
109 | Note: This section is informative. You never need to create | ||
110 | B<Config::HAProxy::Iterator> objects explicitly. Please use the B<iterator> | ||
111 | method of B<Config::HAProxy> or B<Config::HAProxy::Node> class objects. | ||
112 | |||
113 | $itr = new Config::HAProxy::Iterator($node, %rec); | ||
114 | |||
115 | Returns new iterator object for traversing the tree starting from B<$node>, | ||
116 | which must be a B<Config::HAProxy::Node> object. Optional B<%rec> is one of | ||
117 | the keywords discussed above, in section B<DESCRIPTION>. | ||
118 | |||
119 | =head1 METHODS | ||
120 | |||
121 | =head2 next | ||
122 | |||
123 | $node = $itr->next; | ||
124 | |||
125 | Returns next node in the traversal sequence. If all nodes were visited, returns | ||
126 | B<undef>. | ||
127 | |||
128 | =head1 SEE ALSO | ||
129 | |||
130 | B<HAProxy::Config>, B<HAProxy::Config::Node>. | ||
131 | |||
132 | =cut | ||
133 | |||
66 | 134 | ||
67 | 135 | ||
68 | 136 | ||
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 | |||
@@ -97,3 +97,140 @@ sub is_empty { 0 } | |||
97 | sub is_comment { 0 } | 97 | sub is_comment { 0 } |
98 | 98 | ||
99 | 1; | 99 | 1; |
100 | __END__ | ||
101 | |||
102 | =head1 NAME | ||
103 | |||
104 | Config::HAProxy::Node - Abstract HAProxy configuration node | ||
105 | |||
106 | =head1 DESCRIPTION | ||
107 | |||
108 | The class B<Config::HAProxy::Node> represents an abstract node in the | ||
109 | HAProxy configuration parse tree. It serves as a base class for classes | ||
110 | representing configuration tree, section, simple statement, comment and | ||
111 | empty line. | ||
112 | |||
113 | =head1 CONSTRUCTOR | ||
114 | |||
115 | $obj = new Config::HAProxy::Node(%args); | ||
116 | |||
117 | Returns new object. B<%args> can contain the following keys: | ||
118 | |||
119 | =over 4 | ||
120 | |||
121 | =item B<kw> | ||
122 | |||
123 | Configuration keyword (string), | ||
124 | |||
125 | =item B<argv> | ||
126 | |||
127 | Reference to the list of arguments. | ||
128 | |||
129 | =item B<orig> | ||
130 | |||
131 | Original text as read from the configuration file. | ||
132 | |||
133 | =item B<locus> | ||
134 | |||
135 | Locus (a B<Text::Locus> object) where this statement occurred. | ||
136 | |||
137 | =item B<parent> | ||
138 | |||
139 | Parent node. | ||
140 | |||
141 | =back | ||
142 | |||
143 | =head1 METHODS | ||
144 | |||
145 | =head2 B<kw>, B<argv>, B<orig>, B<locus>, B<parent> | ||
146 | |||
147 | These methods return the corresponding field of the node. When called | ||
148 | with an argument, they set the field prior to returning it. The B<argv> | ||
149 | method returns array of strings and takes as its argument a reference to | ||
150 | the array of strings: | ||
151 | |||
152 | @a = $node->argv; | ||
153 | |||
154 | $node->argv([@a]); | ||
155 | |||
156 | =head2 index | ||
157 | |||
158 | Index (0-based) of this node in the parent node. | ||
159 | |||
160 | =head2 arg | ||
161 | |||
162 | $a = $node->arg($n) | ||
163 | |||
164 | Returns the B<$n>th argument (0-based) from the argument list. | ||
165 | |||
166 | =head2 drop | ||
167 | |||
168 | $node->drop; | ||
169 | |||
170 | Removes this node and destroys it. | ||
171 | |||
172 | =head2 iterator | ||
173 | |||
174 | $itr = $node->iterator(@args); | ||
175 | |||
176 | Returns the iterator for this node. See B<Config::HAProxy::Iterator> for | ||
177 | a detailed discussion. | ||
178 | |||
179 | =head2 depth | ||
180 | |||
181 | $n = $node->depth; | ||
182 | |||
183 | Returns the depth of this node in the configuration tree. Depth is the | ||
184 | number of parent nodes between the root of tree and this node. Top-level | ||
185 | nodes have depth 0. | ||
186 | |||
187 | =head2 root | ||
188 | |||
189 | $root_node = $node->root; | ||
190 | |||
191 | Returns the root node of the parse tree this node belongs to. | ||
192 | |||
193 | =head2 as_string | ||
194 | |||
195 | $s = $node->as_string; | ||
196 | |||
197 | Returns canonical string representation of this node. The canonical | ||
198 | representation consists of the keyword followed by arguments delimited | ||
199 | with horizontal space characters. | ||
200 | |||
201 | =head1 ABSTRACT METHODS | ||
202 | |||
203 | Derived classes must overload at least one of the following methods: | ||
204 | |||
205 | =head2 is_root | ||
206 | |||
207 | True if the node is a root node, false otherwise. | ||
208 | |||
209 | =head2 is_section | ||
210 | |||
211 | True if the node represents a section (i.e. contains subnodes). | ||
212 | |||
213 | =head2 is_statement | ||
214 | |||
215 | True if the node is a simple statement. | ||
216 | |||
217 | =head2 is_empty | ||
218 | |||
219 | True if the node represents an empty line. | ||
220 | |||
221 | =head2 is_comment | ||
222 | |||
223 | True if the node represents a comment. | ||
224 | |||
225 | =head1 SEE ALSO | ||
226 | |||
227 | B<Config::HAProxy::Node::Comment>, | ||
228 | B<Config::HAProxy::Node::Empty>, | ||
229 | B<Config::HAProxy::Node::Root>, | ||
230 | B<Config::HAProxy::Node::Section>, | ||
231 | B<Config::HAProxy::Node::Statement>, | ||
232 | B<Config::HAProxy::Iterator>, | ||
233 | B<Config::HAProxy>, | ||
234 | B<Text::Locus>. | ||
235 | |||
236 | =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 @@ | |||
1 | package Config::HAProxy::Node::Comment; | 1 | package Config::HAProxy::Node::Comment; |
2 | use parent 'Config::HAProxy::Node'; | 2 | use parent 'Config::HAProxy::Node'; |
3 | 3 | ||
4 | =head1 NAME | ||
5 | |||
6 | Config::HAProxy::Node::Comment - comment node in HAProxy configuration | ||
7 | |||
8 | =head1 DESCRIPTION | ||
9 | |||
10 | Objects of this class represent comments in HAProxy configuration file. | ||
11 | |||
12 | =head1 METHODS | ||
13 | |||
14 | =head2 is_comment | ||
15 | |||
16 | Returns true. | ||
17 | |||
18 | =head2 orig | ||
19 | |||
20 | Returns original line as it appeared in the configuration file. | ||
21 | |||
22 | =head2 locus | ||
23 | |||
24 | Returns the location of this statement in the configuration file (the | ||
25 | B<Text::Locus> object). | ||
26 | |||
27 | =head1 SEE ALSO | ||
28 | |||
29 | B<Config::HAProxy::Node>, B<Text::Locus>. | ||
30 | |||
31 | =cut | ||
32 | |||
4 | sub is_comment { 1 } | 33 | sub is_comment { 1 } |
5 | 34 | ||
6 | 1; | 35 | 1; |
36 | |||
37 | |||
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 @@ | |||
1 | package Config::HAProxy::Node::Empty; | 1 | package Config::HAProxy::Node::Empty; |
2 | use parent 'Config::HAProxy::Node'; | 2 | use parent 'Config::HAProxy::Node'; |
3 | 3 | ||
4 | =head1 NAME | ||
5 | |||
6 | Config::HAProxy::Node::Empty - empty HAProxy configuration node | ||
7 | |||
8 | =head1 DESCRIPTION | ||
9 | |||
10 | Objects of this class represent empty lines in HAProxy configuration file. | ||
11 | |||
12 | =head1 METHODS | ||
13 | |||
14 | =head2 is_empty | ||
15 | |||
16 | Always true. | ||
17 | |||
18 | =head2 orig | ||
19 | |||
20 | Returns original line as it appeared in the configuration file. | ||
21 | |||
22 | =head2 locus | ||
23 | |||
24 | Returns the location of this statement in the configuration file (the | ||
25 | B<Text::Locus> object). | ||
26 | |||
27 | =head1 SEE ALSO | ||
28 | |||
29 | B<Config::HAProxy::Node>, B<Text::Locus>. | ||
30 | |||
31 | =cut | ||
32 | |||
4 | sub is_empty { 1 } | 33 | sub is_empty { 1 } |
5 | 34 | ||
6 | 1; | 35 | 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 | |||
@@ -4,6 +4,19 @@ use warnings; | |||
4 | use parent 'Config::HAProxy::Node::Section'; | 4 | use parent 'Config::HAProxy::Node::Section'; |
5 | use Carp; | 5 | use Carp; |
6 | 6 | ||
7 | =head1 NAME | ||
8 | |||
9 | Config::HAProxy::Node::Root - root node of HAProxy configuration parse tree | ||
10 | |||
11 | =head1 DESCRIPTION | ||
12 | |||
13 | Objects of this class represent the topmost node in HAProxy configuration tree. | ||
14 | Each parse tree contains exactly one object of this class. This node can be | ||
15 | reached from every node in the tree by following its B<parent> attribute | ||
16 | and is returned by the B<tree> method of B<Config::HAProxy> class. | ||
17 | |||
18 | =cut | ||
19 | |||
7 | sub new { | 20 | sub new { |
8 | my $class = shift; | 21 | my $class = shift; |
9 | my $self = $class->SUPER::new(@_); | 22 | my $self = $class->SUPER::new(@_); |
@@ -11,21 +24,58 @@ sub new { | |||
11 | return $self; | 24 | return $self; |
12 | } | 25 | } |
13 | 26 | ||
27 | =head1 METHODS | ||
28 | |||
29 | =head2 is_root | ||
30 | |||
31 | Always true. | ||
32 | |||
33 | =head2 is_dirty | ||
34 | |||
35 | $bool = $node->is_dirty; | ||
36 | |||
37 | Returns true if the tree is C<dirty>, i.e. it was modified since it has been | ||
38 | created from the disk configuration file. | ||
39 | |||
40 | =cut | ||
41 | |||
14 | sub is_dirty { | 42 | sub is_dirty { |
15 | my $self = shift; | 43 | my $self = shift; |
16 | return $self->{dirty} | 44 | return $self->{dirty} |
17 | } | 45 | } |
18 | 46 | ||
47 | =head2 mark_dirty | ||
48 | |||
49 | $node->mark_dirty; | ||
50 | |||
51 | Sets the C<dirty> attribute. | ||
52 | |||
53 | =cut | ||
54 | |||
19 | sub mark_dirty { | 55 | sub mark_dirty { |
20 | my $self = shift; | 56 | my $self = shift; |
21 | $self->{dirty} = 1; | 57 | $self->{dirty} = 1; |
22 | } | 58 | } |
23 | 59 | ||
60 | =head2 clear_dirty | ||
61 | |||
62 | $node->clear_dirty; | ||
63 | |||
64 | Clears the C<dirty> attribute. | ||
65 | |||
66 | =cut | ||
67 | |||
24 | sub clear_dirty { | 68 | sub clear_dirty { |
25 | my $self = shift; | 69 | my $self = shift; |
26 | $self->{dirty} = 0; | 70 | $self->{dirty} = 0; |
27 | } | 71 | } |
28 | 72 | ||
73 | =head1 SEE ALSO | ||
74 | |||
75 | B<Config::HAProxy::Node>. | ||
76 | |||
77 | =cut | ||
78 | |||
29 | 1; | 79 | 1; |
30 | 80 | ||
31 | 81 | ||
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 | |||
@@ -4,6 +4,18 @@ use warnings; | |||
4 | use parent 'Config::HAProxy::Node'; | 4 | use parent 'Config::HAProxy::Node'; |
5 | use Carp; | 5 | use Carp; |
6 | 6 | ||
7 | =head1 NAME | ||
8 | |||
9 | Config::HAProxy::Node::Section - HAProxy configuration section | ||
10 | |||
11 | =head1 DESCRIPTION | ||
12 | |||
13 | Objects of this class represent a C<section> in the HAProxy configuration file. | ||
14 | A section is a statement that can contain sub-statements. The following | ||
15 | statements form sections: B<global>, B<defaults>, B<frontend>, and B<backend>. | ||
16 | |||
17 | =cut | ||
18 | |||
7 | sub new { | 19 | sub new { |
8 | my $class = shift; | 20 | my $class = shift; |
9 | my $self = $class->SUPER::new(@_); | 21 | my $self = $class->SUPER::new(@_); |
@@ -11,8 +23,51 @@ sub new { | |||
11 | return $self; | 23 | return $self; |
12 | } | 24 | } |
13 | 25 | ||
26 | =head1 ATTRIBUTES | ||
27 | |||
28 | =head2 is_section | ||
29 | |||
30 | Always true. | ||
31 | |||
32 | =cut | ||
33 | |||
14 | sub is_section { 1 } | 34 | sub is_section { 1 } |
15 | 35 | ||
36 | =head1 METHODS | ||
37 | |||
38 | =head2 kw | ||
39 | |||
40 | Returns the configuration keyword. | ||
41 | |||
42 | =head2 argv | ||
43 | |||
44 | Returns the list of arguments to the configuration keyword. | ||
45 | |||
46 | =head2 arg | ||
47 | |||
48 | $s = $node->arg($n) | ||
49 | |||
50 | Returns the B<$n>th argument. | ||
51 | |||
52 | =head2 orig | ||
53 | |||
54 | Returns original line as it appeared in the configuration file. | ||
55 | |||
56 | =head2 locus | ||
57 | |||
58 | Returns the location of this statement in the configuration file (the | ||
59 | B<Text::Locus> object). | ||
60 | |||
61 | =head2 append_node | ||
62 | |||
63 | $section->append_node(@nodes); | ||
64 | |||
65 | Takes a list of objects of B<Config::HAProxy::Node> derived classes as | ||
66 | arguments. Adds these objects after the last node in the subtree in this | ||
67 | section. | ||
68 | |||
69 | =cut | ||
70 | |||
16 | sub append_node { | 71 | sub append_node { |
17 | my $self = shift; | 72 | my $self = shift; |
18 | my $n = @{$self->{_tree}}; | 73 | my $n = @{$self->{_tree}}; |
@@ -24,6 +79,15 @@ sub append_node { | |||
24 | } @_; | 79 | } @_; |
25 | } | 80 | } |
26 | 81 | ||
82 | =head2 append_node_nonempty | ||
83 | |||
84 | $section->append_node_nonempty(@nodes); | ||
85 | |||
86 | Same as B<append_node>, but adds new nodes after the last non-empty | ||
87 | node in the subtree. | ||
88 | |||
89 | =cut | ||
90 | |||
27 | sub append_node_nonempty { | 91 | sub append_node_nonempty { |
28 | my $self = shift; | 92 | my $self = shift; |
29 | my $n = $#{$self->{_tree}}; | 93 | my $n = $#{$self->{_tree}}; |
@@ -32,7 +96,15 @@ sub append_node_nonempty { | |||
32 | } | 96 | } |
33 | $self->insert_node($n+1, @_); | 97 | $self->insert_node($n+1, @_); |
34 | } | 98 | } |
35 | 99 | ||
100 | =head2 insert_node | ||
101 | |||
102 | $section->insert_node($idx, @nodes); | ||
103 | |||
104 | Inserts B<@nodes> after subnode in position B<$idx> (0-based). | ||
105 | |||
106 | =cut | ||
107 | |||
36 | sub insert_node { | 108 | sub insert_node { |
37 | my $self = shift; | 109 | my $self = shift; |
38 | my $n = shift; | 110 | my $n = shift; |
@@ -48,6 +120,14 @@ sub insert_node { | |||
48 | } | 120 | } |
49 | } | 121 | } |
50 | 122 | ||
123 | =head2 delete_node | ||
124 | |||
125 | $section->delete_node($i); | ||
126 | |||
127 | Deletes B<$i>th subnode from the B<$section>. | ||
128 | |||
129 | =cut | ||
130 | |||
51 | sub delete_node { | 131 | sub delete_node { |
52 | my ($self, $n) = @_; | 132 | my ($self, $n) = @_; |
53 | splice @{$self->{_tree}}, $n, 1; | 133 | splice @{$self->{_tree}}, $n, 1; |
@@ -57,6 +137,18 @@ sub delete_node { | |||
57 | $self->root->mark_dirty; | 137 | $self->root->mark_dirty; |
58 | } | 138 | } |
59 | 139 | ||
140 | =head2 tree | ||
141 | |||
142 | @nodes = $section->tree; | ||
143 | |||
144 | Returns subnodes as a list of B<Config::HAProxy::Node> derived objects. | ||
145 | |||
146 | $node = $section->tree($i); | ||
147 | |||
148 | Returns B<$i>th subnode from the B<$section>. | ||
149 | |||
150 | =cut | ||
151 | |||
60 | sub tree { | 152 | sub tree { |
61 | my ($self, $n) = @_; | 153 | my ($self, $n) = @_; |
62 | if ($n) { | 154 | if ($n) { |
@@ -66,6 +158,15 @@ sub tree { | |||
66 | return @{shift->{_tree}} | 158 | return @{shift->{_tree}} |
67 | }; | 159 | }; |
68 | 160 | ||
161 | =head2 ends_in_empty | ||
162 | |||
163 | $bool = $section->ends_in_empty | ||
164 | |||
165 | Returns true if the last node in the list of sub-nodes in B<$section> is | ||
166 | an empty node. | ||
167 | |||
168 | =cut | ||
169 | |||
69 | sub ends_in_empty { | 170 | sub ends_in_empty { |
70 | my $self = shift; | 171 | my $self = shift; |
71 | while ($self->is_section) { | 172 | while ($self->is_section) { |
@@ -110,6 +211,50 @@ my %match = ( | |||
110 | } | 211 | } |
111 | ); | 212 | ); |
112 | 213 | ||
214 | =head2 select | ||
215 | |||
216 | @nodes = $section->select(%cond); | ||
217 | |||
218 | Returns nodes from B<$section> that match conditions in B<%cond>. Valid | ||
219 | conditions are: | ||
220 | |||
221 | =over 4 | ||
222 | |||
223 | =item B<name =E<gt>> I<$s> | ||
224 | |||
225 | Node matches if its keyword (B<kw>) equals I<$s>. | ||
226 | |||
227 | =item B<arg =E<gt>> B<{ n =E<gt>> I<$n>, B<v> =E<gt> I<$s> B<}> | ||
228 | |||
229 | Node mathches if its I<$n>th argument equals I<$s>. | ||
230 | |||
231 | =item B<section =E<gt>> I<$bool> | ||
232 | |||
233 | Node matches if it is (or is not, if I<$bool> is false) a section. | ||
234 | |||
235 | =item B<statement =E<gt>> I<$bool> | ||
236 | |||
237 | Node matches if it is (not) a simple statement. | ||
238 | |||
239 | =item B<comment =E<gt>> I<$bool> | ||
240 | |||
241 | Node matches if it is (not) a comment. | ||
242 | |||
243 | =back | ||
244 | |||
245 | Multiple conditions are checked in the order of their appearance in the | ||
246 | argument list and are joined by the short-circuit logical C<and>. | ||
247 | |||
248 | For example, to return all B<frontend> statements: | ||
249 | |||
250 | @fe = $section->select(name => 'frontend'); | ||
251 | |||
252 | To return the frontend named C<in>: | ||
253 | |||
254 | ($fe) = $section->select( name => 'frontend', | ||
255 | arg => { n => 0, v => 'in' } ); | ||
256 | |||
257 | =cut | ||
113 | 258 | ||
114 | sub select { | 259 | sub select { |
115 | my $self = shift; | 260 | my $self = shift; |
@@ -138,6 +283,12 @@ sub _test_node { | |||
138 | return 1; | 283 | return 1; |
139 | } | 284 | } |
140 | 285 | ||
286 | =head1 SEE ALSO | ||
287 | |||
288 | B<Config::HAProxy::Node>, B<Config::HAProxy>, B<Text::Locus>. | ||
289 | |||
290 | =cut | ||
291 | |||
141 | 1; | 292 | 1; |
142 | 293 | ||
143 | 294 | ||
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 @@ | |||
1 | package Config::HAProxy::Node::Statement; | 1 | package Config::HAProxy::Node::Statement; |
2 | use parent 'Config::HAProxy::Node'; | 2 | use parent 'Config::HAProxy::Node'; |
3 | 3 | ||
4 | =head1 NAME | ||
5 | |||
6 | Config::HAProxy::Node::Statement - simple statement node in HAProxy tree | ||
7 | |||
8 | =head1 DESCRIPTION | ||
9 | |||
10 | Objects of this class represent simple statements in HAProxy configuration | ||
11 | file. A C<simple statement> is any statement excepting: B<global>, B<defaults>, | ||
12 | B<frontend>, and B<backend>. | ||
13 | |||
14 | =head1 METHODS | ||
15 | |||
16 | =head2 is_statement | ||
17 | |||
18 | Returns true. | ||
19 | |||
20 | =head2 kw | ||
21 | |||
22 | Returns the configuration keyword. | ||
23 | |||
24 | =head2 argv | ||
25 | |||
26 | Returns the list of arguments to the configuration keyword. | ||
27 | |||
28 | =head2 arg | ||
29 | |||
30 | $s = $node->arg($n) | ||
31 | |||
32 | Returns the B<$n>th argument. | ||
33 | |||
34 | =head2 orig | ||
35 | |||
36 | Returns original line as it appeared in the configuration file. | ||
37 | |||
38 | =head2 locus | ||
39 | |||
40 | Returns the location of this statement in the configuration file (the | ||
41 | B<Text::Locus> object). | ||
42 | |||
43 | =head1 SEE ALSO | ||
44 | |||
45 | B<Config::HAProxy::Node>, B<Config::HAProxy>, B<Text::Locus>. | ||
46 | |||
47 | =cut | ||
48 | |||
4 | sub is_statement { 1 } | 49 | sub is_statement { 1 } |
5 | 50 | ||
6 | 1; | 51 | 1; |