From: Reedy Date: Sun, 14 Apr 2019 22:13:01 +0000 (+0100) Subject: Split DairikiDiff to class per file X-Git-Tag: 1.34.0-rc.0~1977^2 X-Git-Url: https://git.heureux-cyclage.org/?p=lhc%2Fweb%2Fwiklou.git;a=commitdiff_plain;h=40552888fc1430516a4ea5925d9c99776982aa7c Split DairikiDiff to class per file Change-Id: Ica426312ec69707b9a99dfe2a7deee945c38ba35 --- diff --git a/.phpcs.xml b/.phpcs.xml index 49dbb4606d..cc9e53c2fd 100644 --- a/.phpcs.xml +++ b/.phpcs.xml @@ -71,7 +71,6 @@ any new occurrences. --> */includes/specials/SpecialMostinterwikis\.php - */includes/diff/DairikiDiff\.php */includes/specials/SpecialAncientpages\.php */includes/specials/SpecialBrokenRedirects\.php */includes/specials/SpecialConfirmemail\.php @@ -192,7 +191,6 @@ any new occurrences. --> */includes/api/ApiErrorFormatter\.php - */includes/diff/DairikiDiff\.php */includes/parser/Preprocessor_DOM\.php */includes/parser/Preprocessor_Hash\.php */includes/parser/Preprocessor\.php diff --git a/autoload.php b/autoload.php index e73b1974a7..f1668a1e9d 100644 --- a/autoload.php +++ b/autoload.php @@ -395,15 +395,15 @@ $wgAutoloadLocalClasses = [ 'DerivativeRequest' => __DIR__ . '/includes/DerivativeRequest.php', 'DerivativeResourceLoaderContext' => __DIR__ . '/includes/resourceloader/DerivativeResourceLoaderContext.php', 'DescribeFileOp' => __DIR__ . '/includes/libs/filebackend/fileop/DescribeFileOp.php', - 'Diff' => __DIR__ . '/includes/diff/DairikiDiff.php', + 'Diff' => __DIR__ . '/includes/diff/Diff.php', 'DiffEngine' => __DIR__ . '/includes/diff/DiffEngine.php', 'DiffFormatter' => __DIR__ . '/includes/diff/DiffFormatter.php', 'DiffHistoryBlob' => __DIR__ . '/includes/historyblob/DiffHistoryBlob.php', - 'DiffOp' => __DIR__ . '/includes/diff/DairikiDiff.php', - 'DiffOpAdd' => __DIR__ . '/includes/diff/DairikiDiff.php', - 'DiffOpChange' => __DIR__ . '/includes/diff/DairikiDiff.php', - 'DiffOpCopy' => __DIR__ . '/includes/diff/DairikiDiff.php', - 'DiffOpDelete' => __DIR__ . '/includes/diff/DairikiDiff.php', + 'DiffOp' => __DIR__ . '/includes/diff/DiffOp.php', + 'DiffOpAdd' => __DIR__ . '/includes/diff/DiffOpAdd.php', + 'DiffOpChange' => __DIR__ . '/includes/diff/DiffOpChange.php', + 'DiffOpCopy' => __DIR__ . '/includes/diff/DiffOpCopy.php', + 'DiffOpDelete' => __DIR__ . '/includes/diff/DiffOpDelete.php', 'DifferenceEngine' => __DIR__ . '/includes/diff/DifferenceEngine.php', 'DifferenceEngineSlotDiffRenderer' => __DIR__ . '/includes/diff/DifferenceEngineSlotDiffRenderer.php', 'Digit2Html' => __DIR__ . '/maintenance/language/digit2html.php', diff --git a/includes/diff/DairikiDiff.php b/includes/diff/DairikiDiff.php deleted file mode 100644 index 4e919bc83c..0000000000 --- a/includes/diff/DairikiDiff.php +++ /dev/null @@ -1,328 +0,0 @@ - - * You may copy this code freely under the conditions of the GPL. - * - * 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 - * @ingroup DifferenceEngine - * @defgroup DifferenceEngine DifferenceEngine - */ - -/** - * The base class for all other DiffOp classes. - * - * The classes that extend DiffOp are: DiffOpCopy, DiffOpDelete, DiffOpAdd and - * DiffOpChange. FakeDiffOp also extends DiffOp, but it is not located in this file. - * - * @private - * @ingroup DifferenceEngine - */ -abstract class DiffOp { - - /** - * @var string - */ - public $type; - - /** - * @var string[] - */ - public $orig; - - /** - * @var string[] - */ - public $closing; - - /** - * @return string - */ - public function getType() { - return $this->type; - } - - /** - * @return string[] - */ - public function getOrig() { - return $this->orig; - } - - /** - * @param int|null $i - * @return string[]|string|null - */ - public function getClosing( $i = null ) { - if ( $i === null ) { - return $this->closing; - } - if ( array_key_exists( $i, $this->closing ) ) { - return $this->closing[$i]; - } - return null; - } - - abstract public function reverse(); - - /** - * @return int - */ - public function norig() { - return $this->orig ? count( $this->orig ) : 0; - } - - /** - * @return int - */ - public function nclosing() { - return $this->closing ? count( $this->closing ) : 0; - } -} - -/** - * Extends DiffOp. Used to mark strings that have been - * copied from one string array to the other. - * - * @private - * @ingroup DifferenceEngine - */ -class DiffOpCopy extends DiffOp { - public $type = 'copy'; - - public function __construct( $orig, $closing = false ) { - if ( !is_array( $closing ) ) { - $closing = $orig; - } - $this->orig = $orig; - $this->closing = $closing; - } - - /** - * @return DiffOpCopy - */ - public function reverse() { - return new DiffOpCopy( $this->closing, $this->orig ); - } -} - -/** - * Extends DiffOp. Used to mark strings that have been - * deleted from the first string array. - * - * @private - * @ingroup DifferenceEngine - */ -class DiffOpDelete extends DiffOp { - public $type = 'delete'; - - public function __construct( $lines ) { - $this->orig = $lines; - $this->closing = false; - } - - /** - * @return DiffOpAdd - */ - public function reverse() { - return new DiffOpAdd( $this->orig ); - } -} - -/** - * Extends DiffOp. Used to mark strings that have been - * added from the first string array. - * - * @private - * @ingroup DifferenceEngine - */ -class DiffOpAdd extends DiffOp { - public $type = 'add'; - - public function __construct( $lines ) { - $this->closing = $lines; - $this->orig = false; - } - - /** - * @return DiffOpDelete - */ - public function reverse() { - return new DiffOpDelete( $this->closing ); - } -} - -/** - * Extends DiffOp. Used to mark strings that have been - * changed from the first string array (both added and subtracted). - * - * @private - * @ingroup DifferenceEngine - */ -class DiffOpChange extends DiffOp { - public $type = 'change'; - - public function __construct( $orig, $closing ) { - $this->orig = $orig; - $this->closing = $closing; - } - - /** - * @return DiffOpChange - */ - public function reverse() { - return new DiffOpChange( $this->closing, $this->orig ); - } -} - -/** - * Class representing a 'diff' between two sequences of strings. - * @todo document - * @private - * @ingroup DifferenceEngine - */ -class Diff { - - /** - * @var DiffOp[] - */ - public $edits; - - /** - * @var int If this diff complexity is exceeded, a ComplexityException is thrown - * 0 means no limit. - */ - protected $bailoutComplexity = 0; - - /** - * Computes diff between sequences of strings. - * - * @param string[] $from_lines An array of strings. - * Typically these are lines from a file. - * @param string[] $to_lines An array of strings. - * @throws \MediaWiki\Diff\ComplexityException - */ - public function __construct( $from_lines, $to_lines ) { - $eng = new DiffEngine; - $eng->setBailoutComplexity( $this->bailoutComplexity ); - $this->edits = $eng->diff( $from_lines, $to_lines ); - } - - /** - * @return DiffOp[] - */ - public function getEdits() { - return $this->edits; - } - - /** - * Compute reversed Diff. - * - * SYNOPSIS: - * - * $diff = new Diff($lines1, $lines2); - * $rev = $diff->reverse(); - * - * @return Object A Diff object representing the inverse of the - * original diff. - */ - public function reverse() { - $rev = $this; - $rev->edits = []; - /** @var DiffOp $edit */ - foreach ( $this->edits as $edit ) { - $rev->edits[] = $edit->reverse(); - } - - return $rev; - } - - /** - * Check for empty diff. - * - * @return bool True if two sequences were identical. - */ - public function isEmpty() { - foreach ( $this->edits as $edit ) { - if ( $edit->type != 'copy' ) { - return false; - } - } - - return true; - } - - /** - * Compute the length of the Longest Common Subsequence (LCS). - * - * This is mostly for diagnostic purposed. - * - * @return int The length of the LCS. - */ - public function lcs() { - $lcs = 0; - foreach ( $this->edits as $edit ) { - if ( $edit->type == 'copy' ) { - $lcs += count( $edit->orig ); - } - } - - return $lcs; - } - - /** - * Get the original set of lines. - * - * This reconstructs the $from_lines parameter passed to the - * constructor. - * - * @return string[] The original sequence of strings. - */ - public function orig() { - $lines = []; - - foreach ( $this->edits as $edit ) { - if ( $edit->orig ) { - array_splice( $lines, count( $lines ), 0, $edit->orig ); - } - } - - return $lines; - } - - /** - * Get the closing set of lines. - * - * This reconstructs the $to_lines parameter passed to the - * constructor. - * - * @return string[] The sequence of strings. - */ - public function closing() { - $lines = []; - - foreach ( $this->edits as $edit ) { - if ( $edit->closing ) { - array_splice( $lines, count( $lines ), 0, $edit->closing ); - } - } - - return $lines; - } -} diff --git a/includes/diff/Diff.php b/includes/diff/Diff.php new file mode 100644 index 0000000000..2dab88bd6b --- /dev/null +++ b/includes/diff/Diff.php @@ -0,0 +1,160 @@ + + * You may copy this code freely under the conditions of the GPL. + * + * 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 + * @ingroup DifferenceEngine + */ + +/** + * Class representing a 'diff' between two sequences of strings. + * @private + * @ingroup DifferenceEngine + */ +class Diff { + + /** + * @var DiffOp[] + */ + public $edits; + + /** + * @var int If this diff complexity is exceeded, a ComplexityException is thrown + * 0 means no limit. + */ + protected $bailoutComplexity = 0; + + /** + * Computes diff between sequences of strings. + * + * @param string[] $from_lines An array of strings. + * Typically these are lines from a file. + * @param string[] $to_lines An array of strings. + * @throws \MediaWiki\Diff\ComplexityException + */ + public function __construct( $from_lines, $to_lines ) { + $eng = new DiffEngine; + $eng->setBailoutComplexity( $this->bailoutComplexity ); + $this->edits = $eng->diff( $from_lines, $to_lines ); + } + + /** + * @return DiffOp[] + */ + public function getEdits() { + return $this->edits; + } + + /** + * Compute reversed Diff. + * + * SYNOPSIS: + * + * $diff = new Diff($lines1, $lines2); + * $rev = $diff->reverse(); + * + * @return Object A Diff object representing the inverse of the + * original diff. + */ + public function reverse() { + $rev = $this; + $rev->edits = []; + /** @var DiffOp $edit */ + foreach ( $this->edits as $edit ) { + $rev->edits[] = $edit->reverse(); + } + + return $rev; + } + + /** + * Check for empty diff. + * + * @return bool True if two sequences were identical. + */ + public function isEmpty() { + foreach ( $this->edits as $edit ) { + if ( $edit->type != 'copy' ) { + return false; + } + } + + return true; + } + + /** + * Compute the length of the Longest Common Subsequence (LCS). + * + * This is mostly for diagnostic purposed. + * + * @return int The length of the LCS. + */ + public function lcs() { + $lcs = 0; + foreach ( $this->edits as $edit ) { + if ( $edit->type == 'copy' ) { + $lcs += count( $edit->orig ); + } + } + + return $lcs; + } + + /** + * Get the original set of lines. + * + * This reconstructs the $from_lines parameter passed to the + * constructor. + * + * @return string[] The original sequence of strings. + */ + public function orig() { + $lines = []; + + foreach ( $this->edits as $edit ) { + if ( $edit->orig ) { + array_splice( $lines, count( $lines ), 0, $edit->orig ); + } + } + + return $lines; + } + + /** + * Get the closing set of lines. + * + * This reconstructs the $to_lines parameter passed to the + * constructor. + * + * @return string[] The sequence of strings. + */ + public function closing() { + $lines = []; + + foreach ( $this->edits as $edit ) { + if ( $edit->closing ) { + array_splice( $lines, count( $lines ), 0, $edit->closing ); + } + } + + return $lines; + } +} diff --git a/includes/diff/DiffOp.php b/includes/diff/DiffOp.php new file mode 100644 index 0000000000..2a1f3e18dc --- /dev/null +++ b/includes/diff/DiffOp.php @@ -0,0 +1,97 @@ + + * You may copy this code freely under the conditions of the GPL. + * + * 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 + * @ingroup DifferenceEngine + * @defgroup DifferenceEngine DifferenceEngine + */ + +/** + * The base class for all other DiffOp classes. + * + * The classes that extend DiffOp are: DiffOpCopy, DiffOpDelete, DiffOpAdd and + * DiffOpChange. FakeDiffOp also extends DiffOp, but it is not located in this file. + * + * @private + * @ingroup DifferenceEngine + */ +abstract class DiffOp { + + /** + * @var string + */ + public $type; + + /** + * @var string[] + */ + public $orig; + + /** + * @var string[] + */ + public $closing; + + /** + * @return string + */ + public function getType() { + return $this->type; + } + + /** + * @return string[] + */ + public function getOrig() { + return $this->orig; + } + + /** + * @param int|null $i + * @return string[]|string|null + */ + public function getClosing( $i = null ) { + if ( $i === null ) { + return $this->closing; + } + if ( array_key_exists( $i, $this->closing ) ) { + return $this->closing[$i]; + } + return null; + } + + abstract public function reverse(); + + /** + * @return int + */ + public function norig() { + return $this->orig ? count( $this->orig ) : 0; + } + + /** + * @return int + */ + public function nclosing() { + return $this->closing ? count( $this->closing ) : 0; + } +} diff --git a/includes/diff/DiffOpAdd.php b/includes/diff/DiffOpAdd.php new file mode 100644 index 0000000000..3f95e8d245 --- /dev/null +++ b/includes/diff/DiffOpAdd.php @@ -0,0 +1,49 @@ + + * You may copy this code freely under the conditions of the GPL. + * + * 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 + * @ingroup DifferenceEngine + */ + +/** + * Extends DiffOp. Used to mark strings that have been + * added from the first string array. + * + * @private + * @ingroup DifferenceEngine + */ +class DiffOpAdd extends DiffOp { + public $type = 'add'; + + public function __construct( $lines ) { + $this->closing = $lines; + $this->orig = false; + } + + /** + * @return DiffOpDelete + */ + public function reverse() { + return new DiffOpDelete( $this->closing ); + } +} diff --git a/includes/diff/DiffOpChange.php b/includes/diff/DiffOpChange.php new file mode 100644 index 0000000000..bde928777e --- /dev/null +++ b/includes/diff/DiffOpChange.php @@ -0,0 +1,49 @@ + + * You may copy this code freely under the conditions of the GPL. + * + * 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 + * @ingroup DifferenceEngine + */ + +/** + * Extends DiffOp. Used to mark strings that have been + * changed from the first string array (both added and subtracted). + * + * @private + * @ingroup DifferenceEngine + */ +class DiffOpChange extends DiffOp { + public $type = 'change'; + + public function __construct( $orig, $closing ) { + $this->orig = $orig; + $this->closing = $closing; + } + + /** + * @return DiffOpChange + */ + public function reverse() { + return new DiffOpChange( $this->closing, $this->orig ); + } +} diff --git a/includes/diff/DiffOpCopy.php b/includes/diff/DiffOpCopy.php new file mode 100644 index 0000000000..904ee58c43 --- /dev/null +++ b/includes/diff/DiffOpCopy.php @@ -0,0 +1,52 @@ + + * You may copy this code freely under the conditions of the GPL. + * + * 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 + * @ingroup DifferenceEngine + */ + +/** + * Extends DiffOp. Used to mark strings that have been + * copied from one string array to the other. + * + * @private + * @ingroup DifferenceEngine + */ +class DiffOpCopy extends DiffOp { + public $type = 'copy'; + + public function __construct( $orig, $closing = false ) { + if ( !is_array( $closing ) ) { + $closing = $orig; + } + $this->orig = $orig; + $this->closing = $closing; + } + + /** + * @return DiffOpCopy + */ + public function reverse() { + return new DiffOpCopy( $this->closing, $this->orig ); + } +} diff --git a/includes/diff/DiffOpDelete.php b/includes/diff/DiffOpDelete.php new file mode 100644 index 0000000000..22b65abf66 --- /dev/null +++ b/includes/diff/DiffOpDelete.php @@ -0,0 +1,49 @@ + + * You may copy this code freely under the conditions of the GPL. + * + * 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 + * @ingroup DifferenceEngine + */ + +/** + * Extends DiffOp. Used to mark strings that have been + * deleted from the first string array. + * + * @private + * @ingroup DifferenceEngine + */ +class DiffOpDelete extends DiffOp { + public $type = 'delete'; + + public function __construct( $lines ) { + $this->orig = $lines; + $this->closing = false; + } + + /** + * @return DiffOpAdd + */ + public function reverse() { + return new DiffOpAdd( $this->orig ); + } +}