Diff.php 22.8 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
<?php

/**
 * @package framework
 * @subpackage core
 * A PHP diff engine
 */

// difflib.php
//
// A PHP diff engine for phpwiki.
//
// Copyright (C) 2000, 2001 Geoffrey T. Dairiki <dairiki@dairiki.org>
// You may copy this code freely under the conditions of the GPL.
//

// FIXME: possibly remove assert()'s for production version?

// PHP3 does not have assert()
/**
 */
define('USE_ASSERTS', function_exists('assert'));

/**
 * @package framework
 * @subpackage core
 * @access private
 */
class _DiffOp {
	var $type;
	var $orig;
	var $final;

	public function reverse() {
		trigger_error("pure virtual", E_USER_ERROR);
	}

	public function norig() {
		return $this->orig ? sizeof($this->orig) : 0;
	}

	public function nfinal() {
		return $this->final ? sizeof($this->final) : 0;
	}
}

/**
 * @package framework
 * @subpackage core
 * @access private
 */
class _DiffOp_Copy extends _DiffOp {
	var $type = 'copy';

	public function _DiffOp_Copy ($orig, $final = false) {
		if (!is_array($final))
			$final = $orig;
		$this->orig = $orig;
		$this->final = $final;
	}

	public function reverse() {
		return new _DiffOp_Copy($this->final, $this->orig);
	}
}

/**
 * @package framework
 * @subpackage core
 * @access private
 */
class _DiffOp_Delete extends _DiffOp {
	var $type = 'delete';

	public function _DiffOp_Delete ($lines) {
		$this->orig = $lines;
		$this->final = false;
	}

	public function reverse() {
		return new _DiffOp_Add($this->orig);
	}
}

/**
 * @package framework
 * @subpackage core
 * @access private
 */
class _DiffOp_Add extends _DiffOp {
	var $type = 'add';

	public function _DiffOp_Add ($lines) {
		$this->final = $lines;
		$this->orig = false;
	}

	public function reverse() {
		return new _DiffOp_Delete($this->final);
	}
}

/**
 * @package framework
 * @subpackage core
 * @access private
 */
class _DiffOp_Change extends _DiffOp {
	var $type = 'change';

	public function _DiffOp_Change ($orig, $final) {
		$this->orig = $orig;
		$this->final = $final;
	}

	public function reverse() {
		return new _DiffOp_Change($this->final, $this->orig);
	}
}


/**
 * Class used internally by Diff to actually compute the diffs.
 *
 * The algorithm used here is mostly lifted from the perl module
 * Algorithm::Diff (version 1.06) by Ned Konz, which is available at:
 *   http://www.perl.com/CPAN/authors/id/N/NE/NEDKONZ/Algorithm-Diff-1.06.zip
 *
 * More ideas are taken from:
 *   http://www.ics.uci.edu/~eppstein/161/960229.html
 *
 * Some ideas are (and a bit of code) are from from analyze.c, from GNU
 * diffutils-2.7, which can be found at:
 *   ftp://gnudist.gnu.org/pub/gnu/diffutils/diffutils-2.7.tar.gz
 *
 * Finally, some ideas (subdivision by NCHUNKS > 2, and some optimizations)
 * are my own.
 *
 * @author Geoffrey T. Dairiki
 * @access private
 * @package framework
 * @subpackage core
 */
