]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - includes/diff/DairikiDiff.php
MediaWiki 1.30.2
[autoinstallsdev/mediawiki.git] / includes / diff / DairikiDiff.php
diff --git a/includes/diff/DairikiDiff.php b/includes/diff/DairikiDiff.php
new file mode 100644 (file)
index 0000000..d76af31
--- /dev/null
@@ -0,0 +1,334 @@
+<?php
+/**
+ * A PHP diff engine for phpwiki. (Taken from phpwiki-1.3.3)
+ *
+ * Copyright © 2000, 2001 Geoffrey T. Dairiki <dairiki@dairiki.org>
+ * 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 $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;
+       }
+}
+
+/**
+ * @deprecated Alias for WordAccumulator, to be soon removed
+ */
+class HWLDFWordAccumulator extends MediaWiki\Diff\WordAccumulator {
+}