├── .deps ├── LICENSE ├── Makefile ├── README.md ├── mod_pgconn.c ├── mod_pgconn.h └── modules.mk /.deps: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/crtsh/mod_pgconn/13ab9384d507c68250b0fe58df8a908605e5d2fc/.deps -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 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 . 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 | {project} Copyright (C) {year} {fullname} 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 | . 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 | . 675 | 676 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | builddir=. 2 | top_srcdir=/usr/lib/apache2 3 | top_builddir=${top_srcdir} 4 | include ${top_srcdir}/build/special.mk 5 | builddir=. 6 | 7 | # the used tools 8 | APXS=apxs 9 | APACHECTL=apachectl 10 | 11 | # additional defines, includes and libraries 12 | LDFLAGS=-lpq 13 | 14 | # the default target 15 | all: local-shared-build 16 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mod_pgconn 2 | PostgreSQL connection pooling for httpd 3 | -------------------------------------------------------------------------------- /mod_pgconn.c: -------------------------------------------------------------------------------- 1 | /* mod_pgconn - An httpd module for PostgreSQL connection pooling 2 | * Written by Rob Stradling 3 | * Copyright (C) 2003-2020 Sectigo Limited 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | 19 | #include 20 | #include 21 | #include 22 | #include 23 | 24 | #include "mod_pgconn.h" 25 | 26 | 27 | /****************************************************************************** 28 | * getPGconnContainerByName() * 29 | * Finds the container with the given name. * 30 | * * 31 | * IN: v_PGconnServerConfig - the server config that points to the start of * 32 | * the container list to search. * 33 | * v_connectionName - the connection name to search for. * 34 | * * 35 | * Returns: pointer to the container, or... * 36 | * NULL, if the connection name was not found. * 37 | ******************************************************************************/ 38 | static tPGconnContainer* getPGconnContainerByName( 39 | const tPGconnServerConfig* v_PGconnServerConfig, 40 | const char* v_connectionName 41 | ) 42 | { 43 | if ((!v_PGconnServerConfig) || (!v_connectionName)) 44 | return NULL; 45 | 46 | tPGconnContainer* t_PGconnContainer; 47 | for (t_PGconnContainer = v_PGconnServerConfig->m_first_PGconnContainer; 48 | t_PGconnContainer; 49 | t_PGconnContainer = t_PGconnContainer->m_next) 50 | if (!strcasecmp(t_PGconnContainer->m_name, v_connectionName)) 51 | return t_PGconnContainer; 52 | 53 | return NULL; 54 | } 55 | 56 | 57 | /****************************************************************************** 58 | * openPGconn() * 59 | * Opens a new PostgreSQL connection. This function should only be called * 60 | * as the PGconn* resource list constructor. * 61 | * * 62 | * IN: v_PGconnContainer - connection container details. * 63 | * v_pool - pool to use for memory allocation. * 64 | * * 65 | * OUT: v_PGconn - connection record pointer. * 66 | * * 67 | * Returns: APR_SUCCESS - if the connection was opened successfully. * 68 | * APR_EGENERAL - if the connection could not be opened. * 69 | ******************************************************************************/ 70 | static apr_status_t openPGconn( 71 | void** v_PGconn, 72 | void* v_PGconnContainer, 73 | apr_pool_t* v_pool_unused 74 | ) 75 | { 76 | /* Check and initialize the connection pointer */ 77 | if ((!v_PGconn) || (!v_PGconnContainer)) 78 | return APR_EGENERAL; 79 | *v_PGconn = NULL; 80 | 81 | /* Open a PostgreSQL connection */ 82 | PGconn* t_PGconn = PQconnectdb( 83 | ((tPGconnContainer*)v_PGconnContainer)->m_connInfo 84 | ); 85 | if (!t_PGconn) 86 | return APR_EGENERAL; /* Out of memory! */ 87 | 88 | /* Check that the connection was opened successfully */ 89 | if (PQstatus(t_PGconn) != CONNECTION_OK) { 90 | ap_log_error( 91 | APLOG_MARK, APLOG_ERR, 0, NULL, 92 | "PQconnectdb() error: %s", PQerrorMessage(t_PGconn) 93 | ); 94 | PQfinish(t_PGconn); 95 | return APR_EGENERAL; 96 | } 97 | else { 98 | (*(PGconn**)v_PGconn) = t_PGconn; 99 | return APR_SUCCESS; 100 | } 101 | } 102 | 103 | 104 | /****************************************************************************** 105 | * openPGconn_tracing() * 106 | * Opens a new PostgreSQL connection, outputting connection tracing * 107 | * information to a file. This function should only be called as the PGconn* * 108 | * resource list constructor. * 109 | * * 110 | * IN: v_PGconnContainer - connection container details. * 111 | * v_pool - pool to use for memory allocation. * 112 | * * 113 | * OUT: v_PGconn - connection record pointer. * 114 | * * 115 | * Returns: APR_SUCCESS - if the connection was opened successfully. * 116 | * APR_EGENERAL - if the connection could not be opened. * 117 | ******************************************************************************/ 118 | static apr_status_t openPGconn_tracing( 119 | void** v_PGconn, 120 | void* v_PGconnContainer, 121 | apr_pool_t* v_pool 122 | ) 123 | { 124 | /* Check and initialize the connection pointer */ 125 | if ((!v_PGconn) || (!v_PGconnContainer) || (!v_pool)) 126 | return APR_EGENERAL; 127 | *v_PGconn = NULL; 128 | 129 | /* Open a PostgreSQL connection */ 130 | #define d_PGconnContainer ((tPGconnContainer*)v_PGconnContainer) 131 | PGconn* t_PGconn = PQconnectdb(d_PGconnContainer->m_connInfo); 132 | if (!t_PGconn) 133 | return APR_EGENERAL; /* Out of memory! */ 134 | 135 | /* Check that the connection was opened successfully */ 136 | if (PQstatus(t_PGconn) != CONNECTION_OK) { 137 | ap_log_error( 138 | APLOG_MARK, APLOG_ERR, 0, NULL, 139 | "PQconnectdb() error: %s", PQerrorMessage(t_PGconn) 140 | ); 141 | PQfinish(t_PGconn); 142 | return APR_EGENERAL; 143 | } 144 | 145 | /* Open a new trace file */ 146 | FILE* t_traceFile = fopen( 147 | apr_psprintf( 148 | v_pool, "%s/%d_%d.trc", d_PGconnContainer->m_traceDir, 149 | getpid(), PQbackendPID(t_PGconn) 150 | ), 151 | "w" 152 | ); 153 | if (!t_traceFile) { 154 | /* Failed to open trace file */ 155 | /* Close PostgreSQL connection */ 156 | PQfinish(t_PGconn); 157 | return APR_EGENERAL; 158 | } 159 | 160 | /* Register a cleanup handler to close the trace file when the memory 161 | pool is destroyed */ 162 | apr_pool_cleanup_register( 163 | v_pool, t_traceFile, (void*)fclose, apr_pool_cleanup_null 164 | ); 165 | 166 | /* Start tracing */ 167 | PQtrace(t_PGconn, t_traceFile); 168 | 169 | (*(PGconn**)v_PGconn) = t_PGconn; 170 | return APR_SUCCESS; 171 | 172 | #undef d_PGconnContainer 173 | } 174 | 175 | 176 | /****************************************************************************** 177 | * closePGconn() * 178 | * Closes a PostgreSQL connection. This function should only be called as * 179 | * the PGconn* resource list destructor. * 180 | * * 181 | * IN: v_PGconn - connection record pointer. * 182 | * * 183 | * Returns: APR_SUCCESS - if the connection was closed successfully. * 184 | * APR_EGENERAL - if there was no connection to close. * 185 | ******************************************************************************/ 186 | static apr_status_t closePGconn( 187 | void* v_PGconn, 188 | void* v_PGconnContainer_unused, 189 | apr_pool_t* v_pool_unused 190 | ) 191 | { 192 | if (!v_PGconn) 193 | return APR_EGENERAL; 194 | else { 195 | /* Close the PostgreSQL connection */ 196 | PQfinish((PGconn*)v_PGconn); 197 | return APR_SUCCESS; 198 | } 199 | } 200 | 201 | 202 | /****************************************************************************** 203 | * closePGconn_tracing() * 204 | * Disabled connection tracing and closes a PostgreSQL connection. This * 205 | * function should only be called as the PGconn* resource list destructor. * 206 | * * 207 | * IN: v_PGconn - connection record pointer. * 208 | * * 209 | * Returns: APR_SUCCESS - if the connection was closed successfully. * 210 | * APR_EGENERAL - if there was no connection to close. * 211 | ******************************************************************************/ 212 | static apr_status_t closePGconn_tracing( 213 | void* v_PGconn, 214 | void* v_PGconnContainer_unused, 215 | apr_pool_t* v_pool_unused 216 | ) 217 | { 218 | if (!v_PGconn) 219 | return APR_EGENERAL; 220 | else { 221 | /* Disable connection tracing and close the PostgreSQL 222 | connection */ 223 | PQuntrace((PGconn*)v_PGconn); 224 | PQfinish((PGconn*)v_PGconn); 225 | return APR_SUCCESS; 226 | } 227 | } 228 | 229 | 230 | /****************************************************************************** 231 | * acquirePGconn() * 232 | * Acquires a PostgreSQL connection from the PGconn* resource list. * 233 | * The resource list takes care of closing/reusing/timing-out connections as * 234 | * required. * 235 | * * 236 | * IN: v_PGconnContainer - connection container details. * 237 | * v_PGconn - should be NULL. * 238 | * * 239 | * OUT: v_PGconn - connection record pointer (if successful). * 240 | * * 241 | * Returns: PGCONN_ACQUIRED - if everything was OK. * 242 | * PGCONN_ALREADYACQUIRED - if a connection was already * 243 | * acquired. * 244 | * PGCONN_UNAVAILABLE - if all the connections in the pool are * 245 | * already in use. * 246 | * PGCONN_BAD - if the connection could not be opened/reset. * 247 | ******************************************************************************/ 248 | static ePGconnStatus acquirePGconn( 249 | const tPGconnContainer* v_PGconnContainer, 250 | PGconn** v_PGconn 251 | ) 252 | { 253 | if ((!v_PGconnContainer) || (!v_PGconn)) 254 | return PGCONN_BAD; 255 | /* Don't allow acquirePGconn() to be called twice without a call to 256 | releasePGconn() inbetween */ 257 | else if (*v_PGconn) 258 | return PGCONN_ALREADYACQUIRED; 259 | /* Check that the PGconn* resource list was created successfully */ 260 | else if (!(v_PGconnContainer->m_PGconnPool)) 261 | return PGCONN_UNAVAILABLE; 262 | 263 | /* Acquire a connection from the PGconn* resource list */ 264 | apr_status_t t_status = apr_reslist_acquire( 265 | v_PGconnContainer->m_PGconnPool, (void**)v_PGconn 266 | ); 267 | if (t_status != APR_SUCCESS) 268 | return PGCONN_UNAVAILABLE; 269 | 270 | /* Check the connection status */ 271 | if (PQstatus(*v_PGconn) != CONNECTION_OK) { 272 | /* Problem with connection. Try resetting it */ 273 | PQreset(*v_PGconn); 274 | /* Check the connection status again */ 275 | if (PQstatus(*v_PGconn) != CONNECTION_OK) { 276 | /* Connection still doesn't work, so release the 277 | resource straight away */ 278 | apr_reslist_release( 279 | v_PGconnContainer->m_PGconnPool, *v_PGconn 280 | ); 281 | *v_PGconn = NULL; 282 | return PGCONN_BAD; 283 | } 284 | } 285 | 286 | /* Connection acquired successfully */ 287 | return PGCONN_ACQUIRED; 288 | } 289 | 290 | 291 | /****************************************************************************** 292 | * releasePGconn() * 293 | * Releases a PostgreSQL connection back to the PGconn* resource list. * 294 | * The resource list takes care of closing/reusing/timing-out connections as * 295 | * required. * 296 | * * 297 | * IN: v_PGconnContainer - connection container details. * 298 | * v_PGconn - connection record pointer (should be non-NULL). * 299 | * * 300 | * OUT: v_PGconn - NULL (if the connection has been released successfully). * 301 | * * 302 | * Returns: PGCONN_RELEASED - if everything was OK. * 303 | * PGCONN_BAD - if there was no acquired connection to release. * 304 | ******************************************************************************/ 305 | static ePGconnStatus releasePGconn( 306 | const tPGconnContainer* v_PGconnContainer, 307 | PGconn** v_PGconn 308 | ) 309 | { 310 | /* If there is a currently acquired connection, release the resource */ 311 | if ((!v_PGconnContainer) || (!v_PGconn)) 312 | return PGCONN_BAD; 313 | else if (*v_PGconn) 314 | if (apr_reslist_release(v_PGconnContainer->m_PGconnPool, 315 | *v_PGconn) == APR_SUCCESS) { 316 | *v_PGconn = NULL; 317 | return PGCONN_RELEASED; 318 | } 319 | 320 | return PGCONN_BAD; /* No acquired connection to release! */ 321 | } 322 | 323 | 324 | /****************************************************************************** 325 | * measurePGconnAvailability() * 326 | * Check how many PGconn resources aren't currently in use. * 327 | * * 328 | * IN: v_PGconnContainer - connection container details. * 329 | * * 330 | * Returns: 0..100 - % of the total PGconn resources not currently in use.* 331 | ******************************************************************************/ 332 | static int measurePGconnAvailability( 333 | const tPGconnContainer* v_PGconnContainer 334 | ) 335 | { 336 | if (!v_PGconnContainer) 337 | return 0; 338 | 339 | return ((v_PGconnContainer->m_poolMaxHard 340 | - apr_reslist_acquired_count( 341 | v_PGconnContainer->m_PGconnPool 342 | ) 343 | ) * 100) / v_PGconnContainer->m_poolMaxHard; 344 | } 345 | 346 | 347 | /****************************************************************************** 348 | * PGconn_serverConfig_create() * 349 | * Creates the per-server configuration structure. * 350 | * * 351 | * IN: v_pool - pool to use for memory allocation. * 352 | * * 353 | * Returns: pointer to per-server config structure. * 354 | ******************************************************************************/ 355 | static void* PGconn_serverConfig_create( 356 | apr_pool_t* v_pool, 357 | server_rec* v_server_unused 358 | ) 359 | { 360 | tPGconnServerConfig* t_PGconnServerConfig; 361 | 362 | /* Allocate memory for per-server config structure */ 363 | t_PGconnServerConfig = (tPGconnServerConfig*)apr_pcalloc( 364 | v_pool, sizeof(*t_PGconnServerConfig) 365 | ); 366 | 367 | /* No connections setup to start with. 'm_first_PGconnContainer' will 368 | have already been NULLified by memset() */ 369 | 370 | return (void*)t_PGconnServerConfig; 371 | } 372 | 373 | 374 | /****************************************************************************** 375 | * PGconn_dirConfig_create() * 376 | * Creates the per-directory configuration structure. * 377 | * * 378 | * IN: v_pool - pool to use for memory allocation. * 379 | * * 380 | * Returns: pointer to per-directory config structure. * 381 | ******************************************************************************/ 382 | static void* PGconn_dirConfig_create( 383 | apr_pool_t* v_pool, 384 | char* v_directory_unused 385 | ) 386 | { 387 | tPGconnDirConfig* t_PGconnDirConfig; 388 | 389 | /* Allocate memory for per-directory config structure, zeroising it with 390 | memset() */ 391 | t_PGconnDirConfig = (tPGconnDirConfig*)apr_pcalloc( 392 | v_pool, sizeof(*t_PGconnDirConfig) 393 | ); 394 | 395 | /* There is no default default container. 396 | 'm_defaultPGconnContainer' will have already been NULLified by 397 | memset() */ 398 | 399 | return (void*)t_PGconnDirConfig; 400 | } 401 | 402 | 403 | /****************************************************************************** 404 | * PGconn_containerCommand() * 405 | * Process the "" container directive. * 406 | * * 407 | * IN: v_cmdParms - various server configuration details. * 408 | * v_args - connection name plus trailing ">". * 409 | * * 410 | * Returns: NULL or an error message. * 411 | ******************************************************************************/ 412 | static const char* PGconn_containerCommand( 413 | cmd_parms* v_cmdParms, 414 | void* v_dirConfig_unused, 415 | const char* v_args 416 | ) 417 | { 418 | tPGconnServerConfig* t_PGconnServerConfig; 419 | tPGconnContainer** t_PGconnContainer; 420 | ap_directive_t* t_directive; 421 | const char* t_args; 422 | char* t_endPtr = ""; 423 | static APR_OPTIONAL_FN_TYPE(getAllFunctionDetails)* 424 | getAllFunctionDetails; 425 | char* t_errorMessage = NULL; 426 | 427 | /* Check that the Connection Name has been specified */ 428 | if (v_args[0] == '>') 429 | return "Missing Connection Name"; 430 | 431 | /* Check that there is a closing ">" for the container start 432 | directive */ 433 | if (!strrchr(v_args, '>')) 434 | return "Missing \">\""; 435 | 436 | /* Get the server configuration structure */ 437 | t_PGconnServerConfig = (tPGconnServerConfig*)ap_get_module_config( 438 | v_cmdParms->server->module_config, &pgconn_module 439 | ); 440 | if (!t_PGconnServerConfig) 441 | return "ap_get_module_config() failed"; 442 | 443 | /* Find the end of the container linked list */ 444 | for (t_PGconnContainer = &(t_PGconnServerConfig-> 445 | m_first_PGconnContainer); 446 | *t_PGconnContainer; 447 | t_PGconnContainer = &((*t_PGconnContainer)->m_next)) 448 | if (!strcmp((*t_PGconnContainer)->m_name, v_args)) 449 | return "Duplicate Connection Name"; 450 | 451 | /* Allocate memory for the container structure, zeroising with 452 | memset() */ 453 | *t_PGconnContainer = (tPGconnContainer*)apr_pcalloc( 454 | v_cmdParms->pool, sizeof(**t_PGconnContainer) 455 | ); 456 | if (!(*t_PGconnContainer)) 457 | return "Not enough memory"; 458 | 459 | /* This is added to the end of the list. 'm_next' will already be 460 | NULL, because apr_pcalloc() was used to allocate memory */ 461 | /* No PGconn* resource list yet. 'm_PGconnPool' will already be NULL, 462 | because apr_pcalloc() was used to allocate memory */ 463 | /* Copy the connection name, removing the container start directive's 464 | closing ">" */ 465 | (*t_PGconnContainer)->m_name = apr_pstrndup( 466 | v_cmdParms->pool, v_args, strlen(v_args) - 1 467 | ); 468 | /* Default 'connInfo' is "" */ 469 | (*t_PGconnContainer)->m_connInfo = ""; 470 | /* Minimum pool size will already be '0', because apr_pcalloc() was used 471 | to allocate memory */ 472 | /* Soft Maximum pool size will already be '0', because apr_pcalloc() was 473 | used to allocate memory */ 474 | /* Set Hard Maximum pool size to 1 */ 475 | (*t_PGconnContainer)->m_poolMaxHard = 1; 476 | /* Default 'poolTTL' will already be '0', because apr_pcalloc() was used 477 | to allocate memory */ 478 | /* Default 'traceDir' will already be NULL, because apr_pcalloc() was 479 | used to allocate memory */ 480 | /* Catalog cache is disabled by default. 'm_catalogCache' will already 481 | be DISABLED and 'm_catalog' will already be NULL, because 482 | apr_pcalloc() was used to allocate memory */ 483 | 484 | /* Parse the contents of the container */ 485 | for (t_directive = v_cmdParms->directive->first_child; t_directive; 486 | t_directive = t_directive->next) { 487 | t_args = t_directive->args; 488 | if (!strcasecmp(t_directive->directive, "ConnInfo")) { 489 | (*t_PGconnContainer)->m_connInfo = ap_getword_conf( 490 | v_cmdParms->pool, &t_args 491 | ); 492 | if (*t_args) 493 | return "ConnInfo: Too many arguments"; 494 | else if (strlen((*t_PGconnContainer)->m_connInfo)) 495 | continue; 496 | else 497 | return "ConnInfo: Too few arguments"; 498 | } 499 | else if (!strcasecmp(t_directive->directive, "PoolMin")) 500 | (*t_PGconnContainer)->m_poolMin = strtol( 501 | t_directive->args, &t_endPtr, 10 502 | ); 503 | else if (!strcasecmp(t_directive->directive, "PoolMaxSoft")) 504 | (*t_PGconnContainer)->m_poolMaxSoft = strtol( 505 | t_directive->args, &t_endPtr, 10 506 | ); 507 | else if (!strcasecmp(t_directive->directive, "PoolMaxHard")) 508 | (*t_PGconnContainer)->m_poolMaxHard = strtol( 509 | t_directive->args, &t_endPtr, 10 510 | ); 511 | else if (!strcasecmp(t_directive->directive, "PoolTTL")) 512 | (*t_PGconnContainer)->m_poolTTL = apr_strtoi64( 513 | t_directive->args, &t_endPtr, 10 514 | ); 515 | else if (!strcasecmp(t_directive->directive, "TraceDir")) { 516 | (*t_PGconnContainer)->m_traceDir = ap_getword_conf( 517 | v_cmdParms->pool, &t_args 518 | ); 519 | if (*t_args) 520 | return "TraceDir: Too many arguments"; 521 | else if (strlen((*t_PGconnContainer)->m_traceDir)) { 522 | (*t_PGconnContainer)->m_traceDir 523 | = ap_server_root_relative( 524 | v_cmdParms->pool, 525 | (*t_PGconnContainer)->m_traceDir 526 | ); 527 | continue; 528 | } 529 | else 530 | return "TraceDir: Too few arguments"; 531 | } 532 | else if (!strcasecmp(t_directive->directive, "CatalogCache")) { 533 | if (!strcasecmp(t_args, "disabled")) 534 | (*t_PGconnContainer)->m_catalogCache = DISABLED; 535 | else if (!strcasecmp(t_args, "enabled")) 536 | (*t_PGconnContainer)->m_catalogCache = ENABLED; 537 | else if (!strcasecmp(t_args, "required")) 538 | (*t_PGconnContainer)->m_catalogCache = REQUIRED; 539 | } 540 | else 541 | return apr_psprintf( 542 | v_cmdParms->temp_pool, 543 | "'%s' not recognized", t_directive->directive 544 | ); 545 | 546 | /* Check if an error occurred */ 547 | if (*t_endPtr) 548 | return apr_psprintf( 549 | v_cmdParms->temp_pool, 550 | "Invalid value specified for '%s'", 551 | t_directive->directive 552 | ); 553 | } 554 | 555 | /* If required, call the mod_pgproc function to cache the "function 556 | catalog" */ 557 | if ((*t_PGconnContainer)->m_catalogCache != DISABLED) { 558 | getAllFunctionDetails = APR_RETRIEVE_OPTIONAL_FN( 559 | getAllFunctionDetails 560 | ); 561 | if (!getAllFunctionDetails) 562 | t_errorMessage = "\"CatalogCache enabled/required\"" 563 | " requires mod_pgproc!"; 564 | else 565 | t_errorMessage = getAllFunctionDetails( 566 | v_cmdParms->pool, v_cmdParms->temp_pool, 567 | (*t_PGconnContainer) 568 | ); 569 | } 570 | 571 | return t_errorMessage; 572 | } 573 | 574 | 575 | /****************************************************************************** 576 | * PGconn_command() * 577 | * Process the "PGconn" command. * 578 | * * 579 | * IN: v_cmdParms - various server configuration details. * 580 | * v_PGconnDirConfig - the per-directory config structure. * 581 | * v_moduleName - if specified, the name of the module that should use * 582 | * the specified connection name by default (otherwise, * 583 | * the specified connection name will be used by default * 584 | * for all modules). * 585 | * v_PGconnName - the name of the container to use, by default, * 586 | * for this directory. * 587 | * * 588 | * Returns: NULL or an error message. * 589 | ******************************************************************************/ 590 | static const char* PGconn_command( 591 | cmd_parms* v_cmdParms, 592 | void* v_PGconnDirConfig, 593 | const char* v_PGconnName, /* these are reversed... */ 594 | const char* v_moduleName /* ...on purpose */ 595 | ) 596 | { 597 | tPGconnServerConfig* t_PGconnServerConfig; 598 | tPGconnContainer* t_PGconnContainer; 599 | 600 | /* Check if this directive should be handled by another module */ 601 | if (v_moduleName) 602 | return DECLINE_CMD; 603 | 604 | /* Get the server configuration structure */ 605 | t_PGconnServerConfig = (tPGconnServerConfig*)ap_get_module_config( 606 | v_cmdParms->server->module_config, &pgconn_module 607 | ); 608 | 609 | /* Find the required container record */ 610 | t_PGconnContainer = getPGconnContainerByName( 611 | t_PGconnServerConfig, v_PGconnName 612 | ); 613 | #define t_PGconnDirConfig ((tPGconnDirConfig*)v_PGconnDirConfig) 614 | if (t_PGconnContainer) 615 | t_PGconnDirConfig->m_defaultPGconnContainer = t_PGconnContainer; 616 | else 617 | return "Invalid Connection Name"; 618 | #undef t_PGconnDirConfig 619 | 620 | return NULL; 621 | } 622 | 623 | 624 | /****************************************************************************** 625 | * PGconn_childInit() * 626 | * This function is executed once when each new "child" process starts. * 627 | * It creates a new PGconn* resource list for each , which is shared * 628 | * between all threads (if any) created by the MPM (e.g. worker) for this * 629 | * process. To find all s, we have to navigate through the entire * 630 | * list of Virtual Hosts, starting from "v_server", which is the "base" * 631 | * Virtual Host. * 632 | * * 633 | * IN: v_pool - pool to use for memory allocation. * 634 | * v_server - the server record. * 635 | ******************************************************************************/ 636 | static void PGconn_childInit( 637 | apr_pool_t* v_pool, 638 | server_rec* v_server 639 | ) 640 | { 641 | tPGconnServerConfig* t_PGconnServerConfig; 642 | tPGconnContainer* t_PGconnContainer; 643 | server_rec* t_server; 644 | apr_status_t t_status; 645 | 646 | /* Navigate through all the Virtual Hosts */ 647 | for (t_server = v_server; t_server; t_server = t_server->next) { 648 | /* Get the server configuration structure */ 649 | t_PGconnServerConfig = 650 | (tPGconnServerConfig*)ap_get_module_config( 651 | t_server->module_config, &pgconn_module 652 | ); 653 | 654 | /* Loop through each of this Virtual Host's 655 | containers */ 656 | for (t_PGconnContainer = t_PGconnServerConfig-> 657 | m_first_PGconnContainer; 658 | t_PGconnContainer; 659 | t_PGconnContainer = t_PGconnContainer->m_next) 660 | if (t_PGconnContainer->m_poolMaxHard >= 1) { 661 | /* Connections are allowed, so create the 662 | PGconn* resource list for this process */ 663 | t_status = apr_reslist_create( 664 | &(t_PGconnContainer->m_PGconnPool), 665 | t_PGconnContainer->m_poolMin, 666 | t_PGconnContainer->m_poolMaxSoft, 667 | t_PGconnContainer->m_poolMaxHard, 668 | t_PGconnContainer->m_poolTTL, 669 | t_PGconnContainer->m_traceDir ? 670 | openPGconn_tracing : 671 | openPGconn, 672 | t_PGconnContainer->m_traceDir ? 673 | closePGconn_tracing : 674 | closePGconn, 675 | t_PGconnContainer, v_pool 676 | ); 677 | if (t_status != APR_SUCCESS) 678 | ap_log_error( 679 | APLOG_MARK, APLOG_ERR, 0, 680 | v_server, 681 | "Failed to create PGconn*" 682 | " resource list!" 683 | ); 684 | else /* Register a cleanup function to 685 | destroy the PGconn* resource list 686 | when the server shuts down */ 687 | apr_pool_cleanup_register( 688 | v_pool, 689 | t_PGconnContainer->m_PGconnPool, 690 | (void*)apr_reslist_destroy, 691 | apr_pool_cleanup_null 692 | ); 693 | } 694 | } 695 | } 696 | 697 | 698 | /*---------------------------------------------------------------------------- 699 | - Command Table - 700 | ----------------------------------------------------------------------------*/ 701 | static const command_rec PGconn_commandTable[] = { 702 | AP_INIT_RAW_ARGS( 703 | " container" 705 | ), 706 | AP_INIT_TAKE12( 707 | "PGconn", PGconn_command, NULL, ACCESS_CONF, 708 | "a container name" 709 | ), 710 | NULL 711 | }; 712 | 713 | 714 | /****************************************************************************** 715 | * PGconn_registerHooks() * 716 | ******************************************************************************/ 717 | static void PGconn_registerHooks( 718 | apr_pool_t* v_pool_unused 719 | ) 720 | { 721 | APR_REGISTER_OPTIONAL_FN(getPGconnContainerByName); 722 | APR_REGISTER_OPTIONAL_FN(acquirePGconn); 723 | APR_REGISTER_OPTIONAL_FN(releasePGconn); 724 | APR_REGISTER_OPTIONAL_FN(measurePGconnAvailability); 725 | 726 | /* Register "child init" handler */ 727 | ap_hook_child_init(PGconn_childInit, NULL, NULL, APR_HOOK_MIDDLE); 728 | } 729 | 730 | 731 | /*---------------------------------------------------------------------------- 732 | - Module record: dispatch list for API hooks - 733 | ----------------------------------------------------------------------------*/ 734 | module AP_MODULE_DECLARE_DATA pgconn_module = { 735 | STANDARD20_MODULE_STUFF, 736 | PGconn_dirConfig_create, /* create per-dir config */ 737 | NULL, /* merge per-dir config */ 738 | PGconn_serverConfig_create, /* create per-server config */ 739 | NULL, /* merge per-server config */ 740 | PGconn_commandTable, /* table of config file commands */ 741 | PGconn_registerHooks /* register hooks */ 742 | }; 743 | -------------------------------------------------------------------------------- /mod_pgconn.h: -------------------------------------------------------------------------------- 1 | /* mod_pgconn - An httpd module for PostgreSQL connection pooling 2 | * Written by Rob Stradling 3 | * Copyright (C) 2003-2020 Sectigo Limited 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | */ 18 | 19 | #ifndef MOD_PGCONN_H 20 | #define MOD_PGCONN_H 21 | 22 | #include 23 | 24 | /* Apache 2.0 include files */ 25 | #include "apr_hash.h" 26 | #include "apr_lib.h" 27 | #include "apr_optional.h" 28 | #include "apr_reslist.h" 29 | #include "apr_strings.h" 30 | #include "httpd.h" 31 | #include "http_config.h" 32 | #include "http_log.h" 33 | #include "http_protocol.h" 34 | 35 | /* PostgreSQL include files */ 36 | #include "libpq-fe.h" 37 | 38 | 39 | /* Forward reference for module record */ 40 | module AP_MODULE_DECLARE_DATA pgconn_module; 41 | 42 | 43 | /* Enumerate the API return codes */ 44 | typedef enum { 45 | PGCONN_ALREADYACQUIRED = 0, 46 | PGCONN_ACQUIRED = 1, 47 | PGCONN_RELEASED = 2, 48 | PGCONN_UNAVAILABLE = 3, 49 | PGCONN_BAD = 4 50 | } ePGconnStatus; 51 | 52 | /* Enumerate the Catalog Cache modes of operation */ 53 | typedef enum { 54 | DISABLED = 0, 55 | ENABLED = 1, 56 | REQUIRED = 2 57 | } eCatalogCache; 58 | 59 | 60 | /* Typedef for container structure */ 61 | typedef struct tPGconnContainer { 62 | struct tPGconnContainer* m_next; 63 | apr_reslist_t* m_PGconnPool; 64 | char* m_name; 65 | char* m_connInfo; 66 | int m_poolMin; 67 | int m_poolMaxSoft; 68 | int m_poolMaxHard; 69 | apr_int64_t m_poolTTL; /* Microseconds */ 70 | char* m_traceDir; 71 | /* Used by mod_pgproc */ 72 | eCatalogCache m_catalogCache; 73 | apr_hash_t* m_catalog; /* "schema.name" -> tFunctionDetails */ 74 | } tPGconnContainer; 75 | 76 | 77 | /* Typedef for per-server configuration information */ 78 | typedef struct tPGconnServerConfig { 79 | /* Linked list of containers */ 80 | tPGconnContainer* m_first_PGconnContainer; 81 | } tPGconnServerConfig; 82 | 83 | 84 | /* Typedef for per-directory configuration information */ 85 | typedef struct tPGconnDirConfig { 86 | tPGconnContainer* m_defaultPGconnContainer; 87 | } tPGconnDirConfig; 88 | 89 | 90 | /* Functions exported by this module */ 91 | APR_DECLARE_OPTIONAL_FN( 92 | tPGconnContainer*, getPGconnContainerByName, 93 | (const tPGconnServerConfig*, const char*) 94 | ); 95 | APR_DECLARE_OPTIONAL_FN( 96 | ePGconnStatus, acquirePGconn, 97 | (const tPGconnContainer*, PGconn** v_PGconn) 98 | ); 99 | APR_DECLARE_OPTIONAL_FN( 100 | ePGconnStatus, releasePGconn, 101 | (const tPGconnContainer*, PGconn** v_PGconn) 102 | ); 103 | APR_DECLARE_OPTIONAL_FN( 104 | int, measurePGconnAvailability, (const tPGconnContainer*) 105 | ); 106 | 107 | /* Functions imported by this module */ 108 | APR_DECLARE_OPTIONAL_FN( 109 | char*, getAllFunctionDetails, 110 | (apr_pool_t*, apr_pool_t*, tPGconnContainer*) 111 | ); 112 | 113 | 114 | #endif 115 | -------------------------------------------------------------------------------- /modules.mk: -------------------------------------------------------------------------------- 1 | mod_pgconn.la: mod_pgconn.slo 2 | $(SH_LINK) -rpath $(libexecdir) -module -avoid-version mod_pgconn.lo 3 | DISTCLEAN_TARGETS = modules.mk 4 | shared = mod_pgconn.la 5 | --------------------------------------------------------------------------------