class _DiffEngine
{
	public function diff ($from_lines, $to_lines) {
		$n_from = sizeof($from_lines);
		$n_to = sizeof($to_lines);

		$this->xchanged = $this->ychanged = array();
		$this->xv = $this->yv = array();
		$this->xind = $this->yind = array();
		unset($this->seq);
		unset($this->in_seq);
		unset($this->lcs);

		// Skip leading common lines.
		for ($skip = 0; $skip < $n_from && $skip < $n_to; $skip++) {
			if ($from_lines[$skip] != $to_lines[$skip])
				break;
			$this->xchanged[$skip] = $this->ychanged[$skip] = false;
		}
		// Skip trailing common lines.
		$xi = $n_from; $yi = $n_to;
		for ($endskip = 0; --$xi > $skip && --$yi > $skip; $endskip++) {
			if ($from_lines[$xi] != $to_lines[$yi])
				break;
			$this->xchanged[$xi] = $this->ychanged[$yi] = false;
		}

		// Ignore lines which do not exist in both files.
		for ($xi = $skip; $xi < $n_from - $endskip; $xi++)
			$xhash[$from_lines[$xi]] = 1;
		for ($yi = $skip; $yi < $n_to - $endskip; $yi++) {
			$line = $to_lines[$yi];
			if ( ($this->ychanged[$yi] = empty($xhash[$line])) )
				continue;
			$yhash[$line] = 1;
			$this->yv[] = $line;
			$this->yind[] = $yi;
		}
		for ($xi = $skip; $xi < $n_from - $endskip; $xi++) {
			$line = $from_lines[$xi];
			if ( ($this->xchanged[$xi] = empty($yhash[$line])) )
				continue;
			$this->xv[] = $line;
			$this->xind[] = $xi;
		}

		// Find the LCS.
		$this->_compareseq(0, sizeof($this->xv), 0, sizeof($this->yv));

		// Merge edits when possible
		$this->_shift_boundaries($from_lines, $this->xchanged, $this->ychanged);
		$this->_shift_boundaries($to_lines, $this->ychanged, $this->xchanged);

		// Compute the edit operations.
		$edits = array();
		$xi = $yi = 0;
		while ($xi < $n_from || $yi < $n_to) {
			USE_ASSERTS && assert($yi < $n_to || $this->xchanged[$xi]);
			USE_ASSERTS && assert($xi < $n_from || $this->ychanged[$yi]);

			// Skip matching "snake".
			$copy = array();
			while ( $xi < $n_from && $yi < $n_to
					&& !$this->xchanged[$xi] && !$this->ychanged[$yi]) {
				$copy[] = $from_lines[$xi++];
				++$yi;
			}
			if ($copy)
				$edits[] = new _DiffOp_Copy($copy);

			// Find deletes & adds.
			$delete = array();
			while ($xi < $n_from && $this->xchanged[$xi])
				$delete[] = $from_lines[$xi++];

			$add = array();
			while ($yi < $n_to && $this->ychanged[$yi])
				$add[] = $to_lines[$yi++];

			if ($delete && $add)
				$edits[] = new _DiffOp_Change($delete, $add);
			elseif ($delete)
				$edits[] = new _DiffOp_Delete($delete);
			elseif ($add)
				$edits[] = new _DiffOp_Add($add);
		}
		return $edits;
	}


