├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── COPYING ├── README.md ├── bin └── cdb └── src ├── Cli.php ├── Exception.php ├── Reader.php ├── Reader ├── DBA.php ├── Hash.php └── PHP.php ├── Util.php ├── Writer.php └── Writer ├── DBA.php └── PHP.php /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## 3.0.0 4 | 5 | The library now requires PHP 7.4 or later. 6 | 7 | * Drop 7.2 support (Sam Reed) 8 | * Add return types and make Reader and Writer signatures more consistent (Timo Tijhof) 9 | * Writer\PHP: Faster `set()` by reducing total number of method calls (Thiemo Kreuz) 10 | * Writer\PHP: Faster `finish()` by using native `array_fill()` where possible (Thiemo Kreuz) 11 | * Writer\PHP: Faster `set()` by inlining single-use methods (Thiemo Kreuz) 12 | 13 | ## 2.0.0 14 | 15 | The library now requires PHP 7.2 or later. 16 | 17 | * Drop PHP 5.5/5.6/7.0/7.1 and HHVM support (James D. Forrester) 18 | * Cli: Add new `cdb` CLI (Timo Tijhof) 19 | 20 | ## 1.4.1 21 | 22 | * Reader\Hash: Avoid use of wikimedia/assert (Ori Livneh) 23 | 24 | ## 1.4.0 25 | 26 | * Add Reader\Hash, a new faux CDB interface wrapping an in-memory array (Daniel Kinzler) 27 | * Reader\PHP: Avoid reading past the last key in `nextkey()` (Ori Livneh) 28 | * Reader\PHP: Optimize `readInt32` implementation (Ori Livneh) 29 | * Reader\PHP: Improve performance (Ori Livneh) 30 | 31 | ## 1.1.0 32 | 33 | * Reader\PHP: Simplify `nextkey` by using `unpack31`, and reuse method for `firstkey` (Thomas Colomb) 34 | * Use PHP_OS rather than php_uname, which may be disabled (Chad Horohoe) 35 | 36 | ## 1.0.0 37 | 38 | Initial release. 39 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | The development of this software is covered by a [Code of Conduct](https://www.mediawiki.org/wiki/Special:MyLanguage/Code_of_Conduct). 2 | 3 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Latest Stable Version]](https://packagist.org/packages/wikimedia/cdb) [![License]](https://packagist.org/packages/wikimedia/cdb) 2 | 3 | CDB functions for PHP 4 | ===================== 5 | 6 | [CDB][], short for "constant database", refers to a very fast and highly 7 | reliable database system which uses a simple file with key value pairs. This 8 | library wraps the CDB functionality exposed in PHP via the `dba_*` functions. 9 | In cases where `dba_*` functions are not present or are not compiled with CDB 10 | support, a pure-PHP implementation is provided for falling back. 11 | 12 | Additional documentation about the library can be found on 13 | [mediawiki.org](https://www.mediawiki.org/wiki/CDB). 14 | 15 | 16 | Usage 17 | ----- 18 | 19 | ```php 20 | // Reading a CDB file 21 | $cdb = Cdb\Reader::open( 'db.cdb' ); 22 | $foo = $cdb->get( 'somekey' ); 23 | 24 | // Writing to a CDB file 25 | $cdb = Cdb\Writer::open( 'anotherdb.cdb' ); 26 | $cdb->set( 'somekey', $foo ); 27 | ``` 28 | 29 | // Using the CLI 30 | $ cdb ./myfile.cdb [get|list|match] 31 | 32 | 33 | Running tests 34 | ------------- 35 | 36 | composer install --prefer-dist 37 | composer test 38 | 39 | 40 | History 41 | ------- 42 | 43 | This library was first introduced in [MediaWiki 1.16][] ([r52203][]). It was 44 | split out of the MediaWiki codebase and published as an independent library 45 | during the [MediaWiki 1.25][] development cycle. 46 | 47 | 48 | --- 49 | [CDB]: https://en.wikipedia.org/wiki/cdb_(software) 50 | [MediaWiki 1.16]: https://www.mediawiki.org/wiki/MediaWiki_1.16 51 | [r52203]: https://www.mediawiki.org/wiki/Special:Code/MediaWiki/52203 52 | [MediaWiki 1.25]: https://www.mediawiki.org/wiki/MediaWiki_1.25 53 | [Latest Stable Version]: https://poser.pugx.org/wikimedia/cdb/v/stable.svg 54 | [License]: https://poser.pugx.org/wikimedia/cdb/license.svg 55 | -------------------------------------------------------------------------------- /bin/cdb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env php 2 | run(); 8 | exit( $cli->getExitCode() ); 9 | -------------------------------------------------------------------------------- /src/Cli.php: -------------------------------------------------------------------------------- 1 | out = $out; 51 | $this->self = $args[0] ?? './bin/cdb'; 52 | $this->filepath = $args[1] ?? ''; 53 | $this->action = $args[2] ?? ''; 54 | $this->params = array_slice( $args, 3 ); 55 | } 56 | 57 | /** Main method. */ 58 | public function run() { 59 | try { 60 | switch ( $this->action ) { 61 | case 'get': 62 | $this->runGet(); 63 | break; 64 | case 'list': 65 | $this->runList(); 66 | break; 67 | case 'match': 68 | $this->runMatch(); 69 | break; 70 | default: 71 | $this->exitCode = 1; 72 | $this->help(); 73 | break; 74 | } 75 | } catch ( Throwable $e ) { 76 | $this->exitCode = 1; 77 | $this->output( (string)$e ); 78 | } 79 | } 80 | 81 | private function runGet(): void { 82 | if ( count( $this->params ) !== 1 ) { 83 | $this->error( "The 'get' action requires one parameter." ); 84 | return; 85 | } 86 | $key = $this->params[0]; 87 | 88 | $dbr = Reader::open( $this->filepath ); 89 | $value = $dbr->get( $key ); 90 | if ( $value == false ) { 91 | $this->error( "Key '$key' not found." ); 92 | return; 93 | } 94 | $this->output( $value ); 95 | } 96 | 97 | private function runList(): void { 98 | if ( count( $this->params ) > 1 ) { 99 | $this->error( "The 'list' action accepts only one parameter." ); 100 | return; 101 | } 102 | $max = (int)( $this->params[0] ?? '100' ); 103 | 104 | $dbr = Reader::open( $this->filepath ); 105 | $key = $dbr->firstkey(); 106 | $count = 0; 107 | while ( $key !== false && $count < $max ) { 108 | $this->output( $key ); 109 | $count++; 110 | $key = $dbr->nextkey(); 111 | } 112 | if ( $count === $max && $key !== false ) { 113 | $this->output( "\n(more keys exist…)" ); 114 | } 115 | } 116 | 117 | private function runMatch(): void { 118 | if ( count( $this->params ) !== 1 ) { 119 | $this->error( "The 'match' action requires one parameter." ); 120 | return; 121 | } 122 | $pattern = $this->params[0]; 123 | // @phan-suppress-next-line PhanParamSuspiciousOrder 124 | if ( preg_match( $pattern, '' ) === false ) { 125 | $this->error( 'Invalid regular expression pattern.' ); 126 | return; 127 | } 128 | 129 | $dbr = Reader::open( $this->filepath ); 130 | $key = $dbr->firstkey(); 131 | while ( $key !== false ) { 132 | if ( preg_match( $pattern, $key ) ) { 133 | $this->output( $key ); 134 | } 135 | $key = $dbr->nextkey(); 136 | } 137 | } 138 | 139 | private function help(): void { 140 | $this->output( <<self} [=list] [] 142 | 143 | actions: 144 | get Get the value for a given key. 145 | list [=100] List all keys in the file 146 | match List keys matching a regular expression. 147 | The pattern must include delimiters (e.g. / or #). 148 | TEXT 149 | ); 150 | } 151 | 152 | private function error( string $text ): void { 153 | $this->exitCode = 1; 154 | $this->output( "\nerror: $text\n------\n" ); 155 | $this->help(); 156 | } 157 | 158 | private function output( string $text ): void { 159 | fwrite( $this->out, $text . "\n" ); 160 | } 161 | 162 | /** 163 | * Get exit status code for the process. 164 | * 165 | * @return int 166 | */ 167 | public function getExitCode(): int { 168 | return $this->exitCode; 169 | } 170 | } 171 | -------------------------------------------------------------------------------- /src/Exception.php: -------------------------------------------------------------------------------- 1 | handle = dba_open( $fileName, 'r-', 'cdb' ); 35 | if ( !$this->handle ) { 36 | throw new Exception( 'Unable to open CDB file "' . $fileName . '"' ); 37 | } 38 | } 39 | 40 | public function close(): void { 41 | if ( $this->handle ) { 42 | dba_close( $this->handle ); 43 | } 44 | $this->handle = null; 45 | } 46 | 47 | public function get( $key ) { 48 | return dba_fetch( (string)$key, $this->handle ); 49 | } 50 | 51 | public function exists( $key ): bool { 52 | return dba_exists( (string)$key, $this->handle ); 53 | } 54 | 55 | public function firstkey() { 56 | return dba_firstkey( $this->handle ); 57 | } 58 | 59 | public function nextkey() { 60 | return dba_nextkey( $this->handle ); 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /src/Reader/Hash.php: -------------------------------------------------------------------------------- 1 | data = $data; 45 | } 46 | 47 | /** 48 | * Close the file. Optional, you can just let the variable go out of scope. 49 | */ 50 | public function close(): void { 51 | $this->data = []; 52 | $this->keys = null; 53 | } 54 | 55 | /** 56 | * Get a value with a given key. Only string values are supported. 57 | * 58 | * @param string|int $key 59 | * @return string|false The value associated with $key, or false if $key is not known. 60 | */ 61 | public function get( $key ) { 62 | return $this->data[ $key ] ?? false; 63 | } 64 | 65 | /** 66 | * Check whether key exists 67 | * 68 | * @param string|int $key 69 | * @return bool 70 | */ 71 | public function exists( $key ): bool { 72 | return isset( $this->data[ $key ] ); 73 | } 74 | 75 | /** 76 | * Fetch first key 77 | * 78 | * @return string|false 79 | */ 80 | public function firstkey() { 81 | $this->keys = array_keys( $this->data ); 82 | return $this->nextkey(); 83 | } 84 | 85 | /** 86 | * Fetch next key 87 | * 88 | * @return string|false 89 | */ 90 | public function nextkey() { 91 | if ( $this->keys === null ) { 92 | return $this->firstkey(); 93 | } 94 | 95 | return $this->keys ? array_shift( $this->keys ) : false; 96 | } 97 | 98 | } 99 | -------------------------------------------------------------------------------- /src/Reader/PHP.php: -------------------------------------------------------------------------------- 1 | fileName = $fileName; 98 | $this->handle = fopen( $fileName, 'rb' ); 99 | if ( !$this->handle ) { 100 | throw new Exception( 'Unable to open CDB file "' . $this->fileName . '".' ); 101 | } 102 | $this->index = fread( $this->handle, 2048 ); 103 | if ( strlen( $this->index ) !== 2048 ) { 104 | throw new Exception( 'CDB file contains fewer than 2048 bytes of data.' ); 105 | } 106 | } 107 | 108 | /** 109 | * Close the handle on the CDB file. 110 | */ 111 | public function close(): void { 112 | if ( $this->handle ) { 113 | fclose( $this->handle ); 114 | } 115 | $this->handle = null; 116 | } 117 | 118 | /** 119 | * Get the value of a key. 120 | * 121 | * @param string|int $key 122 | * @return string|false The key's value or false if not found 123 | */ 124 | public function get( $key ) { 125 | if ( $this->find( (string)$key ) ) { 126 | return $this->read( $this->dataPos, $this->dataLen ); 127 | } 128 | 129 | return false; 130 | } 131 | 132 | /** 133 | * Read data from the CDB file. 134 | * 135 | * @param int $start Start reading from this position 136 | * @param int $len Number of bytes to read 137 | * @return string Read data. 138 | */ 139 | protected function read( $start, $len ) { 140 | $end = $start + $len; 141 | 142 | // The first 2048 bytes are the lookup table, which is read into 143 | // memory on initialization. 144 | if ( $end <= 2048 ) { 145 | return substr( $this->index, $start, $len ); 146 | } 147 | 148 | // Read data from the internal buffer first. 149 | $bytes = ''; 150 | if ( $this->buf && $start >= $this->bufStart ) { 151 | $bytes .= substr( $this->buf, $start - $this->bufStart, $len ); 152 | $bytesRead = strlen( $bytes ); 153 | $len -= $bytesRead; 154 | $start += $bytesRead; 155 | } else { 156 | $bytesRead = 0; 157 | } 158 | 159 | if ( !$len ) { 160 | return $bytes; 161 | } 162 | 163 | // Many reads are sequential, so the file position indicator may 164 | // already be in the right place, in which case we can avoid the 165 | // call to fseek(). 166 | if ( $start !== $this->filePos ) { 167 | if ( fseek( $this->handle, $start ) === -1 ) { 168 | // This can easily happen if the internal pointers are incorrect 169 | throw new Exception( 170 | 'Seek failed, file "' . $this->fileName . '" may be corrupted.' ); 171 | } 172 | } 173 | 174 | $buf = fread( $this->handle, max( $len, 1024 ) ); 175 | if ( $buf === false ) { 176 | $buf = ''; 177 | } 178 | 179 | $bytes .= substr( $buf, 0, $len ); 180 | if ( strlen( $bytes ) !== $len + $bytesRead ) { 181 | throw new Exception( 182 | 'Read from CDB file failed, file "' . $this->fileName . '" may be corrupted.' ); 183 | } 184 | 185 | $this->filePos = $end; 186 | $this->bufStart = $start; 187 | $this->buf = $buf; 188 | 189 | return $bytes; 190 | } 191 | 192 | /** 193 | * Unpack an unsigned integer and throw an exception if it needs more than 31 bits. 194 | * 195 | * @param int $pos Position to read from. 196 | * @throws Exception When the integer cannot be represented in 31 bits. 197 | * @return int 198 | */ 199 | protected function readInt31( $pos = 0 ) { 200 | $uint31 = $this->readInt32( $pos ); 201 | if ( $uint31 > 0x7fffffff ) { 202 | throw new Exception( 203 | 'Error in CDB file "' . $this->fileName . '", integer too big.' ); 204 | } 205 | 206 | return $uint31; 207 | } 208 | 209 | /** 210 | * Unpack a 32-bit integer. 211 | * 212 | * @param int $pos 213 | * @return int 214 | */ 215 | protected function readInt32( $pos = 0 ) { 216 | static $lookups; 217 | 218 | if ( !$lookups ) { 219 | $lookups = []; 220 | for ( $i = 1; $i < 256; $i++ ) { 221 | $lookups[ chr( $i ) ] = $i; 222 | } 223 | } 224 | 225 | $buf = $this->read( $pos, 4 ); 226 | 227 | $rv = 0; 228 | 229 | if ( $buf[0] !== "\x0" ) { 230 | $rv = $lookups[ $buf[0] ]; 231 | } 232 | if ( $buf[1] !== "\x0" ) { 233 | $rv |= ( $lookups[ $buf[1] ] << 8 ); 234 | } 235 | if ( $buf[2] !== "\x0" ) { 236 | $rv |= ( $lookups[ $buf[2] ] << 16 ); 237 | } 238 | if ( $buf[3] !== "\x0" ) { 239 | $rv |= ( $lookups[ $buf[3] ] << 24 ); 240 | } 241 | 242 | return $rv; 243 | } 244 | 245 | /** 246 | * Search the CDB file for a key. 247 | * 248 | * Sets `dataLen` and `dataPos` properties if successful. 249 | * 250 | * @param string $key 251 | * @return bool Whether the key was found. 252 | */ 253 | protected function find( $key ) { 254 | $keyLen = strlen( $key ); 255 | 256 | $u = Util::hash( $key ); 257 | $upos = ( $u << 3 ) & 2047; 258 | $hashSlots = $this->readInt31( $upos + 4 ); 259 | if ( !$hashSlots ) { 260 | return false; 261 | } 262 | $hashPos = $this->readInt31( $upos ); 263 | $keyHash = $u; 264 | $u = Util::unsignedShiftRight( $u, 8 ); 265 | $u = Util::unsignedMod( $u, $hashSlots ); 266 | $u <<= 3; 267 | $keyPos = $hashPos + $u; 268 | 269 | for ( $i = 0; $i < $hashSlots; $i++ ) { 270 | $hash = $this->readInt32( $keyPos ); 271 | $pos = $this->readInt31( $keyPos + 4 ); 272 | if ( !$pos ) { 273 | return false; 274 | } 275 | $keyPos += 8; 276 | if ( $keyPos == $hashPos + ( $hashSlots << 3 ) ) { 277 | $keyPos = $hashPos; 278 | } 279 | if ( $hash === $keyHash ) { 280 | if ( $keyLen === $this->readInt31( $pos ) ) { 281 | $dataLen = $this->readInt31( $pos + 4 ); 282 | $dataPos = $pos + 8 + $keyLen; 283 | $foundKey = $this->read( $pos + 8, $keyLen ); 284 | if ( $foundKey === $key ) { 285 | // Found 286 | $this->dataLen = $dataLen; 287 | $this->dataPos = $dataPos; 288 | 289 | return true; 290 | } 291 | } 292 | } 293 | } 294 | 295 | return false; 296 | } 297 | 298 | /** 299 | * Check if a key exists in the CDB file. 300 | * 301 | * @param string|int $key 302 | * @return bool Whether the key exists. 303 | */ 304 | public function exists( $key ): bool { 305 | return $this->find( (string)$key ); 306 | } 307 | 308 | /** 309 | * Get the first key from the CDB file and reset the key iterator. 310 | * 311 | * @return string|bool Key, or false if no keys in file. 312 | */ 313 | public function firstkey() { 314 | $this->keyIterPos = 4; 315 | 316 | if ( !$this->keyIterStop ) { 317 | $pos = INF; 318 | for ( $i = 0; $i < 2048; $i += 8 ) { 319 | $pos = min( $this->readInt31( $i ), $pos ); 320 | } 321 | $this->keyIterStop = $pos; 322 | } 323 | 324 | $this->keyIterPos = 2048; 325 | return $this->nextkey(); 326 | } 327 | 328 | /** 329 | * Get the next key from the CDB file. 330 | * 331 | * @return string|bool Key, or false if no more keys. 332 | */ 333 | public function nextkey() { 334 | if ( $this->keyIterPos >= $this->keyIterStop ) { 335 | return false; 336 | } 337 | $keyLen = $this->readInt31( $this->keyIterPos ); 338 | $dataLen = $this->readInt31( $this->keyIterPos + 4 ); 339 | $key = $this->read( $this->keyIterPos + 8, $keyLen ); 340 | $this->keyIterPos += 8 + $keyLen + $dataLen; 341 | 342 | return $key; 343 | } 344 | } 345 | -------------------------------------------------------------------------------- /src/Util.php: -------------------------------------------------------------------------------- 1 | > $b ) | ( 0x40000000 >> ( $b - 1 ) ); 59 | } else { 60 | return $a >> $b; 61 | } 62 | } 63 | 64 | /** 65 | * The CDB hash function. 66 | * 67 | * @param string $s 68 | * @return int 69 | */ 70 | public static function hash( $s ): int { 71 | $h = 5381; 72 | $len = strlen( $s ); 73 | for ( $i = 0; $i < $len; $i++ ) { 74 | $h5 = ( $h << 5 ) & 0xffffffff; 75 | // Do a 32-bit sum 76 | // Inlined here for speed 77 | $sum = ( $h & 0x3fffffff ) + ( $h5 & 0x3fffffff ); 78 | $h = ( 79 | ( $sum & 0x40000000 ? 1 : 0 ) 80 | + ( $h & 0x80000000 ? 2 : 0 ) 81 | + ( $h & 0x40000000 ? 1 : 0 ) 82 | + ( $h5 & 0x80000000 ? 2 : 0 ) 83 | + ( $h5 & 0x40000000 ? 1 : 0 ) 84 | ) << 30 | ( $sum & 0x3fffffff ); 85 | $h ^= ord( $s[$i] ); 86 | $h &= 0xffffffff; 87 | } 88 | 89 | return $h; 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /src/Writer.php: -------------------------------------------------------------------------------- 1 | close(); 72 | } 73 | 74 | /** 75 | * Are we running on Windows? 76 | * @return bool 77 | */ 78 | protected function isWindows() { 79 | return strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN'; 80 | } 81 | } 82 | -------------------------------------------------------------------------------- /src/Writer/DBA.php: -------------------------------------------------------------------------------- 1 | realFileName = $fileName; 40 | $this->tmpFileName = $fileName . '.tmp.' . mt_rand( 0, 0x7fffffff ); 41 | $this->handle = dba_open( $this->tmpFileName, 'n', 'cdb_make' ); 42 | if ( !$this->handle ) { 43 | throw new Exception( 'Unable to open CDB file for write "' . $fileName . '"' ); 44 | } 45 | } 46 | 47 | public function set( $key, $value ): void { 48 | dba_insert( $key, $value, $this->handle ); 49 | } 50 | 51 | public function close(): void { 52 | if ( $this->handle ) { 53 | dba_close( $this->handle ); 54 | if ( $this->isWindows() ) { 55 | unlink( $this->realFileName ); 56 | } 57 | if ( !rename( $this->tmpFileName, $this->realFileName ) ) { 58 | throw new Exception( 'Unable to move the new CDB file into place.' ); 59 | } 60 | } 61 | $this->handle = null; 62 | } 63 | } 64 | -------------------------------------------------------------------------------- /src/Writer/PHP.php: -------------------------------------------------------------------------------- 1 | realFileName = $fileName; 53 | $this->tmpFileName = $fileName . '.tmp.' . mt_rand( 0, 0x7fffffff ); 54 | $this->handle = fopen( $this->tmpFileName, 'wb' ); 55 | if ( !$this->handle ) { 56 | $this->throwException( 57 | 'Unable to open CDB file "' . $this->tmpFileName . '" for write.' ); 58 | } 59 | $this->pos = 2048; // leaving space for the pointer array, 256 * 8 60 | if ( fseek( $this->handle, $this->pos ) == -1 ) { 61 | $this->throwException( 'fseek failed in file "' . $this->tmpFileName . '".' ); 62 | } 63 | } 64 | 65 | /** 66 | * @param string $key 67 | * @param string $value 68 | */ 69 | public function set( $key, $value ): void { 70 | $key = (string)$key; 71 | if ( $key === '' ) { 72 | // DBA cross-check hack 73 | return; 74 | } 75 | 76 | // Based on cdb_make_addbegin 77 | $keylen = strlen( $key ); 78 | $datalen = strlen( $value ); 79 | if ( $keylen > 0x7fffffff ) { 80 | $this->throwException( 'Key length too long in file "' . $this->tmpFileName . '".' ); 81 | } 82 | if ( $datalen > 0x7fffffff ) { 83 | $this->throwException( 'Data length too long in file "' . $this->tmpFileName . '".' ); 84 | } 85 | $begin = pack( 'VV', $keylen, $datalen ); 86 | 87 | $this->write( $begin . $key . $value ); 88 | 89 | // Based on cdb_make_addend 90 | $this->hplist[] = [ 91 | 'h' => Util::hash( $key ), 92 | 'p' => $this->pos 93 | ]; 94 | $this->numentries++; 95 | $this->posplus( 8 + $keylen + $datalen ); 96 | } 97 | 98 | public function close(): void { 99 | if ( $this->handle ) { 100 | $this->finish(); 101 | fclose( $this->handle ); 102 | 103 | if ( $this->isWindows() && file_exists( $this->realFileName ) ) { 104 | unlink( $this->realFileName ); 105 | } 106 | if ( !rename( $this->tmpFileName, $this->realFileName ) ) { 107 | $this->throwException( 'Unable to move the new CDB file into place.' ); 108 | } 109 | } 110 | $this->handle = null; 111 | } 112 | 113 | /** 114 | * @param string $buf 115 | */ 116 | protected function write( $buf ): void { 117 | $len = fwrite( $this->handle, $buf ); 118 | if ( $len !== strlen( $buf ) ) { 119 | $this->throwException( 'Error writing to CDB file "' . $this->tmpFileName . '".' ); 120 | } 121 | } 122 | 123 | /** 124 | * @param int $len 125 | */ 126 | protected function posplus( $len ) { 127 | $newpos = $this->pos + $len; 128 | if ( $newpos > 0x7fffffff ) { 129 | $this->throwException( 130 | 'A value in the CDB file "' . $this->tmpFileName . '" is too large.' ); 131 | } 132 | $this->pos = $newpos; 133 | } 134 | 135 | protected function finish(): void { 136 | // Hack for DBA cross-check 137 | $this->hplist = array_reverse( $this->hplist ); 138 | 139 | // Calculate the number of items that will be in each hashtable 140 | $counts = array_fill( 0, 256, 0 ); 141 | foreach ( $this->hplist as $item ) { 142 | ++$counts[255 & $item['h']]; 143 | } 144 | 145 | // Fill in $starts with the *end* indexes 146 | $starts = []; 147 | $pos = 0; 148 | for ( $i = 0; $i < 256; ++$i ) { 149 | $pos += $counts[$i]; 150 | $starts[$i] = $pos; 151 | } 152 | 153 | // Excessively clever and indulgent code to simultaneously fill $packedTables 154 | // with the packed hashtables, and adjust the elements of $starts 155 | // to actually point to the starts instead of the ends. 156 | if ( $this->numentries > 0 ) { 157 | $packedTables = array_fill( 0, $this->numentries, false ); 158 | } else { 159 | // array_fill(): Number of elements must be positive 160 | $packedTables = []; 161 | } 162 | foreach ( $this->hplist as $item ) { 163 | $packedTables[--$starts[255 & $item['h']]] = $item; 164 | } 165 | 166 | $final = ''; 167 | for ( $i = 0; $i < 256; ++$i ) { 168 | $count = $counts[$i]; 169 | 170 | // The size of the hashtable will be double the item count. 171 | // The rest of the slots will be empty. 172 | $len = $count + $count; 173 | $final .= pack( 'VV', $this->pos, $len ); 174 | 175 | $hashtable = array_fill( 0, $len, [ 'h' => 0, 'p' => 0 ] ); 176 | 177 | // Fill the hashtable, using the next empty slot if the hashed slot 178 | // is taken. 179 | for ( $u = 0; $u < $count; ++$u ) { 180 | // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset 181 | $hp = $packedTables[$starts[$i] + $u]; 182 | $where = Util::unsignedMod( 183 | Util::unsignedShiftRight( $hp['h'], 8 ), $len ); 184 | while ( $hashtable[$where]['p'] ) { 185 | if ( ++$where == $len ) { 186 | $where = 0; 187 | } 188 | } 189 | $hashtable[$where] = $hp; 190 | } 191 | 192 | // Write the hashtable 193 | $buf = ''; 194 | for ( $u = 0; $u < $len; ++$u ) { 195 | $buf .= pack( 'vvV', 196 | $hashtable[$u]['h'] & 0xffff, 197 | Util::unsignedShiftRight( $hashtable[$u]['h'], 16 ), 198 | $hashtable[$u]['p'] ); 199 | } 200 | $this->write( $buf ); 201 | $this->posplus( strlen( $buf ) ); 202 | } 203 | 204 | // Write the pointer array at the start of the file 205 | rewind( $this->handle ); 206 | if ( ftell( $this->handle ) != 0 ) { 207 | $this->throwException( 'Error rewinding to start of file "' . $this->tmpFileName . '".' ); 208 | } 209 | $this->write( $final ); 210 | } 211 | 212 | /** 213 | * Clean up the temp file and throw an exception 214 | * 215 | * @param string $msg 216 | * @return never 217 | * @throws Exception 218 | */ 219 | protected function throwException( $msg ) { 220 | if ( $this->handle ) { 221 | fclose( $this->handle ); 222 | unlink( $this->tmpFileName ); 223 | } 224 | throw new Exception( $msg ); 225 | } 226 | } 227 | --------------------------------------------------------------------------------