web/wp-includes/Text/Diff/Renderer/inline.php
author ymh
Fri, 12 Mar 2010 13:29:04 +0000
changeset 1 0d28b7c10758
permissions -rw-r--r--
First commit
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1
0d28b7c10758 First commit
ymh
parents:
diff changeset
     1
<?php
0d28b7c10758 First commit
ymh
parents:
diff changeset
     2
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
     3
 * "Inline" diff renderer.
0d28b7c10758 First commit
ymh
parents:
diff changeset
     4
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
     5
 * $Horde: framework/Text_Diff/Diff/Renderer/inline.php,v 1.21 2008/01/04 10:07:51 jan Exp $
0d28b7c10758 First commit
ymh
parents:
diff changeset
     6
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
     7
 * Copyright 2004-2008 The Horde Project (http://www.horde.org/)
0d28b7c10758 First commit
ymh
parents:
diff changeset
     8
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
     9
 * See the enclosed file COPYING for license information (LGPL). If you did
0d28b7c10758 First commit
ymh
parents:
diff changeset
    10
 * not receive this file, see http://opensource.org/licenses/lgpl-license.php.
0d28b7c10758 First commit
ymh
parents:
diff changeset
    11
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
    12
 * @author  Ciprian Popovici
0d28b7c10758 First commit
ymh
parents:
diff changeset
    13
 * @package Text_Diff
0d28b7c10758 First commit
ymh
parents:
diff changeset
    14
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    15
0d28b7c10758 First commit
ymh
parents:
diff changeset
    16
/** Text_Diff_Renderer */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    17
0d28b7c10758 First commit
ymh
parents:
diff changeset
    18
// WP #7391
0d28b7c10758 First commit
ymh
parents:
diff changeset
    19
require_once dirname(dirname(__FILE__)) . '/Renderer.php';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    20
0d28b7c10758 First commit
ymh
parents:
diff changeset
    21
/**
0d28b7c10758 First commit
ymh
parents:
diff changeset
    22
 * "Inline" diff renderer.
0d28b7c10758 First commit
ymh
parents:
diff changeset
    23
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
    24
 * This class renders diffs in the Wiki-style "inline" format.
0d28b7c10758 First commit
ymh
parents:
diff changeset
    25
 *
0d28b7c10758 First commit
ymh
parents:
diff changeset
    26
 * @author  Ciprian Popovici
0d28b7c10758 First commit
ymh
parents:
diff changeset
    27
 * @package Text_Diff
0d28b7c10758 First commit
ymh
parents:
diff changeset
    28
 */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    29
class Text_Diff_Renderer_inline extends Text_Diff_Renderer {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    30
0d28b7c10758 First commit
ymh
parents:
diff changeset
    31
    /**
0d28b7c10758 First commit
ymh
parents:
diff changeset
    32
     * Number of leading context "lines" to preserve.
0d28b7c10758 First commit
ymh
parents:
diff changeset
    33
     */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    34
    var $_leading_context_lines = 10000;
0d28b7c10758 First commit
ymh
parents:
diff changeset
    35
0d28b7c10758 First commit
ymh
parents:
diff changeset
    36
    /**
0d28b7c10758 First commit
ymh
parents:
diff changeset
    37
     * Number of trailing context "lines" to preserve.
0d28b7c10758 First commit
ymh
parents:
diff changeset
    38
     */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    39
    var $_trailing_context_lines = 10000;
0d28b7c10758 First commit
ymh
parents:
diff changeset
    40
0d28b7c10758 First commit
ymh
parents:
diff changeset
    41
    /**
0d28b7c10758 First commit
ymh
parents:
diff changeset
    42
     * Prefix for inserted text.
0d28b7c10758 First commit
ymh
parents:
diff changeset
    43
     */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    44
    var $_ins_prefix = '<ins>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    45
0d28b7c10758 First commit
ymh
parents:
diff changeset
    46
    /**
0d28b7c10758 First commit
ymh
parents:
diff changeset
    47
     * Suffix for inserted text.
0d28b7c10758 First commit
ymh
parents:
diff changeset
    48
     */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    49
    var $_ins_suffix = '</ins>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    50
0d28b7c10758 First commit
ymh
parents:
diff changeset
    51
    /**
0d28b7c10758 First commit
ymh
parents:
diff changeset
    52
     * Prefix for deleted text.
0d28b7c10758 First commit
ymh
parents:
diff changeset
    53
     */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    54
    var $_del_prefix = '<del>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    55
0d28b7c10758 First commit
ymh
parents:
diff changeset
    56
    /**
0d28b7c10758 First commit
ymh
parents:
diff changeset
    57
     * Suffix for deleted text.
0d28b7c10758 First commit
ymh
parents:
diff changeset
    58
     */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    59
    var $_del_suffix = '</del>';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    60
0d28b7c10758 First commit
ymh
parents:
diff changeset
    61
    /**
0d28b7c10758 First commit
ymh
parents:
diff changeset
    62
     * Header for each change block.
0d28b7c10758 First commit
ymh
parents:
diff changeset
    63
     */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    64
    var $_block_header = '';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    65
0d28b7c10758 First commit
ymh
parents:
diff changeset
    66
    /**
0d28b7c10758 First commit
ymh
parents:
diff changeset
    67
     * What are we currently splitting on? Used to recurse to show word-level
0d28b7c10758 First commit
ymh
parents:
diff changeset
    68
     * changes.
0d28b7c10758 First commit
ymh
parents:
diff changeset
    69
     */
0d28b7c10758 First commit
ymh
parents:
diff changeset
    70
    var $_split_level = 'lines';
0d28b7c10758 First commit
ymh
parents:
diff changeset
    71
0d28b7c10758 First commit
ymh
parents:
diff changeset
    72
    function _blockHeader($xbeg, $xlen, $ybeg, $ylen)
0d28b7c10758 First commit
ymh
parents:
diff changeset
    73
    {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    74
        return $this->_block_header;
0d28b7c10758 First commit
ymh
parents:
diff changeset
    75
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    76
0d28b7c10758 First commit
ymh
parents:
diff changeset
    77
    function _startBlock($header)
0d28b7c10758 First commit
ymh
parents:
diff changeset
    78
    {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    79
        return $header;
0d28b7c10758 First commit
ymh
parents:
diff changeset
    80
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    81
0d28b7c10758 First commit
ymh
parents:
diff changeset
    82
    function _lines($lines, $prefix = ' ', $encode = true)
0d28b7c10758 First commit
ymh
parents:
diff changeset
    83
    {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    84
        if ($encode) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    85
            array_walk($lines, array(&$this, '_encode'));
0d28b7c10758 First commit
ymh
parents:
diff changeset
    86
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    87
0d28b7c10758 First commit
ymh
parents:
diff changeset
    88
        if ($this->_split_level == 'words') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    89
            return implode('', $lines);
0d28b7c10758 First commit
ymh
parents:
diff changeset
    90
        } else {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    91
            return implode("\n", $lines) . "\n";
0d28b7c10758 First commit
ymh
parents:
diff changeset
    92
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    93
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
    94
0d28b7c10758 First commit
ymh
parents:
diff changeset
    95
    function _added($lines)
0d28b7c10758 First commit
ymh
parents:
diff changeset
    96
    {
0d28b7c10758 First commit
ymh
parents:
diff changeset
    97
        array_walk($lines, array(&$this, '_encode'));
0d28b7c10758 First commit
ymh
parents:
diff changeset
    98
        $lines[0] = $this->_ins_prefix . $lines[0];
0d28b7c10758 First commit
ymh
parents:
diff changeset
    99
        $lines[count($lines) - 1] .= $this->_ins_suffix;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   100
        return $this->_lines($lines, ' ', false);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   101
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   102
0d28b7c10758 First commit
ymh
parents:
diff changeset
   103
    function _deleted($lines, $words = false)
0d28b7c10758 First commit
ymh
parents:
diff changeset
   104
    {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   105
        array_walk($lines, array(&$this, '_encode'));
0d28b7c10758 First commit
ymh
parents:
diff changeset
   106
        $lines[0] = $this->_del_prefix . $lines[0];
0d28b7c10758 First commit
ymh
parents:
diff changeset
   107
        $lines[count($lines) - 1] .= $this->_del_suffix;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   108
        return $this->_lines($lines, ' ', false);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   109
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   110
0d28b7c10758 First commit
ymh
parents:
diff changeset
   111
    function _changed($orig, $final)
0d28b7c10758 First commit
ymh
parents:
diff changeset
   112
    {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   113
        /* If we've already split on words, don't try to do so again - just
0d28b7c10758 First commit
ymh
parents:
diff changeset
   114
         * display. */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   115
        if ($this->_split_level == 'words') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   116
            $prefix = '';
0d28b7c10758 First commit
ymh
parents:
diff changeset
   117
            while ($orig[0] !== false && $final[0] !== false &&
0d28b7c10758 First commit
ymh
parents:
diff changeset
   118
                   substr($orig[0], 0, 1) == ' ' &&
0d28b7c10758 First commit
ymh
parents:
diff changeset
   119
                   substr($final[0], 0, 1) == ' ') {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   120
                $prefix .= substr($orig[0], 0, 1);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   121
                $orig[0] = substr($orig[0], 1);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   122
                $final[0] = substr($final[0], 1);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   123
            }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   124
            return $prefix . $this->_deleted($orig) . $this->_added($final);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   125
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   126
0d28b7c10758 First commit
ymh
parents:
diff changeset
   127
        $text1 = implode("\n", $orig);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   128
        $text2 = implode("\n", $final);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   129
0d28b7c10758 First commit
ymh
parents:
diff changeset
   130
        /* Non-printing newline marker. */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   131
        $nl = "\0";
0d28b7c10758 First commit
ymh
parents:
diff changeset
   132
0d28b7c10758 First commit
ymh
parents:
diff changeset
   133
        /* We want to split on word boundaries, but we need to
0d28b7c10758 First commit
ymh
parents:
diff changeset
   134
         * preserve whitespace as well. Therefore we split on words,
0d28b7c10758 First commit
ymh
parents:
diff changeset
   135
         * but include all blocks of whitespace in the wordlist. */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   136
        $diff = new Text_Diff($this->_splitOnWords($text1, $nl),
0d28b7c10758 First commit
ymh
parents:
diff changeset
   137
                              $this->_splitOnWords($text2, $nl));
0d28b7c10758 First commit
ymh
parents:
diff changeset
   138
0d28b7c10758 First commit
ymh
parents:
diff changeset
   139
        /* Get the diff in inline format. */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   140
        $renderer = new Text_Diff_Renderer_inline(array_merge($this->getParams(),
0d28b7c10758 First commit
ymh
parents:
diff changeset
   141
                                                              array('split_level' => 'words')));
0d28b7c10758 First commit
ymh
parents:
diff changeset
   142
0d28b7c10758 First commit
ymh
parents:
diff changeset
   143
        /* Run the diff and get the output. */
0d28b7c10758 First commit
ymh
parents:
diff changeset
   144
        return str_replace($nl, "\n", $renderer->render($diff)) . "\n";
0d28b7c10758 First commit
ymh
parents:
diff changeset
   145
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   146
0d28b7c10758 First commit
ymh
parents:
diff changeset
   147
    function _splitOnWords($string, $newlineEscape = "\n")
0d28b7c10758 First commit
ymh
parents:
diff changeset
   148
    {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   149
        // Ignore \0; otherwise the while loop will never finish.
0d28b7c10758 First commit
ymh
parents:
diff changeset
   150
        $string = str_replace("\0", '', $string);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   151
0d28b7c10758 First commit
ymh
parents:
diff changeset
   152
        $words = array();
0d28b7c10758 First commit
ymh
parents:
diff changeset
   153
        $length = strlen($string);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   154
        $pos = 0;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   155
0d28b7c10758 First commit
ymh
parents:
diff changeset
   156
        while ($pos < $length) {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   157
            // Eat a word with any preceding whitespace.
0d28b7c10758 First commit
ymh
parents:
diff changeset
   158
            $spaces = strspn(substr($string, $pos), " \n");
0d28b7c10758 First commit
ymh
parents:
diff changeset
   159
            $nextpos = strcspn(substr($string, $pos + $spaces), " \n");
0d28b7c10758 First commit
ymh
parents:
diff changeset
   160
            $words[] = str_replace("\n", $newlineEscape, substr($string, $pos, $spaces + $nextpos));
0d28b7c10758 First commit
ymh
parents:
diff changeset
   161
            $pos += $spaces + $nextpos;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   162
        }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   163
0d28b7c10758 First commit
ymh
parents:
diff changeset
   164
        return $words;
0d28b7c10758 First commit
ymh
parents:
diff changeset
   165
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   166
0d28b7c10758 First commit
ymh
parents:
diff changeset
   167
    function _encode(&$string)
0d28b7c10758 First commit
ymh
parents:
diff changeset
   168
    {
0d28b7c10758 First commit
ymh
parents:
diff changeset
   169
        $string = htmlspecialchars($string);
0d28b7c10758 First commit
ymh
parents:
diff changeset
   170
    }
0d28b7c10758 First commit
ymh
parents:
diff changeset
   171
0d28b7c10758 First commit
ymh
parents:
diff changeset
   172
}