	/* Divide the Largest Common Subsequence (LCS) of the sequences
	 * [XOFF, XLIM) and [YOFF, YLIM) into NCHUNKS approximately equally
	 * sized segments.
	 *
	 * Returns (LCS, PTS).  LCS is the length of the LCS. PTS is an
	 * array of NCHUNKS+1 (X, Y) indexes giving the diving points between
	 * sub sequences.  The first sub-sequence is contained in [X0, X1),
	 * [Y0, Y1), the second in [X1, X2), [Y1, Y2) and so on.  Note
	 * that (X0, Y0) == (XOFF, YOFF) and
	 * (X[NCHUNKS], Y[NCHUNKS]) == (XLIM, YLIM).
	 *
	 * This function assumes that the first lines of the specified portions
	 * of the two files do not match, and likewise that the last lines do not
	 * match.  The caller must trim matching lines from the beginning and end
	 * of the portions it is going to specify.
	 */
	public function _diag ($xoff, $xlim, $yoff, $ylim, $nchunks) {
	$flip = false;
	
	if ($xlim - $xoff > $ylim - $yoff) {
		// Things seems faster (I'm not sure I understand why)
			// when the shortest sequence in X.
			$flip = true;
		list ($xoff, $xlim, $yoff, $ylim)
		= array( $yoff, $ylim, $xoff, $xlim);
		}

	if ($flip)
		for ($i = $ylim - 1; $i >= $yoff; $i--)
		$ymatches[$this->xv[$i]][] = $i;
	else
		for ($i = $ylim - 1; $i >= $yoff; $i--)
		$ymatches[$this->yv[$i]][] = $i;

	$this->lcs = 0;
	$this->seq[0]= $yoff - 1;
	$this->in_seq = array();
	$ymids[0] = array();

	$numer = $xlim - $xoff + $nchunks - 1;
	$x = $xoff;
	for ($chunk = 0; $chunk < $nchunks; $chunk++) {
		if ($chunk > 0)
		for ($i = 0; $i <= $this->lcs; $i++)
			$ymids[$i][$chunk-1] = $this->seq[$i];

		$x1 = $xoff + (int)(($numer + ($xlim-$xoff)*$chunk) / $nchunks);
		for ( ; $x < $x1; $x++) {
				$line = $flip ? $this->yv[$x] : $this->xv[$x];
				if (empty($ymatches[$line]))
			continue;
		$matches = $ymatches[$line];
				reset($matches);
		while (list ($junk, $y) = each($matches))
			if (empty($this->in_seq[$y])) {
			$k = $this->_lcs_pos($y);
			USE_ASSERTS && assert($k > 0);
			$ymids[$k] = $ymids[$k-1];
			break;
					}
		while (list ($junk, $y) = each($matches)) {
			if ($y > $this->seq[$k-1]) {
			USE_ASSERTS && assert($y < $this->seq[$k]);
			// Optimization: this is a common case:
			//  next match is just replacing previous match.
			$this->in_seq[$this->seq[$k]] = false;
			$this->seq[$k] = $y;
			$this->in_seq[$y] = 1;
					}
			else if (empty($this->in_seq[$y])) {
			$k = $this->_lcs_pos($y);
			USE_ASSERTS && assert($k > 0);
			$ymids[$k] = $ymids[$k-1];
					}
				}
			}
		}

	$seps[] = $flip ? array($yoff, $xoff) : array($xoff, $yoff);
	$ymid = $ymids[$this->lcs];
	for ($n = 0; $n < $nchunks - 1; $n++) {
		$x1 = $xoff + (int)(($numer + ($xlim - $xoff) * $n) / $nchunks);
		$y1 = $ymid[$n] + 1;
		$seps[] = $flip ? array($y1, $x1) : array($x1, $y1);
		}
	$seps[] = $flip ? array($ylim, $xlim) : array($xlim, $ylim);

	return array($this->lcs, $seps);
	}

	public function _lcs_pos ($ypos) {
	$end = $this->lcs;
	if ($end == 0 || $ypos > $this->seq[$end]) {
		$this->seq[++$this->lcs] = $ypos;
		$this->in_seq[$ypos] = 1;
		return $this->lcs;
		}

	$beg = 1;
	while ($beg < $end) {
		$mid = (int)(($beg + $end) / 2);
		if ( $ypos > $this->seq[$mid] )
		$beg = $mid + 1;
		else
		$end = $mid;
		}

	USE_ASSERTS && assert($ypos != $this->seq[$end]);

	$this->in_seq[$this->seq[$end]] = false;
	$this->seq[$end] = $ypos;
	$this->in_seq[$ypos] = 1;
	return $end;
	}

