X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/76aea3697c6043c1613370f172395b4f65ee71f0..8d3bb1a5dcfdea9857d3c88c3751f09593e34dc8:/wp-includes/wp-diff.php diff --git a/wp-includes/wp-diff.php b/wp-includes/wp-diff.php index e43903d8..8eeacddc 100644 --- a/wp-includes/wp-diff.php +++ b/wp-includes/wp-diff.php @@ -1,102 +1,266 @@ $parent( $params ); + /** + * @see Text_Diff_Renderer::_leading_context_lines + * @var int + * @access public + * @since 2.6.0 + */ + public $_leading_context_lines = 10000; + + /** + * @see Text_Diff_Renderer::_trailing_context_lines + * @var int + * @access public + * @since 2.6.0 + */ + public $_trailing_context_lines = 10000; + + /** + * Threshold for when a diff should be saved or omitted. + * + * @var float + * @access protected + * @since 2.6.0 + */ + protected $_diff_threshold = 0.6; + + /** + * Inline display helper object name. + * + * @var string + * @access protected + * @since 2.6.0 + */ + protected $inline_diff_renderer = 'WP_Text_Diff_Renderer_inline'; + + /** + * Should we show the split view or not + * + * @var string + * @access protected + * @since 3.6.0 + */ + protected $_show_split_view = true; + + protected $compat_fields = array( '_show_split_view', 'inline_diff_renderer', '_diff_threshold' ); + + /** + * Constructor - Call parent constructor with params array. + * + * This will set class properties based on the key value pairs in the array. + * + * @since 2.6.0 + * + * @param array $params + */ + public function __construct( $params = array() ) { + parent::__construct( $params ); + if ( isset( $params[ 'show_split_view' ] ) ) + $this->_show_split_view = $params[ 'show_split_view' ]; } - function _startBlock( $header ) { + /** + * @ignore + * + * @param string $header + * @return string + */ + public function _startBlock( $header ) { return ''; } - function _lines( $lines, $prefix=' ' ) { + /** + * @ignore + * + * @param array $lines + * @param string $prefix + */ + public function _lines( $lines, $prefix=' ' ) { } - // HTML-escape parameter before calling this - function addedLine( $line ) { - return "+{$line}"; + /** + * @ignore + * + * @param string $line HTML-escape the value. + * @return string + */ + public function addedLine( $line ) { + return "{$line}"; + } - // HTML-escape parameter before calling this - function deletedLine( $line ) { - return "-{$line}"; + /** + * @ignore + * + * @param string $line HTML-escape the value. + * @return string + */ + public function deletedLine( $line ) { + return "{$line}"; } - // HTML-escape parameter before calling this - function contextLine( $line ) { - return " {$line}"; + /** + * @ignore + * + * @param string $line HTML-escape the value. + * @return string + */ + public function contextLine( $line ) { + return "{$line}"; } - function emptyLine() { - return ' '; + /** + * @ignore + * + * @return string + */ + public function emptyLine() { + return ' '; } - function _added( $lines, $encode = true ) { + /** + * @ignore + * @access public + * + * @param array $lines + * @param bool $encode + * @return string + */ + public function _added( $lines, $encode = true ) { $r = ''; foreach ($lines as $line) { - if ( $encode ) - $line = htmlspecialchars( $line ); - $r .= '' . $this->emptyLine() . $this->addedLine( $line ) . "\n"; + if ( $encode ) { + $processed_line = htmlspecialchars( $line ); + + /** + * Contextually filters a diffed line. + * + * Filters TextDiff processing of diffed line. By default, diffs are processed with + * htmlspecialchars. Use this filter to remove or change the processing. Passes a context + * indicating if the line is added, deleted or unchanged. + * + * @since 4.1.0 + * + * @param String $processed_line The processed diffed line. + * @param String $line The unprocessed diffed line. + * @param string null The line context. Values are 'added', 'deleted' or 'unchanged'. + */ + $line = apply_filters( 'process_text_diff_html', $processed_line, $line, 'added' ); + } + + if ( $this->_show_split_view ) { + $r .= '' . $this->emptyLine() . $this->emptyLine() . $this->addedLine( $line ) . "\n"; + } else { + $r .= '' . $this->addedLine( $line ) . "\n"; + } } return $r; } - function _deleted( $lines, $encode = true ) { + /** + * @ignore + * @access public + * + * @param array $lines + * @param bool $encode + * @return string + */ + public function _deleted( $lines, $encode = true ) { $r = ''; foreach ($lines as $line) { - if ( $encode ) - $line = htmlspecialchars( $line ); - $r .= '' . $this->deletedLine( $line ) . $this->emptyLine() . "\n"; + if ( $encode ) { + $processed_line = htmlspecialchars( $line ); + + /** This filter is documented in wp-includes/wp-diff.php */ + $line = apply_filters( 'process_text_diff_html', $processed_line, $line, 'deleted' ); + } + if ( $this->_show_split_view ) { + $r .= '' . $this->deletedLine( $line ) . $this->emptyLine() . $this->emptyLine() . "\n"; + } else { + $r .= '' . $this->deletedLine( $line ) . "\n"; + } + } return $r; } - function _context( $lines, $encode = true ) { + /** + * @ignore + * @access public + * + * @param array $lines + * @param bool $encode + * @return string + */ + public function _context( $lines, $encode = true ) { $r = ''; foreach ($lines as $line) { - if ( $encode ) - $line = htmlspecialchars( $line ); - $r .= '' . - $this->contextLine( $line ) . $this->contextLine( $line ) . "\n"; + if ( $encode ) { + $processed_line = htmlspecialchars( $line ); + + /** This filter is documented in wp-includes/wp-diff.php */ + $line = apply_filters( 'process_text_diff_html', $processed_line, $line, 'unchanged' ); + } + if ( $this->_show_split_view ) { + $r .= '' . $this->contextLine( $line ) . $this->emptyLine() . $this->contextLine( $line ) . "\n"; + } else { + $r .= '' . $this->contextLine( $line ) . "\n"; + } } return $r; } - // Process changed lines to do word-by-word diffs for extra highlighting (TRAC style) - // sometimes these lines can actually be deleted or added rows - we do additional processing - // to figure that out - function _changed( $orig, $final ) { + /** + * Process changed lines to do word-by-word diffs for extra highlighting. + * + * (TRAC style) sometimes these lines can actually be deleted or added rows. + * We do additional processing to figure that out + * + * @access public + * @since 2.6.0 + * + * @param array $orig + * @param array $final + * @return string + */ + public function _changed( $orig, $final ) { $r = ''; // Does the aforementioned additional processing - // *_matches tell what rows are "the same" in orig and final. Those pairs will be diffed to get word changes + // *_matches tell what rows are "the same" in orig and final. Those pairs will be diffed to get word changes // match is numeric: an index in other column - // match is 'X': no match. It is a new row + // match is 'X': no match. It is a new row // *_rows are column vectors for the orig column and the final column. // row >= 0: an indix of the $orig or $final array // row < 0: a blank row for that column list($orig_matches, $final_matches, $orig_rows, $final_rows) = $this->interleave_changed_lines( $orig, $final ); - // These will hold the word changes as determined by an inline diff $orig_diffs = array(); $final_diffs = array(); @@ -109,7 +273,7 @@ class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer { $diff = $renderer->render( $text_diff ); // If they're too different, don't include any or - if ( $diff_count = preg_match_all( '!(.*?|.*?)!', $diff, $diff_matches ) ) { + if ( preg_match_all( '!(.*?|.*?)!', $diff, $diff_matches ) ) { // length of all text between or $stripped_matches = strlen(strip_tags( join(' ', $diff_matches[0]) )); // since we count lengith of text between or (instead of picking just one), @@ -117,7 +281,7 @@ class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer { $stripped_diff = strlen(strip_tags( $diff )) * 2 - $stripped_matches; $diff_ratio = $stripped_matches / $stripped_diff; if ( $diff_ratio > $this->_diff_threshold ) - continue; // Too different. Don't save diffs. + continue; // Too different. Don't save diffs. } // Un-inline the diffs by removing del or ins @@ -127,37 +291,58 @@ class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer { } foreach ( array_keys($orig_rows) as $row ) { - // Both columns have blanks. Ignore them. + // Both columns have blanks. Ignore them. if ( $orig_rows[$row] < 0 && $final_rows[$row] < 0 ) continue; - // If we have a word based diff, use it. Otherwise, use the normal line. - $orig_line = isset($orig_diffs[$orig_rows[$row]]) - ? $orig_diffs[$orig_rows[$row]] - : htmlspecialchars($orig[$orig_rows[$row]]); - $final_line = isset($final_diffs[$final_rows[$row]]) - ? $final_diffs[$final_rows[$row]] - : htmlspecialchars($final[$final_rows[$row]]); - - if ( $orig_rows[$row] < 0 ) { // Orig is blank. This is really an added row. + // If we have a word based diff, use it. Otherwise, use the normal line. + if ( isset( $orig_diffs[$orig_rows[$row]] ) ) + $orig_line = $orig_diffs[$orig_rows[$row]]; + elseif ( isset( $orig[$orig_rows[$row]] ) ) + $orig_line = htmlspecialchars($orig[$orig_rows[$row]]); + else + $orig_line = ''; + + if ( isset( $final_diffs[$final_rows[$row]] ) ) + $final_line = $final_diffs[$final_rows[$row]]; + elseif ( isset( $final[$final_rows[$row]] ) ) + $final_line = htmlspecialchars($final[$final_rows[$row]]); + else + $final_line = ''; + + if ( $orig_rows[$row] < 0 ) { // Orig is blank. This is really an added row. $r .= $this->_added( array($final_line), false ); - } elseif ( $final_rows[$row] < 0 ) { // Final is blank. This is really a deleted row. + } elseif ( $final_rows[$row] < 0 ) { // Final is blank. This is really a deleted row. $r .= $this->_deleted( array($orig_line), false ); } else { // A true changed row. - $r .= '' . $this->deletedLine( $orig_line ) . $this->addedLine( $final_line ) . "\n"; + if ( $this->_show_split_view ) { + $r .= '' . $this->deletedLine( $orig_line ) . $this->emptyLine() . $this->addedLine( $final_line ) . "\n"; + } else { + $r .= '' . $this->deletedLine( $orig_line ) . "" . $this->addedLine( $final_line ) . "\n"; + } } } return $r; } - // Takes changed blocks and matches which rows in orig turned into which rows in final. - // Returns - // *_matches ( which rows match with which ) - // *_rows ( order of rows in each column interleaved with blank rows as necessary ) - function interleave_changed_lines( $orig, $final ) { - - // Contains all pairwise string comparisons. Keys are such that this need only be a one dimensional array. + /** + * Takes changed blocks and matches which rows in orig turned into which rows in final. + * + * Returns + * *_matches ( which rows match with which ) + * *_rows ( order of rows in each column interleaved with blank rows as + * necessary ) + * + * @since 2.6.0 + * + * @param array $orig + * @param array $final + * @return array + */ + public function interleave_changed_lines( $orig, $final ) { + + // Contains all pairwise string comparisons. Keys are such that this need only be a one dimensional array. $matches = array(); foreach ( array_keys($orig) as $o ) { foreach ( array_keys($final) as $f ) { @@ -178,7 +363,7 @@ class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer { if ( isset($orig_matches[$o]) && isset($final_matches[$f]) ) continue; - // First match for these guys. Must be best match + // First match for these guys. Must be best match if ( !isset($orig_matches[$o]) && !isset($final_matches[$f]) ) { $orig_matches[$o] = $f; $final_matches[$f] = $o; @@ -198,7 +383,6 @@ class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer { ksort($orig_matches); ksort($final_matches); - // Stores rows and blanks for each column. $orig_rows = $orig_rows_copy = array_keys($orig_matches); $final_rows = array_keys($final_matches); @@ -211,18 +395,17 @@ class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer { if ( false === $final_pos ) { // This orig is paired with a blank final. array_splice( $final_rows, $orig_pos, 0, -1 ); - } elseif ( $final_pos < $orig_pos ) { // This orig's match is up a ways. Pad final with blank rows. + } elseif ( $final_pos < $orig_pos ) { // This orig's match is up a ways. Pad final with blank rows. $diff_pos = $final_pos - $orig_pos; while ( $diff_pos < 0 ) array_splice( $final_rows, $orig_pos, 0, $diff_pos++ ); - } elseif ( $final_pos > $orig_pos ) { // This orig's match is down a ways. Pad orig with blank rows. + } elseif ( $final_pos > $orig_pos ) { // This orig's match is down a ways. Pad orig with blank rows. $diff_pos = $orig_pos - $final_pos; while ( $diff_pos < 0 ) array_splice( $orig_rows, $orig_pos, 0, $diff_pos++ ); } } - // Pad the ends with blank rows if the columns aren't the same length $diff_count = count($orig_rows) - count($final_rows); if ( $diff_count < 0 ) { @@ -235,78 +418,123 @@ class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer { } return array($orig_matches, $final_matches, $orig_rows, $final_rows); - -/* - // Debug - echo "\n\n\n\n\n"; - - echo "-- DEBUG Matches: Orig -> Final --"; - - foreach ( $orig_matches as $o => $f ) { - echo "\n\n\n\n\n"; - echo "ORIG: $o, FINAL: $f\n"; - var_dump($orig[$o],$final[$f]); - } - echo "\n\n\n\n\n"; - - echo "-- DEBUG Matches: Final -> Orig --"; - - foreach ( $final_matches as $f => $o ) { - echo "\n\n\n\n\n"; - echo "FINAL: $f, ORIG: $o\n"; - var_dump($final[$f],$orig[$o]); - } - echo "\n\n\n\n\n"; - - echo "-- DEBUG Rows: Orig -- Final --"; - - echo "\n\n\n\n\n"; - foreach ( $orig_rows as $row => $o ) { - if ( $o < 0 ) - $o = 'X'; - $f = $final_rows[$row]; - if ( $f < 0 ) - $f = 'X'; - echo "$o -- $f\n"; - } - echo "\n\n\n\n\n"; - - echo "-- END DEBUG --"; - - echo "\n\n\n\n\n"; - - return array($orig_matches, $final_matches, $orig_rows, $final_rows); -*/ } - - // Computes a number that is intended to reflect the "distance" between two strings. - function compute_string_distance( $string1, $string2 ) { + /** + * Computes a number that is intended to reflect the "distance" between two strings. + * + * @since 2.6.0 + * + * @param string $string1 + * @param string $string2 + * @return int + */ + public function compute_string_distance( $string1, $string2 ) { // Vectors containing character frequency for all chars in each string $chars1 = count_chars($string1); $chars2 = count_chars($string2); // L1-norm of difference vector. - $difference = array_sum( array_map( array(&$this, 'difference'), $chars1, $chars2 ) ); + $difference = array_sum( array_map( array($this, 'difference'), $chars1, $chars2 ) ); - // $string1 has zero length? Odd. Give huge penalty by not dividing. + // $string1 has zero length? Odd. Give huge penalty by not dividing. if ( !$string1 ) return $difference; - // Return distance per charcter (of string1) + // Return distance per character (of string1). return $difference / strlen($string1); } - function difference( $a, $b ) { + /** + * @ignore + * @since 2.6.0 + * + * @param int $a + * @param int $b + * @return int + */ + public function difference( $a, $b ) { return abs( $a - $b ); } + /** + * Make private properties readable for backward compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to get. + * @return mixed Property. + */ + public function __get( $name ) { + if ( in_array( $name, $this->compat_fields ) ) { + return $this->$name; + } + } + + /** + * Make private properties settable for backward compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to check if set. + * @param mixed $value Property value. + * @return mixed Newly-set property. + */ + public function __set( $name, $value ) { + if ( in_array( $name, $this->compat_fields ) ) { + return $this->$name = $value; + } + } + + /** + * Make private properties checkable for backward compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to check if set. + * @return bool Whether the property is set. + */ + public function __isset( $name ) { + if ( in_array( $name, $this->compat_fields ) ) { + return isset( $this->$name ); + } + } + + /** + * Make private properties un-settable for backward compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to unset. + */ + public function __unset( $name ) { + if ( in_array( $name, $this->compat_fields ) ) { + unset( $this->$name ); + } + } } -// Better word splitting than the PEAR package provides +/** + * Better word splitting than the PEAR package provides. + * + * @since 2.6.0 + * @uses Text_Diff_Renderer_inline Extends + */ class WP_Text_Diff_Renderer_inline extends Text_Diff_Renderer_inline { - function _splitOnWords($string, $newlineEscape = "\n") { + /** + * @ignore + * @since 2.6.0 + * + * @param string $string + * @param string $newlineEscape + * @return string + */ + public function _splitOnWords($string, $newlineEscape = "\n") { $string = str_replace("\0", '', $string); $words = preg_split( '/([^\w])/u', $string, -1, PREG_SPLIT_DELIM_CAPTURE ); $words = str_replace( "\n", $newlineEscape, $words ); @@ -314,5 +542,3 @@ class WP_Text_Diff_Renderer_inline extends Text_Diff_Renderer_inline { } } - -?>