wp-includes/wp-diff.php

   1 <?php
   2 /**
   3  * WordPress Diff bastard child of old MediaWiki Diff Formatter.
   4  *
   5  * Basically all that remains is the table structure and some method names.
   6  *
   7  * @package WordPress
   8  * @subpackage Diff
   9  */
  10
  11 if ( !class_exists( 'Text_Diff' ) ) {
  12         /** Text_Diff class */
  13         require( dirname(__FILE__).'/Text/Diff.php' );
  14         /** Text_Diff_Renderer class */
  15         require( dirname(__FILE__).'/Text/Diff/Renderer.php' );
  16         /** Text_Diff_Renderer_inline class */
  17         require( dirname(__FILE__).'/Text/Diff/Renderer/inline.php' );
  18 }
  19
  20 /**
  21  * Table renderer to display the diff lines.
  22  *
  23  * @since 2.6.0
  24  * @uses Text_Diff_Renderer Extends
  25  */
  26 class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer {
  27
  28         /**
  29          * @see Text_Diff_Renderer::_leading_context_lines
  30          * @var int
  31          * @access protected
  32          * @since 2.6.0
  33          */
  34         var $_leading_context_lines  = 10000;
  35
  36         /**
  37          * @see Text_Diff_Renderer::_trailing_context_lines
  38          * @var int
  39          * @access protected
  40          * @since 2.6.0
  41          */
  42         var $_trailing_context_lines = 10000;
  43
  44         /**
  45          * {@internal Missing Description}}
  46          *
  47          * @var float
  48          * @access protected
  49          * @since 2.6.0
  50          */
  51         var $_diff_threshold = 0.6;
  52
  53         /**
  54          * Inline display helper object name.
  55          *
  56          * @var string
  57          * @access protected
  58          * @since 2.6.0
  59          */
  60         var $inline_diff_renderer = 'WP_Text_Diff_Renderer_inline';
  61
  62         /**
  63          * Constructor - Call parent constructor with params array.
  64          *
  65          * This will set class properties based on the key value pairs in the array.
  66          *
  67          * @since 2.6.0
  68          *
  69          * @param array $params
  70          */
  71         function __construct( $params = array() ) {
  72                 parent::__construct( $params );
  73         }
  74
  75         /**
  76          * @ignore
  77          *
  78          * @param string $header
  79          * @return string
  80          */
  81         function _startBlock( $header ) {
  82                 return '';
  83         }
  84
  85         /**
  86          * @ignore
  87          *
  88          * @param array $lines
  89          * @param string $prefix
  90          */
  91         function _lines( $lines, $prefix=' ' ) {
  92         }
  93
  94         /**
  95          * @ignore
  96          *
  97          * @param string $line HTML-escape the value.
  98          * @return string
  99          */
 100         function addedLine( $line ) {
 101                 return "<td>+</td><td class='diff-addedline'>{$line}</td>";
 102         }
 103
 104         /**
 105          * @ignore
 106          *
 107          * @param string $line HTML-escape the value.
 108          * @return string
 109          */
 110         function deletedLine( $line ) {
 111                 return "<td>-</td><td class='diff-deletedline'>{$line}</td>";
 112         }
 113
 114         /**
 115          * @ignore
 116          *
 117          * @param string $line HTML-escape the value.
 118          * @return string
 119          */
 120         function contextLine( $line ) {
 121                 return "<td> </td><td class='diff-context'>{$line}</td>";
 122         }
 123
 124         /**
 125          * @ignore
 126          *
 127          * @return string
 128          */
 129         function emptyLine() {
 130                 return '<td colspan="2">&nbsp;</td>';
 131         }
 132
 133         /**
 134          * @ignore
 135          * @access private
 136          *
 137          * @param array $lines
 138          * @param bool $encode
 139          * @return string
 140          */
 141         function _added( $lines, $encode = true ) {
 142                 $r = '';
 143                 foreach ($lines as $line) {
 144                         if ( $encode )
 145                                 $line = htmlspecialchars( $line );
 146                         $r .= '<tr>' . $this->emptyLine() . $this->addedLine( $line ) . "</tr>\n";
 147                 }
 148                 return $r;
 149         }
 150
 151         /**
 152          * @ignore
 153          * @access private
 154          *
 155          * @param array $lines
 156          * @param bool $encode
 157          * @return string
 158          */
 159         function _deleted( $lines, $encode = true ) {
 160                 $r = '';
 161                 foreach ($lines as $line) {
 162                         if ( $encode )
 163                                 $line = htmlspecialchars( $line );
 164                         $r .= '<tr>' . $this->deletedLine( $line ) . $this->emptyLine() . "</tr>\n";
 165                 }
 166                 return $r;
 167         }
 168
 169         /**
 170          * @ignore
 171          * @access private
 172          *
 173          * @param array $lines
 174          * @param bool $encode
 175          * @return string
 176          */
 177         function _context( $lines, $encode = true ) {
 178                 $r = '';
 179                 foreach ($lines as $line) {
 180                         if ( $encode )
 181                                 $line = htmlspecialchars( $line );
 182                         $r .= '<tr>' .
 183                                 $this->contextLine( $line ) . $this->contextLine( $line ) . "</tr>\n";
 184                 }
 185                 return $r;
 186         }
 187
 188         /**
 189          * Process changed lines to do word-by-word diffs for extra highlighting.
 190          *
 191          * (TRAC style) sometimes these lines can actually be deleted or added rows.
 192          * We do additional processing to figure that out
 193          *
 194          * @access private
 195          * @since 2.6.0
 196          *
 197          * @param array $orig
 198          * @param array $final
 199          * @return string
 200          */
 201         function _changed( $orig, $final ) {
 202                 $r = '';
 203
 204                 // Does the aforementioned additional processing
 205                 // *_matches tell what rows are "the same" in orig and final.  Those pairs will be diffed to get word changes
 206                 //      match is numeric: an index in other column
 207                 //      match is 'X': no match.  It is a new row
 208                 // *_rows are column vectors for the orig column and the final column.
 209                 //      row >= 0: an indix of the $orig or $final array
 210                 //      row  < 0: a blank row for that column
 211                 list($orig_matches, $final_matches, $orig_rows, $final_rows) = $this->interleave_changed_lines( $orig, $final );
 212
 213
 214                 // These will hold the word changes as determined by an inline diff
 215                 $orig_diffs  = array();
 216                 $final_diffs = array();
 217
 218                 // Compute word diffs for each matched pair using the inline diff
 219                 foreach ( $orig_matches as $o => $f ) {
 220                         if ( is_numeric($o) && is_numeric($f) ) {
 221                                 $text_diff = new Text_Diff( 'auto', array( array($orig[$o]), array($final[$f]) ) );
 222                                 $renderer = new $this->inline_diff_renderer;
 223                                 $diff = $renderer->render( $text_diff );
 224
 225                                 // If they're too different, don't include any <ins> or <dels>
 226                                 if ( $diff_count = preg_match_all( '!(<ins>.*?</ins>|<del>.*?</del>)!', $diff, $diff_matches ) ) {
 227                                         // length of all text between <ins> or <del>
 228                                         $stripped_matches = strlen(strip_tags( join(' ', $diff_matches[0]) ));
 229                                         // since we count lengith of text between <ins> or <del> (instead of picking just one),
 230                                         //      we double the length of chars not in those tags.
 231                                         $stripped_diff = strlen(strip_tags( $diff )) * 2 - $stripped_matches;
 232                                         $diff_ratio = $stripped_matches / $stripped_diff;
 233                                         if ( $diff_ratio > $this->_diff_threshold )
 234                                                 continue; // Too different.  Don't save diffs.
 235                                 }
 236
 237                                 // Un-inline the diffs by removing del or ins
 238                                 $orig_diffs[$o]  = preg_replace( '|<ins>.*?</ins>|', '', $diff );
 239                                 $final_diffs[$f] = preg_replace( '|<del>.*?</del>|', '', $diff );
 240                         }
 241                 }
 242
 243                 foreach ( array_keys($orig_rows) as $row ) {
 244                         // Both columns have blanks.  Ignore them.
 245                         if ( $orig_rows[$row] < 0 && $final_rows[$row] < 0 )
 246                                 continue;
 247
 248                         // If we have a word based diff, use it.  Otherwise, use the normal line.
 249                         if ( isset( $orig_diffs[$orig_rows[$row]] ) )
 250                                 $orig_line = $orig_diffs[$orig_rows[$row]];
 251                         elseif ( isset( $orig[$orig_rows[$row]] ) )
 252                                 $orig_line = htmlspecialchars($orig[$orig_rows[$row]]);
 253                         else
 254                                 $orig_line = '';
 255
 256                         if ( isset( $final_diffs[$final_rows[$row]] ) )
 257                                 $final_line = $final_diffs[$final_rows[$row]];
 258                         elseif ( isset( $final[$final_rows[$row]] ) )
 259                                 $final_line = htmlspecialchars($final[$final_rows[$row]]);
 260                         else
 261                                 $final_line = '';
 262
 263                         if ( $orig_rows[$row] < 0 ) { // Orig is blank.  This is really an added row.
 264                                 $r .= $this->_added( array($final_line), false );
 265                         } elseif ( $final_rows[$row] < 0 ) { // Final is blank.  This is really a deleted row.
 266                                 $r .= $this->_deleted( array($orig_line), false );
 267                         } else { // A true changed row.
 268                                 $r .= '<tr>' . $this->deletedLine( $orig_line ) . $this->addedLine( $final_line ) . "</tr>\n";
 269                         }
 270                 }
 271
 272                 return $r;
 273         }
 274
 275         /**
 276          * Takes changed blocks and matches which rows in orig turned into which rows in final.
 277          *
 278          * Returns
 279          *      *_matches ( which rows match with which )
 280          *      *_rows ( order of rows in each column interleaved with blank rows as
 281          *              necessary )
 282          *
 283          * @since 2.6.0
 284          *
 285          * @param unknown_type $orig
 286          * @param unknown_type $final
 287          * @return unknown
 288          */
 289         function interleave_changed_lines( $orig, $final ) {
 290
 291                 // Contains all pairwise string comparisons.  Keys are such that this need only be a one dimensional array.
 292                 $matches = array();
 293                 foreach ( array_keys($orig) as $o ) {
 294                         foreach ( array_keys($final) as $f ) {
 295                                 $matches["$o,$f"] = $this->compute_string_distance( $orig[$o], $final[$f] );
 296                         }
 297                 }
 298                 asort($matches); // Order by string distance.
 299
 300                 $orig_matches  = array();
 301                 $final_matches = array();
 302
 303                 foreach ( $matches as $keys => $difference ) {
 304                         list($o, $f) = explode(',', $keys);
 305                         $o = (int) $o;
 306                         $f = (int) $f;
 307
 308                         // Already have better matches for these guys
 309                         if ( isset($orig_matches[$o]) && isset($final_matches[$f]) )
 310                                 continue;
 311
 312                         // First match for these guys.  Must be best match
 313                         if ( !isset($orig_matches[$o]) && !isset($final_matches[$f]) ) {
 314                                 $orig_matches[$o] = $f;
 315                                 $final_matches[$f] = $o;
 316                                 continue;
 317                         }
 318
 319                         // Best match of this final is already taken?  Must mean this final is a new row.
 320                         if ( isset($orig_matches[$o]) )
 321                                 $final_matches[$f] = 'x';
 322
 323                         // Best match of this orig is already taken?  Must mean this orig is a deleted row.
 324                         elseif ( isset($final_matches[$f]) )
 325                                 $orig_matches[$o] = 'x';
 326                 }
 327
 328                 // We read the text in this order
 329                 ksort($orig_matches);
 330                 ksort($final_matches);
 331
 332
 333                 // Stores rows and blanks for each column.
 334                 $orig_rows = $orig_rows_copy = array_keys($orig_matches);
 335                 $final_rows = array_keys($final_matches);
 336
 337                 // Interleaves rows with blanks to keep matches aligned.
 338                 // We may end up with some extraneous blank rows, but we'll just ignore them later.
 339                 foreach ( $orig_rows_copy as $orig_row ) {
 340                         $final_pos = array_search($orig_matches[$orig_row], $final_rows, true);
 341                         $orig_pos = (int) array_search($orig_row, $orig_rows, true);
 342
 343                         if ( false === $final_pos ) { // This orig is paired with a blank final.
 344                                 array_splice( $final_rows, $orig_pos, 0, -1 );
 345                         } elseif ( $final_pos < $orig_pos ) { // This orig's match is up a ways.  Pad final with blank rows.
 346                                 $diff_pos = $final_pos - $orig_pos;
 347                                 while ( $diff_pos < 0 )
 348                                         array_splice( $final_rows, $orig_pos, 0, $diff_pos++ );
 349                         } elseif ( $final_pos > $orig_pos ) { // This orig's match is down a ways.  Pad orig with blank rows.
 350                                 $diff_pos = $orig_pos - $final_pos;
 351                                 while ( $diff_pos < 0 )
 352                                         array_splice( $orig_rows, $orig_pos, 0, $diff_pos++ );
 353                         }
 354                 }
 355
 356
 357                 // Pad the ends with blank rows if the columns aren't the same length
 358                 $diff_count = count($orig_rows) - count($final_rows);
 359                 if ( $diff_count < 0 ) {
 360                         while ( $diff_count < 0 )
 361                                 array_push($orig_rows, $diff_count++);
 362                 } elseif ( $diff_count > 0 ) {
 363                         $diff_count = -1 * $diff_count;
 364                         while ( $diff_count < 0 )
 365                                 array_push($final_rows, $diff_count++);
 366                 }
 367
 368                 return array($orig_matches, $final_matches, $orig_rows, $final_rows);
 369
 370 /*
 371                 // Debug
 372                 echo "\n\n\n\n\n";
 373
 374                 echo "-- DEBUG Matches: Orig -> Final --";
 375
 376                 foreach ( $orig_matches as $o => $f ) {
 377                         echo "\n\n\n\n\n";
 378                         echo "ORIG: $o, FINAL: $f\n";
 379                         var_dump($orig[$o],$final[$f]);
 380                 }
 381                 echo "\n\n\n\n\n";
 382
 383                 echo "-- DEBUG Matches: Final -> Orig --";
 384
 385                 foreach ( $final_matches as $f => $o ) {
 386                         echo "\n\n\n\n\n";
 387                         echo "FINAL: $f, ORIG: $o\n";
 388                         var_dump($final[$f],$orig[$o]);
 389                 }
 390                 echo "\n\n\n\n\n";
 391
 392                 echo "-- DEBUG Rows: Orig -- Final --";
 393
 394                 echo "\n\n\n\n\n";
 395                 foreach ( $orig_rows as $row => $o ) {
 396                         if ( $o < 0 )
 397                                 $o = 'X';
 398                         $f = $final_rows[$row];
 399                         if ( $f < 0 )
 400                                 $f = 'X';
 401                         echo "$o -- $f\n";
 402                 }
 403                 echo "\n\n\n\n\n";
 404
 405                 echo "-- END DEBUG --";
 406
 407                 echo "\n\n\n\n\n";
 408
 409                 return array($orig_matches, $final_matches, $orig_rows, $final_rows);
 410 */
 411         }
 412
 413         /**
 414          * Computes a number that is intended to reflect the "distance" between two strings.
 415          *
 416          * @since 2.6.0
 417          *
 418          * @param string $string1
 419          * @param string $string2
 420          * @return int
 421          */
 422         function compute_string_distance( $string1, $string2 ) {
 423                 // Vectors containing character frequency for all chars in each string
 424                 $chars1 = count_chars($string1);
 425                 $chars2 = count_chars($string2);
 426
 427                 // L1-norm of difference vector.
 428                 $difference = array_sum( array_map( array(&$this, 'difference'), $chars1, $chars2 ) );
 429
 430                 // $string1 has zero length? Odd.  Give huge penalty by not dividing.
 431                 if ( !$string1 )
 432                         return $difference;
 433
 434                 // Return distance per charcter (of string1)
 435                 return $difference / strlen($string1);
 436         }
 437
 438         /**
 439          * @ignore
 440          * @since 2.6.0
 441          *
 442          * @param int $a
 443          * @param int $b
 444          * @return int
 445          */
 446         function difference( $a, $b ) {
 447                 return abs( $a - $b );
 448         }
 449
 450 }
 451
 452 /**
 453  * Better word splitting than the PEAR package provides.
 454  *
 455  * @since 2.6.0
 456  * @uses Text_Diff_Renderer_inline Extends
 457  */
 458 class WP_Text_Diff_Renderer_inline extends Text_Diff_Renderer_inline {
 459
 460         /**
 461          * @ignore
 462          * @since 2.6.0
 463          *
 464          * @param string $string
 465          * @param string $newlineEscape
 466          * @return string
 467          */
 468         function _splitOnWords($string, $newlineEscape = "\n") {
 469                 $string = str_replace("\0", '', $string);
 470                 $words  = preg_split( '/([^\w])/u', $string, -1, PREG_SPLIT_DELIM_CAPTURE );
 471                 $words  = str_replace( "\n", $newlineEscape, $words );
 472                 return $words;
 473         }
 474
 475 }
 476
 477 ?>