	/* Find LCS of two sequences.
	 *
	 * The results are recorded in the vectors $this->{x,y}changed[], by
	 * storing a 1 in the element for each line that is an insertion
	 * or deletion (ie. is not in the LCS).
	 *
	 * The subsequence of file 0 is [XOFF, XLIM) and likewise for file 1.
	 *
	 * Note that XLIM, YLIM are exclusive bounds.
	 * All line numbers are origin-0 and discarded lines are not counted.
	 */
	public function _compareseq ($xoff, $xlim, $yoff, $ylim) {
	// Slide down the bottom initial diagonal.
	while ($xoff < $xlim && $yoff < $ylim
			&& $this->xv[$xoff] == $this->yv[$yoff]) {
		++$xoff;
		++$yoff;
		}

	// Slide up the top initial diagonal.
	while ($xlim > $xoff && $ylim > $yoff
			&& $this->xv[$xlim - 1] == $this->yv[$ylim - 1]) {
		--$xlim;
		--$ylim;
		}

	if ($xoff == $xlim || $yoff == $ylim)
		$lcs = 0;
	else {
		// This is ad hoc but seems to work well.
		//$nchunks = sqrt(min($xlim - $xoff, $ylim - $yoff) / 2.5);
		//$nchunks = max(2,min(8,(int)$nchunks));
		$nchunks = min(7, $xlim - $xoff, $ylim - $yoff) + 1;
		list ($lcs, $seps)
		= $this->_diag($xoff,$xlim,$yoff, $ylim,$nchunks);
		}

	if ($lcs == 0) {
		// X and Y sequences have no common subsequence:
		// mark all changed.
		while ($yoff < $ylim)
		$this->ychanged[$this->yind[$yoff++]] = 1;
		while ($xoff < $xlim)
		$this->xchanged[$this->xind[$xoff++]] = 1;
		}
	else {
		// Use the partitions to split this problem into subproblems.
		reset($seps);
		$pt1 = $seps[0];
		while ($pt2 = next($seps)) {
		$this->_compareseq ($pt1[0], $pt2[0], $pt1[1], $pt2[1]);
		$pt1 = $pt2;
			}
		}
	}

	/* Adjust inserts/deletes of identical lines to join changes
	 * as much as possible.
	 *
	 * We do something when a run of changed lines include a
	 * line at one end and has an excluded, identical line at the other.
	 * We are free to choose which identical line is included.
	 * 'compareseq' usually chooses the one at the beginning,
	 * but usually it is cleaner to consider the following identical line
	 * to be the "change".
	 *
	 * This is extracted verbatim from analyze.c (GNU diffutils-2.7).
	 */
	public function _shift_boundaries ($lines, &$changed, $other_changed) {
	$i = 0;
	$j = 0;

	USE_ASSERTS && assert('sizeof($lines) == sizeof($changed)');
	$len = sizeof($lines);
	$other_len = sizeof($other_changed);

	while (1) {
		/*
		 * Scan forwards to find beginning of another run of changes.
		 * Also keep track of the corresponding point in the other file.
		 *
		 * Throughout this code, $i and $j are adjusted together so that
		 * the first $i elements of $changed and the first $j elements
		 * of $other_changed both contain the same number of zeros
		 * (unchanged lines).
		 * Furthermore, $j is always kept so that $j == $other_len or
		 * $other_changed[$j] == false.
		 */
		while ($j < $other_len && $other_changed[$j])
		$j++;
	
		while ($i < $len && ! $changed[$i]) {
		USE_ASSERTS && assert('$j < $other_len && ! $other_changed[$j]');
		$i++; $j++;
		while ($j < $other_len && $other_changed[$j])
			$j++;
			}

		if ($i == $len)
		break;

		$start = $i;

		// Find the end of this run of changes.
		while (++$i < $len && $changed[$i])
		continue;

		do {
		/*
		 * Record the length of this run of changes, so that
		 * we can later determine whether the run has grown.
		 */
		$runlength = $i - $start;

		/*
		 * Move the changed region back, so long as the
		 * previous unchanged line matches the last changed one.
		 * This merges with previous changed regions.
		 */
		while ($start > 0 && $lines[$start - 1] == $lines[$i - 1]) {
			$changed[--$start] = 1;
			$changed[--$i] = false;
			while ($start > 0 && $changed[$start - 1])
			$start--;
			USE_ASSERTS && assert('$j > 0');
			while ($other_changed[--$j])
			continue;
			USE_ASSERTS && assert('$j >= 0 && !$other_changed[$j]');
				}

		/*
		 * Set CORRESPONDING to the end of the changed run, at the last
		 * point where it corresponds to a changed run in the other file.
		 * CORRESPONDING == LEN means no such point has been found.
		 */
		$corresponding = $j < $other_len ? $i : $len;

		/*
		 * Move the changed region forward, so long as the
		 * first changed line matches the following unchanged one.
		 * This merges with following changed regions.
		 * Do this second, so that if there are no merges,
		 * the changed region is moved forward as far as possible.
		 */
		while ($i < $len && $lines[$start] == $lines[$i]) {
			$changed[$start++] = false;
			$changed[$i++] = 1;
			while ($i < $len && $changed[$i])
			$i++;

			USE_ASSERTS && assert('$j < $other_len && ! $other_changed[$j]');
			$j++;
			if ($j < $other_len && $other_changed[$j]) {
			$corresponding = $i;
			while ($j < $other_len && $other_changed[$j])
				$j++;
					}
				}
			} while ($runlength != $i - $start);

		/*
		 * If possible, move the fully-merged run of changes
		 * back to a corresponding run in the other file.
		 */
		while ($corresponding < $i) {
		$changed[--$start] = 1;
		$changed[--$i] = 0;
		USE_ASSERTS && assert('$j > 0');
		while ($other_changed[--$j])
			continue;
		USE_ASSERTS && assert('$j >= 0 && !$other_changed[$j]');
			}
		}
	}
}

