Replace markdown-style [1] link indexes in plain text email bodies. [1]: ht...

Thomas Bruederli

2013-10-10 e480ca00ba507ea1575bad7ffb824d8d72b666d4

Replace markdown-style [1] link indexes in plain text email bodies. [1]: http://daringfireball.net/projects/markdown/

 CHANGELOG

@@ -1,6 +1,7 @@
CHANGELOG Roundcube Webmail
===========================

- Replace markdown-style [1] link indexes in plain text email bodies
- Fixed issues where HTML comments inside style tag would hang Internet Explorer
- Improved mailto: link arguments handling (#1489363)
- Use DOMDocument LIBXML_PARSEHUGE and LIBXML_COMPACT options if possible (#1489302)

 program/lib/Roundcube/rcube_string_replacer.php

@@ -24,11 +24,14 @@
 */
class rcube_string_replacer
{
    public static $pattern = '/##str_replacement\[([0-9]+)\]##/';
    public static $pattern = '/##str_replacement\{([0-9]+)\}##/';
    public $mailto_pattern;
    public $link_pattern;

    private $values = array();
    private $options = array();
    private $linkrefs = array();
    private $urls = array();


    function __construct($options = array())
@@ -45,6 +48,8 @@
            ."@$utf_domain"                                                 // domain-part
            ."(\?[$url1$url2]+)?"                                           // e.g. ?subject=test...
            .")/";
        $this->linkref_index = '/\[([a-zA-Z0-9]+)\]:?\s*##str_replacement\{(\d+)\}##/';
        $this->linkref_pattern = '/\[([a-zA-Z0-9]+)\]/';

        $this->options = $options;
    }
@@ -67,7 +72,7 @@
     */
    public function get_replacement($i)
    {
        return '##str_replacement['.$i.']##';
        return '##str_replacement{'.$i.'}##';
    }

    /**
@@ -96,11 +101,39 @@
            $attrib['href'] = $url_prefix . $url;

            $i = $this->add(html::a($attrib, rcube::Q($url)) . $suffix);
            $this->urls[$i] = $attrib['href'];
        }

        // Return valid link for recognized schemes, otherwise
        // return the unmodified string for unrecognized schemes.
        return $i >= 0 ? $prefix . $this->get_replacement($i) : $matches[0];
    }

    /**
     * Callback to add an entry to the link index
     */
    public function linkref_addindex($matches)
    {
        $key = $matches[1];
        $this->linkrefs[$key] = $matches[2];

        return $matches[0];
    }

    /**
     * Callback to replace link references with real links
     */
    public function linkref_callback($matches)
    {
        $i = 0;
        $key = isset($this->linkrefs[$matches[1]]) ? $this->linkrefs[$matches[1]] : '-';
        if ($url = $this->urls[$key]) {
            $attrib = (array)$this->options['link_attribs'];
            $attrib['href'] = $url;
            $i = $this->add(html::a($attrib, rcube::Q($matches[1])));
        }

        return $i > 0 ? '['.$this->get_replacement($i).']' : $matches[0];
    }

    /**
@@ -142,6 +175,9 @@
        // search for patterns like links and e-mail addresses
        $str = preg_replace_callback($this->link_pattern, array($this, 'link_callback'), $str);
        $str = preg_replace_callback($this->mailto_pattern, array($this, 'mailto_callback'), $str);
        // resolve link references
        $str = preg_replace_callback($this->linkref_index, array($this, 'linkref_addindex'), $str);
        $str = preg_replace_callback($this->linkref_pattern, array($this, 'linkref_callback'), $str);

        return $str;
    }

 tests/Framework/StringReplacer.php

@@ -56,4 +56,20 @@

        $this->assertEquals($output, $result);
    }

    function test_linkrefs()
    {
        $input = "This is a sample message [1] to test the new linkref [ref0] replacement feature of [Roundcube].\n";
        $input.= "\n";
        $input.= "[1] http://en.wikipedia.org/wiki/Email\n";
        $input.= "[ref0] www.link-ref.com\n";

        $replacer = new rcube_string_replacer;
        $result = $replacer->replace($input);
        $result = $replacer->resolve($result);

        $this->assertContains('[<a href="http://en.wikipedia.org/wiki/Email">1</a>] to', $result, "Numeric linkref replacements");
        $this->assertContains('[<a href="http://www.link-ref.com">ref0</a>] repl', $result, "Alphanum linkref replacements");
        $this->assertContains('of [Roundcube].', $result, "Don't touch strings wihtout an index entry");
    }
}