jenkins-bot has submitted this change and it was merged. Change subject: Initial import from MediaWiki core ......................................................................
Initial import from MediaWiki core Change-Id: I0fb596175c82ceaa4a07595df5ac99e3a95286d8 --- A .editorconfig A .gitignore A .jshintrc A .travis.yml A COPYING A Doxyfile A README.md A composer.json A phpcs.xml A phpunit.xml.dist A src/Functions.php A tests/BaseConvertTest.php 12 files changed, 853 insertions(+), 0 deletions(-) Approvals: Aaron Schulz: Looks good to me, approved jenkins-bot: Verified diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..7c8c7ab --- /dev/null +++ b/.editorconfig @@ -0,0 +1,5 @@ +# http://editorconfig.org +root = true + +[*] +indent_style = tab diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3a761dd --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/coverage +/doc +vendor +composer.lock diff --git a/.jshintrc b/.jshintrc new file mode 100644 index 0000000..0cc2a4a --- /dev/null +++ b/.jshintrc @@ -0,0 +1,12 @@ +{ + // Enforcing + "bitwise": true, + "eqeqeq": true, + "freeze": true, + "latedef": true, + "noarg": true, + "nonew": true, + "undef": true, + "unused": true, + "node": true +} diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..c4bbd23 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,12 @@ +sudo: false +language: php +php: + - "5.3" + - "5.4" + - "5.5" + - "5.6" + - "hhvm" +install: + - composer install +script: + - composer test diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/COPYING @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..43118b1 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,26 @@ +# Doxyfile for base-convert +# +# See <http://www.stack.nl/~dimitri/doxygen/manual/config.html> +# for help on how to use this file to configure Doxygen. + +PROJECT_NAME = "base-convert" +PROJECT_BRIEF = "Convert an arbitrarily-long string from one numeric base to another, optionally zero-padding to a minimum column width." +OUTPUT_DIRECTORY = doc +JAVADOC_AUTOBRIEF = YES +QT_AUTOBRIEF = YES +WARN_NO_PARAMDOC = YES +INPUT = README.md src/ +FILE_PATTERNS = *.php +RECURSIVE = YES +USE_MDFILE_AS_MAINPAGE = README.md +HTML_DYNAMIC_SECTIONS = YES +GENERATE_TREEVIEW = YES +TREEVIEW_WIDTH = 250 +GENERATE_LATEX = NO +HAVE_DOT = YES +DOT_FONTNAME = Helvetica +DOT_FONTSIZE = 10 +TEMPLATE_RELATIONS = YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +DOT_MULTI_TARGETS = YES diff --git a/README.md b/README.md new file mode 100644 index 0000000..604b7ca --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +[![Latest Stable Version]](https://packagist.org/packages/wikimedia/base-convert) [![License]](https://packagist.org/packages/wikimedia/base-convert) + +Improved base_convert for PHP +============================= + +PHP's `base_convert` function does not handle large numbers well. This +library does, and can also optionally zero-pad to a minimum column width. + +It is a drop-in replacement for base_convert, supporting base 2 through 36, +and has additional features for padding and case. + +The gmp and bcmath extensions are optionally used for improved performance. + +Additional documentation about the library can be found on +[MediaWiki.org](https://www.mediawiki.org/wiki/base_convert). + + +Usage +----- + + // Using padding, outputs 01010 + \Wikimedia\base_convert('a', '36', '2', '5') + + +Running tests +------------- + + composer install --prefer-dist + composer test + + +History +------- + +This library was first introduced in [MediaWiki 1.7][] ([r14777][]), +and overhauled in [MediaWiki 1.21][] ([9b9daadc46][]). It was split +out of the MediaWiki codebase and published as an independent library +during the [MediaWiki 1.27][] development cycle. + + +--- +[MediaWiki 1.7]: https://www.mediawiki.org/wiki/MediaWiki_1.7 +[r14777]: https://www.mediawiki.org/wiki/Special:Code/MediaWiki/14777 +[MediaWiki 1.21]: https://www.mediawiki.org/wiki/MediaWiki_1.21 +[9b9daadc46]: https://gerrit.wikimedia.org/r/40552 +[MediaWiki 1.27]: https://www.mediawiki.org/wiki/MediaWiki_1.27 +[Latest Stable Version]: https://poser.pugx.org/wikimedia/base-convert/v/stable.svg +[License]: https://poser.pugx.org/wikimedia/base-convert/license.svg diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..3296518 --- /dev/null +++ b/composer.json @@ -0,0 +1,34 @@ +{ + "name": "wikimedia/base-convert", + "description": "Convert an arbitrarily-long string from one numeric base to another, optionally zero-padding to a minimum column width.", + "license": "GPL-2.0+", + "homepage": "https://www.mediawiki.org/wiki/base_convert";, + "authors": [ + { + "name": "Brion Vibber", + "email": "[email protected]" + }, + { + "name": "Tyler Romeo", + "email": "[email protected]" + } + ], + "autoload": { + "files": ["src/Functions.php"] + }, + "require": { + "php": ">=5.3.3" + }, + "require-dev": { + "jakub-onderka/php-parallel-lint": "0.9.0", + "phpunit/phpunit": "4.6.*", + "mediawiki/mediawiki-codesniffer": "0.5.0" + }, + "scripts": { + "test": [ + "parallel-lint . --exclude vendor", + "phpunit $PHPUNIT_ARGS", + "phpcs -p" + ] + } +} diff --git a/phpcs.xml b/phpcs.xml new file mode 100644 index 0000000..aa34438 --- /dev/null +++ b/phpcs.xml @@ -0,0 +1,9 @@ +<?xml version="1.0"?> +<ruleset name="base-convert"> + <rule ref="vendor/mediawiki/mediawiki-codesniffer/MediaWiki"/> + + <file>.</file> + <exclude-pattern>coverage</exclude-pattern> + <exclude-pattern>vendor</exclude-pattern> + <exclude-pattern>doc/html</exclude-pattern> +</ruleset> diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..852e27f --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,14 @@ +<phpunit colors="true" + beStrictAboutTestsThatDoNotTestAnything="true" + beStrictAboutOutputDuringTests="true"> + <testsuites> + <testsuite name="base-convert Tests"> + <directory>./tests</directory> + </testsuite> + </testsuites> + <filter> + <whitelist addUncoveredFilesFromWhitelist="true"> + <directory suffix=".php">./src</directory> + </whitelist> + </filter> +</phpunit> diff --git a/src/Functions.php b/src/Functions.php new file mode 100644 index 0000000..8d67e74 --- /dev/null +++ b/src/Functions.php @@ -0,0 +1,132 @@ +<?php +/** + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +namespace Wikimedia; + +/** + * Convert an arbitrarily-long string from one numeric base to + * another, optionally zero-padding to a minimum column width. + * + * Supports base 2 through 36; digit values 10-36 are represented + * as lowercase letters a-z. Input is case-insensitive. + * + * @param string $input Input number + * @param int $sourceBase Base of the input number + * @param int $destBase Desired base of the output + * @param int $pad Minimum number of digits in the output (pad with zeroes) + * @param bool $lowercase Whether to output in lowercase or uppercase + * @param string $engine Either "gmp", "bcmath", or "php" + * @return string|bool The output number as a string, or false on error + */ +function base_convert( $input, $sourceBase, $destBase, $pad = 1, + $lowercase = true, $engine = 'auto' +) { + $input = (string)$input; + if ( + $sourceBase < 2 || + $sourceBase > 36 || + $destBase < 2 || + $destBase > 36 || + $sourceBase != (int)$sourceBase || + $destBase != (int)$destBase || + $pad != (int)$pad || + !preg_match( + "/^[" . substr( '0123456789abcdefghijklmnopqrstuvwxyz', 0, $sourceBase ) . "]+$/i", + $input + ) + ) { + return false; + } + + static $baseChars = array( + 10 => 'a', 11 => 'b', 12 => 'c', 13 => 'd', 14 => 'e', 15 => 'f', + 16 => 'g', 17 => 'h', 18 => 'i', 19 => 'j', 20 => 'k', 21 => 'l', + 22 => 'm', 23 => 'n', 24 => 'o', 25 => 'p', 26 => 'q', 27 => 'r', + 28 => 's', 29 => 't', 30 => 'u', 31 => 'v', 32 => 'w', 33 => 'x', + 34 => 'y', 35 => 'z', + + '0' => 0, '1' => 1, '2' => 2, '3' => 3, '4' => 4, '5' => 5, + '6' => 6, '7' => 7, '8' => 8, '9' => 9, 'a' => 10, 'b' => 11, + 'c' => 12, 'd' => 13, 'e' => 14, 'f' => 15, 'g' => 16, 'h' => 17, + 'i' => 18, 'j' => 19, 'k' => 20, 'l' => 21, 'm' => 22, 'n' => 23, + 'o' => 24, 'p' => 25, 'q' => 26, 'r' => 27, 's' => 28, 't' => 29, + 'u' => 30, 'v' => 31, 'w' => 32, 'x' => 33, 'y' => 34, 'z' => 35 + ); + + if ( extension_loaded( 'gmp' ) && ( $engine == 'auto' || $engine == 'gmp' ) ) { + // Removing leading zeros works around broken base detection code in + // some PHP versions (see <https://bugs.php.net/bug.php?id=50175> and + // <https://bugs.php.net/bug.php?id=55398>). + $result = gmp_strval( gmp_init( ltrim( $input, '0' ) ?: '0', $sourceBase ), $destBase ); + } elseif ( extension_loaded( 'bcmath' ) && ( $engine == 'auto' || $engine == 'bcmath' ) ) { + $decimal = '0'; + foreach ( str_split( strtolower( $input ) ) as $char ) { + $decimal = bcmul( $decimal, $sourceBase ); + $decimal = bcadd( $decimal, $baseChars[$char] ); + } + + // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed + for ( $result = ''; bccomp( $decimal, 0 ); $decimal = bcdiv( $decimal, $destBase, 0 ) ) { + $result .= $baseChars[bcmod( $decimal, $destBase )]; + } + // @codingStandardsIgnoreEnd + + $result = strrev( $result ); + } else { + $inDigits = array(); + foreach ( str_split( strtolower( $input ) ) as $char ) { + $inDigits[] = $baseChars[$char]; + } + + // Iterate over the input, modulo-ing out an output digit + // at a time until input is gone. + $result = ''; + while ( $inDigits ) { + $work = 0; + $workDigits = array(); + + // Long division... + foreach ( $inDigits as $digit ) { + $work *= $sourceBase; + $work += $digit; + + if ( $workDigits || $work >= $destBase ) { + $workDigits[] = (int)( $work / $destBase ); + } + $work %= $destBase; + } + + // All that division leaves us with a remainder, + // which is conveniently our next output digit. + $result .= $baseChars[$work]; + + // And we continue! + $inDigits = $workDigits; + } + + $result = strrev( $result ); + } + + if ( !$lowercase ) { + $result = strtoupper( $result ); + } + + return str_pad( $result, $pad, '0', STR_PAD_LEFT ); +} diff --git a/tests/BaseConvertTest.php b/tests/BaseConvertTest.php new file mode 100644 index 0000000..e684e7d --- /dev/null +++ b/tests/BaseConvertTest.php @@ -0,0 +1,218 @@ +<?php +/** + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +namespace Wikimedia\Test; + +/** + * @covers Wikimedia\base_convert + */ +class FunctionsTest extends \PHPUnit_Framework_TestCase { + public static function provideSingleDigitConversions() { + return array( + // 2 3 5 8 10 16 36 + array( '0', '0', '0', '0', '0', '0', '0' ), + array( '1', '1', '1', '1', '1', '1', '1' ), + array( '10', '2', '2', '2', '2', '2', '2' ), + array( '11', '10', '3', '3', '3', '3', '3' ), + array( '100', '11', '4', '4', '4', '4', '4' ), + array( '101', '12', '10', '5', '5', '5', '5' ), + array( '110', '20', '11', '6', '6', '6', '6' ), + array( '111', '21', '12', '7', '7', '7', '7' ), + array( '1000', '22', '13', '10', '8', '8', '8' ), + array( '1001', '100', '14', '11', '9', '9', '9' ), + array( '1010', '101', '20', '12', '10', 'a', 'a' ), + array( '1011', '102', '21', '13', '11', 'b', 'b' ), + array( '1100', '110', '22', '14', '12', 'c', 'c' ), + array( '1101', '111', '23', '15', '13', 'd', 'd' ), + array( '1110', '112', '24', '16', '14', 'e', 'e' ), + array( '1111', '120', '30', '17', '15', 'f', 'f' ), + array( '10000', '121', '31', '20', '16', '10', 'g' ), + array( '10001', '122', '32', '21', '17', '11', 'h' ), + array( '10010', '200', '33', '22', '18', '12', 'i' ), + array( '10011', '201', '34', '23', '19', '13', 'j' ), + array( '10100', '202', '40', '24', '20', '14', 'k' ), + array( '10101', '210', '41', '25', '21', '15', 'l' ), + array( '10110', '211', '42', '26', '22', '16', 'm' ), + array( '10111', '212', '43', '27', '23', '17', 'n' ), + array( '11000', '220', '44', '30', '24', '18', 'o' ), + array( '11001', '221', '100', '31', '25', '19', 'p' ), + array( '11010', '222', '101', '32', '26', '1a', 'q' ), + array( '11011', '1000', '102', '33', '27', '1b', 'r' ), + array( '11100', '1001', '103', '34', '28', '1c', 's' ), + array( '11101', '1002', '104', '35', '29', '1d', 't' ), + array( '11110', '1010', '110', '36', '30', '1e', 'u' ), + array( '11111', '1011', '111', '37', '31', '1f', 'v' ), + array( '100000', '1012', '112', '40', '32', '20', 'w' ), + array( '100001', '1020', '113', '41', '33', '21', 'x' ), + array( '100010', '1021', '114', '42', '34', '22', 'y' ), + array( '100011', '1022', '120', '43', '35', '23', 'z' ) + ); + } + + /** + * @dataProvider provideSingleDigitConversions + */ + public function testDigitToBase2( $base2, $base3, $base5, $base8, $base10, $base16, $base36 ) { + $this->assertSame( $base2, \Wikimedia\base_convert( $base3, '3', '2' ) ); + $this->assertSame( $base2, \Wikimedia\base_convert( $base5, '5', '2' ) ); + $this->assertSame( $base2, \Wikimedia\base_convert( $base8, '8', '2' ) ); + $this->assertSame( $base2, \Wikimedia\base_convert( $base10, '10', '2' ) ); + $this->assertSame( $base2, \Wikimedia\base_convert( $base16, '16', '2' ) ); + $this->assertSame( $base2, \Wikimedia\base_convert( $base36, '36', '2' ) ); + } + + /** + * @dataProvider provideSingleDigitConversions + */ + public function testDigitToBase3( $base2, $base3, $base5, $base8, $base10, $base16, $base36 ) { + $this->assertSame( $base3, \Wikimedia\base_convert( $base2, '2', '3' ) ); + $this->assertSame( $base3, \Wikimedia\base_convert( $base5, '5', '3' ) ); + $this->assertSame( $base3, \Wikimedia\base_convert( $base8, '8', '3' ) ); + $this->assertSame( $base3, \Wikimedia\base_convert( $base10, '10', '3' ) ); + $this->assertSame( $base3, \Wikimedia\base_convert( $base16, '16', '3' ) ); + $this->assertSame( $base3, \Wikimedia\base_convert( $base36, '36', '3' ) ); + } + + /** + * @dataProvider provideSingleDigitConversions + */ + public function testDigitToBase5( $base2, $base3, $base5, $base8, $base10, $base16, $base36 ) { + $this->assertSame( $base5, \Wikimedia\base_convert( $base2, '2', '5' ) ); + $this->assertSame( $base5, \Wikimedia\base_convert( $base3, '3', '5' ) ); + $this->assertSame( $base5, \Wikimedia\base_convert( $base8, '8', '5' ) ); + $this->assertSame( $base5, \Wikimedia\base_convert( $base10, '10', '5' ) ); + $this->assertSame( $base5, \Wikimedia\base_convert( $base16, '16', '5' ) ); + $this->assertSame( $base5, \Wikimedia\base_convert( $base36, '36', '5' ) ); + } + + /** + * @dataProvider provideSingleDigitConversions + */ + public function testDigitToBase8( $base2, $base3, $base5, $base8, $base10, $base16, $base36 ) { + $this->assertSame( $base8, \Wikimedia\base_convert( $base2, '2', '8' ) ); + $this->assertSame( $base8, \Wikimedia\base_convert( $base3, '3', '8' ) ); + $this->assertSame( $base8, \Wikimedia\base_convert( $base5, '5', '8' ) ); + $this->assertSame( $base8, \Wikimedia\base_convert( $base10, '10', '8' ) ); + $this->assertSame( $base8, \Wikimedia\base_convert( $base16, '16', '8' ) ); + $this->assertSame( $base8, \Wikimedia\base_convert( $base36, '36', '8' ) ); + } + + /** + * @dataProvider provideSingleDigitConversions + */ + public function testDigitToBase10( $base2, $base3, $base5, $base8, $base10, $base16, $base36 ) { + $this->assertSame( $base10, \Wikimedia\base_convert( $base2, '2', '10' ) ); + $this->assertSame( $base10, \Wikimedia\base_convert( $base3, '3', '10' ) ); + $this->assertSame( $base10, \Wikimedia\base_convert( $base5, '5', '10' ) ); + $this->assertSame( $base10, \Wikimedia\base_convert( $base8, '8', '10' ) ); + $this->assertSame( $base10, \Wikimedia\base_convert( $base16, '16', '10' ) ); + $this->assertSame( $base10, \Wikimedia\base_convert( $base36, '36', '10' ) ); + } + + /** + * @dataProvider provideSingleDigitConversions + */ + public function testDigitToBase16( $base2, $base3, $base5, $base8, $base10, $base16, $base36 ) { + $this->assertSame( $base16, \Wikimedia\base_convert( $base2, '2', '16' ) ); + $this->assertSame( $base16, \Wikimedia\base_convert( $base3, '3', '16' ) ); + $this->assertSame( $base16, \Wikimedia\base_convert( $base5, '5', '16' ) ); + $this->assertSame( $base16, \Wikimedia\base_convert( $base8, '8', '16' ) ); + $this->assertSame( $base16, \Wikimedia\base_convert( $base10, '10', '16' ) ); + $this->assertSame( $base16, \Wikimedia\base_convert( $base36, '36', '16' ) ); + } + + /** + * @dataProvider provideSingleDigitConversions + */ + public function testDigitToBase36( $base2, $base3, $base5, $base8, $base10, $base16, $base36 ) { + $this->assertSame( $base36, \Wikimedia\base_convert( $base2, '2', '36' ) ); + $this->assertSame( $base36, \Wikimedia\base_convert( $base3, '3', '36' ) ); + $this->assertSame( $base36, \Wikimedia\base_convert( $base5, '5', '36' ) ); + $this->assertSame( $base36, \Wikimedia\base_convert( $base8, '8', '36' ) ); + $this->assertSame( $base36, \Wikimedia\base_convert( $base10, '10', '36' ) ); + $this->assertSame( $base36, \Wikimedia\base_convert( $base16, '16', '36' ) ); + } + + public function testLargeNumber() { + $this->assertSame( + '1100110001111010000000101110100', + \Wikimedia\base_convert( 'sd89ys', 36, 2 ) + ); + $this->assertSame( '11102112120221201101', \Wikimedia\base_convert( 'sd89ys', 36, 3 ) ); + $this->assertSame( '12003102232400', \Wikimedia\base_convert( 'sd89ys', 36, 5 ) ); + $this->assertSame( '14617200564', \Wikimedia\base_convert( 'sd89ys', 36, 8 ) ); + $this->assertSame( '1715274100', \Wikimedia\base_convert( 'sd89ys', 36, 10 ) ); + $this->assertSame( '663d0174', \Wikimedia\base_convert( 'sd89ys', 36, 16 ) ); + } + + public static function provideNumbers() { + $x = array(); + $chars = '0123456789abcdefghijklmnopqrstuvwxyz'; + for ( $i = 0; $i < 50; $i++ ) { + $base = mt_rand( 2, 36 ); + $len = mt_rand( 10, 100 ); + + $str = ''; + for ( $j = 0; $j < $len; $j++ ) { + $str .= $chars[mt_rand( 0, $base - 1 )]; + } + + $x[] = array( $base, $str ); + } + + return $x; + } + + /** + * @dataProvider provideNumbers + */ + public function testIdentity( $base, $number ) { + $this->assertSame( $number, \Wikimedia\base_convert( $number, $base, $base, strlen( $number ) ) ); + } + + public function testInvalid() { + $this->assertFalse( \Wikimedia\base_convert( '101', 1, 15 ) ); + $this->assertFalse( \Wikimedia\base_convert( '101', 15, 1 ) ); + $this->assertFalse( \Wikimedia\base_convert( '101', 37, 15 ) ); + $this->assertFalse( \Wikimedia\base_convert( '101', 15, 37 ) ); + $this->assertFalse( \Wikimedia\base_convert( 'abcde', 10, 11 ) ); + $this->assertFalse( \Wikimedia\base_convert( '12930', 2, 10 ) ); + $this->assertFalse( \Wikimedia\base_convert( '101', 'abc', 15 ) ); + $this->assertFalse( \Wikimedia\base_convert( '101', 15, 'abc' ) ); + } + + public function testPadding() { + $number = "10101010101"; + $this->assertSame( + strlen( $number ) + 5, + strlen( \Wikimedia\base_convert( $number, 2, 2, strlen( $number ) + 5 ) ) + ); + $this->assertSame( + strlen( $number ), + strlen( \Wikimedia\base_convert( $number, 2, 2, strlen( $number ) - 5 ) ) + ); + } + + public function testLeadingZero() { + $this->assertSame( '24', \Wikimedia\base_convert( '010', 36, 16 ) ); + $this->assertSame( '37d4', \Wikimedia\base_convert( '0b10', 36, 16 ) ); + $this->assertSame( 'a734', \Wikimedia\base_convert( '0x10', 36, 16 ) ); + } +} -- To view, visit https://gerrit.wikimedia.org/r/249475 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I0fb596175c82ceaa4a07595df5ac99e3a95286d8 Gerrit-PatchSet: 3 Gerrit-Project: base-convert Gerrit-Branch: master Gerrit-Owner: Legoktm <[email protected]> Gerrit-Reviewer: Aaron Schulz <[email protected]> Gerrit-Reviewer: Brion VIBBER <[email protected]> Gerrit-Reviewer: BryanDavis <[email protected]> Gerrit-Reviewer: Legoktm <[email protected]> Gerrit-Reviewer: Parent5446 <[email protected]> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