/**
 * Class representing a 'diff' between two sequences of strings.
 * @package framework
 * @subpackage core
 */
class Diff
{
	public static $html_cleaner_class = null;

	var $edits;

	/**
	 * Constructor.
	 * Computes diff between sequences of strings.
	 *
	 * @param $from_lines array An array of strings.
	 *        (Typically these are lines from a file.)
	 * @param $to_lines array An array of strings.
	 */
	public function Diff($from_lines, $to_lines) {
		$eng = new _DiffEngine;
		$this->edits = $eng->diff($from_lines, $to_lines);
		//$this->_check($from_lines, $to_lines);
	}

	/**
	 * 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 = array();
		foreach ($this->edits as $edit) {
			$rev->edits[] = $edit->reverse();
		}
	return $rev;
	}

	/**
	 * Check for empty diff.
	 *
	 * @return bool True iff 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 += sizeof($edit->orig);
		}
	return $lcs;
	}

	/**
	 * Get the original set of lines.
	 *
	 * This reconstructs the $from_lines parameter passed to the
	 * constructor.
	 *
	 * @return array The original sequence of strings.
	 */
	public function orig() {
		$lines = array();

		foreach ($this->edits as $edit) {
			if ($edit->orig)
				array_splice($lines, sizeof($lines), 0, $edit->orig);
		}
		return $lines;
	}

	/**
	 * Get the final set of lines.
	 *
	 * This reconstructs the $to_lines parameter passed to the
	 * constructor.
	 *
	 * @return array The sequence of strings.
	 */
	public function finaltext() {
		$lines = array();

		foreach ($this->edits as $edit) {
			if ($edit->final)
				array_splice($lines, sizeof($lines), 0, $edit->final);
		}
		return $lines;
	}

	/**
	 * Check a Diff for validity.
	 *
	 * This is here only for debugging purposes.
	 */
	public function _check ($from_lines, $to_lines) {
		if (serialize($from_lines) != serialize($this->orig()))
			trigger_error("Reconstructed original doesn't match", E_USER_ERROR);
		if (serialize($to_lines) != serialize($this->finaltext()))
			trigger_error("Reconstructed final doesn't match", E_USER_ERROR);

		$rev = $this->reverse();
		if (serialize($to_lines) != serialize($rev->orig()))
			trigger_error("Reversed original doesn't match", E_USER_ERROR);
		if (serialize($from_lines) != serialize($rev->finaltext()))
			trigger_error("Reversed final doesn't match", E_USER_ERROR);


		$prevtype = 'none';
		foreach ($this->edits as $edit) {
			if ( $prevtype == $edit->type )
				trigger_error("Edit sequence is non-optimal", E_USER_ERROR);
			$prevtype = $edit->type;
		}

		$lcs = $this->lcs();
		trigger_error("Diff okay: LCS = $lcs", E_USER_NOTICE);
	}
	


	/**
	 *  Attempt to clean invalid HTML, which messes up diffs.
	 *  This cleans code if possible, using an instance of HTMLCleaner
	 *
	 *  NB: By default, only extremely simple tidying is performed,
	 *  by passing through DomDocument::loadHTML and saveXML
	 *
	 * @param string $content HTML content
	 * @param object $cleaner Optional instance of a HTMLCleaner class to
	 * 	use, overriding self::$html_cleaner_class
	 */
	public static function cleanHTML($content, $cleaner=null) {
		if (!$cleaner) {
			if (class_exists(self::$html_cleaner_class)) {
				$cleaner = new self::$html_cleaner_class;
			} else {
				$cleaner = HTMLCleaner::inst();    //load cleaner if the dependent class is available
			}
		}

		if ($cleaner) {
			$content = $cleaner->cleanHTML($content);
		} else {
			// At most basic level of cleaning, use DOMDocument to save valid XML.
			$doc = Injector::inst()->create('HTMLValue', $content);
			$content = $doc->getContent();
		}

		// Remove empty <ins /> and <del /> tags because browsers hate them
		$content = preg_replace('/<(ins|del)[^>]*\/>/','', $content);

		return $content;
	}

	/**
	 * @param String
	 * @param String
	 * @param Boolean
	 * @return String
	 */
	public static function compareHTML($from, $to, $escape = false) {
		// First split up the content into words and tags
		$set1 = self::getHTMLChunks($from);
		$set2 = self::getHTMLChunks($to);

		// Diff that
		$diff = new Diff($set1, $set2);

		$tagStack[1] = $tagStack[2] = 0;
		$rechunked[1] = $rechunked[2] = array();
		
		// Go through everything, converting edited tags (and their content) into single chunks.  Otherwise
		// the generated HTML gets crusty
		foreach($diff->edits as $edit) {
			switch($edit->type) {
				case 'copy':
					$lookForTag = false;
					$stuffFor[1] = $edit->orig;
					$stuffFor[2] = $edit->orig;
					break;
				
				case 'change':
					$lookForTag = true;
					$stuffFor[1] = $edit->orig;
					$stuffFor[2] = $edit->final;
					break;
				
				case 'add':
					$lookForTag = true;
					$stuffFor[1] = null;
					$stuffFor[2] = $edit->final;
					break;
				
				case 'delete':
					$lookForTag = true;
					$stuffFor[1] = $edit->orig;
					$stuffFor[2] = null;
					break;
			}
			
			foreach($stuffFor as $listName => $chunks) {
				if($chunks) {
					foreach($chunks as $item) {
						// $tagStack > 0 indicates that we should be tag-building
						if($tagStack[$listName]) $rechunked[$listName][sizeof($rechunked[$listName])-1] .= ' ' . $item;
						else $rechunked[$listName][] = $item;
	
						if($lookForTag && !$tagStack[$listName] && isset($item[0]) && $item[0] == "<" 
								&& substr($item,0,2) != "</") { 
							$tagStack[$listName] = 1;
						} else if($tagStack[$listName]) {
							if(substr($item,0,2) == "</") $tagStack[$listName]--;
							else if(isset($item[0]) && $item[0] == "<") $tagStack[$listName]++;
						}
					}
				}
			}
		}
		
		// Diff the re-chunked data, turning it into maked up HTML
		$diff = new Diff($rechunked[1], $rechunked[2]);
		$content = '';
		foreach($diff->edits as $edit) {
			$orig = ($escape) ? Convert::raw2xml($edit->orig) : $edit->orig;
			$final = ($escape) ? Convert::raw2xml($edit->final) : $edit->final;

			switch($edit->type) {
				case 'copy':
					$content .= " " . implode(" ", $orig) . " ";
					break;
				
				case 'change':
					$content .= " <ins>" . implode(" ", $final) . "</ins> ";
					$content .= " <del>" . implode(" ", $orig) . "</del> ";
					break;
				
				case 'add':
					$content .= " <ins>" . implode(" ", $final) . "</ins> ";
					break;
				
				case 'delete':
					$content .= " <del>" . implode(" ", $orig) . "</del> ";
					break;
			}
		}		

		return self::cleanHTML($content);
	}
	
	/**
	 * @param string|array If passed as an array, values will be concatenated with a comma.
	 */
	public static function getHTMLChunks($content) {
		if($content && !is_string($content) && !is_array($content) && !is_numeric($content)) {
			throw new InvalidArgumentException('$content parameter needs to be a string or array');
		}
		if(is_array($content)) $content = implode(',', $content);
		
		$content = str_replace(array("&nbsp;","<", ">"),array(" "," <", "> "),$content);
		$candidateChunks = preg_split("/[\t\r\n ]+/", $content);
		while(list($i,$item) = each($candidateChunks)) {
			if(isset($item[0]) && $item[0] == "<") {
				$newChunk = $item;
				while($item[strlen($item)-1] != ">") {
					list($i,$item) = each($candidateChunks);
					$newChunk .= ' ' . $item;
				}
				$chunks[] = $newChunk;
			} else {
				$chunks[] = $item;
			}
		}
		return $chunks;
	}
	
}




/**
 * Computes diff between sequences of strings.
 * @package framework
 * @subpackage core
 */
class MappedDiff
extends Diff
{
	/**
	 * Constructor.
	 *
	 * Computes diff between sequences of strings.
	 *
	 * This can be used to compute things like
	 * case-insensitve diffs, or diffs which ignore
	 * changes in white-space.
	 *
	 * @param $from_lines array An array of strings.
	 *  (Typically these are lines from a file.)
	 *
	 * @param $to_lines array An array of strings.
	 *
	 * @param $mapped_from_lines array This array should
	 *  have the same size number of elements as $from_lines.
	 *  The elements in $mapped_from_lines and
	 *  $mapped_to_lines are what is actually compared
	 *  when computing the diff.
	 *
	 * @param $mapped_to_lines array This array should
	 *  have the same number of elements as $to_lines.
	 */
	public function MappedDiff($from_lines, $to_lines,
						$mapped_from_lines, $mapped_to_lines) {

		assert(sizeof($from_lines) == sizeof($mapped_from_lines));
		assert(sizeof($to_lines) == sizeof($mapped_to_lines));

		$this->Diff($mapped_from_lines, $mapped_to_lines);

		$xi = $yi = 0;
		// Optimizing loop invariants:
		// http://phplens.com/lens/php-book/optimizing-debugging-php.php
		for ($i = 0, $max = sizeof($this->edits); $i < $max; $i++) {
			$orig = &$this->edits[$i]->orig;
			if (is_array($orig)) {
				$orig = array_slice($from_lines, $xi, sizeof($orig));
				$xi += sizeof($orig);
			}

			$final = &$this->edits[$i]->final;
			if (is_array($final)) {
				$final = array_slice($to_lines, $yi, sizeof($final));
				$yi += sizeof($final);
			}
		}
	}
}