MDL-24542 New filter urltolink, replacing core convert_urls_into_links() function
authorDavid Mudrak <david.mudrak@gmail.com>
Thu, 7 Oct 2010 09:01:15 +0000 (09:01 +0000)
committerDavid Mudrak <david.mudrak@gmail.com>
Thu, 7 Oct 2010 09:01:15 +0000 (09:01 +0000)
filter/urltolink/filter.php [new file with mode: 0644]
filter/urltolink/filtersettings.php [new file with mode: 0644]
filter/urltolink/lang/en/filter_urltolink.php [new file with mode: 0644]
filter/urltolink/simpletest/sample.txt [new file with mode: 0644]
filter/urltolink/simpletest/testfilter.php [new file with mode: 0644]
filter/urltolink/version.php [new file with mode: 0644]

diff --git a/filter/urltolink/filter.php b/filter/urltolink/filter.php
new file mode 100644 (file)
index 0000000..f1ed7ae
--- /dev/null
@@ -0,0 +1,141 @@
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Filter converting URLs in the text to HTML links
+ *
+ * @package    filter
+ * @subpackage urltolink
+ * @copyright  2010 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+class filter_urltolink extends moodle_text_filter {
+
+    /**
+     * @var array global configuration for this filter
+     *
+     * This might be eventually moved into parent class if we found it
+     * useful for other filters, too.
+     */
+    protected static $globalconfig;
+
+    /**
+     * Apply the filter to the text
+     *
+     * @see filter_manager::apply_filter_chain()
+     * @param string $text to be processed by the text
+     * @param array $options filter options
+     * @return string text after processing
+     */
+    public function filter($text, array $options = array()) {
+        if (!isset($options['originalformat'])) {
+            debugging('filter_urltolink requires originalformat option to be provided', DEBUG_DEVELOPER);
+            return $text;
+        }
+        if (in_array($options['originalformat'], explode(',', $this->get_global_config('formats')))) {
+            $this->convert_urls_into_links($text);
+        }
+        return $text;
+    }
+
+    ////////////////////////////////////////////////////////////////////////////
+    // internal implementation starts here
+    ////////////////////////////////////////////////////////////////////////////
+
+    /**
+     * Returns the global filter setting
+     *
+     * If the $name is provided, returns single value. Otherwise returns all
+     * global settings in object. Returns null if the named setting is not
+     * found.
+     *
+     * @param mixed $name optional config variable name, defaults to null for all
+     * @return string|object|null
+     */
+    protected function get_global_config($name=null) {
+        $this->load_global_config();
+        if (is_null($name)) {
+            return self::$globalconfig;
+
+        } elseif (array_key_exists($name, self::$globalconfig)) {
+            return self::$globalconfig->{$name};
+
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Makes sure that the global config is loaded in $this->globalconfig
+     *
+     * @return void
+     */
+    protected function load_global_config() {
+        if (is_null(self::$globalconfig)) {
+            self::$globalconfig = get_config('filter_urltolink');
+        }
+    }
+
+    /**
+     * Given some text this function converts any URLs it finds into HTML links
+     *
+     * @param string $text Passed in by reference. The string to be searched for urls.
+     */
+    protected function convert_urls_into_links(&$text) {
+        //I've added img tags to this list of tags to ignore.
+        //See MDL-21168 for more info. A better way to ignore tags whether or not
+        //they are escaped partially or completely would be desirable. For example:
+        //<a href="blah">
+        //&lt;a href="blah"&gt;
+        //&lt;a href="blah">
+        $filterignoretagsopen  = array('<a\s[^>]+?>');
+        $filterignoretagsclose = array('</a>');
+        filter_save_ignore_tags($text,$filterignoretagsopen,$filterignoretagsclose,$ignoretags);
+
+        // Check if we support unicode modifiers in regular expressions. Cache it.
+        // TODO: this check should be a environment requirement in Moodle 2.0, as far as unicode
+        // chars are going to arrive to URLs officially really soon (2010?)
+        // Original RFC regex from: http://www.bytemycode.com/snippets/snippet/796/
+        // Various ideas from: http://alanstorm.com/url_regex_explained
+        // Unicode check, negative assertion and other bits from Moodle.
+        static $unicoderegexp;
+        if (!isset($unicoderegexp)) {
+            $unicoderegexp = @preg_match('/\pL/u', 'a'); // This will fail silently, returning false,
+        }
+
+        //todo: MDL-21296 - use of unicode modifiers may cause a timeout
+        if ($unicoderegexp) { //We can use unicode modifiers
+            $text = preg_replace('#(?<!=["\'])(((http(s?))://)(((([\pLl0-9]([\pLl0-9]|-)*[\pLl0-9]|[\pLl0-9])\.)+([\pLl]([\pLl0-9]|-)*[\pLl0-9]|[\pLl]))|(([0-9]{1,3}\.){3}[0-9]{1,3}))(:[\pL0-9]*)?(/([\pLl0-9\.!$&\'\(\)*+,;=_~:@-]|%[a-fA-F0-9]{2})*)*(\?([\pLl0-9\.!$&\'\(\)*+,;=_~:@/?-]|%[a-fA-F0-9]{2})*)?(\#[\pLl0-9\.!$&\'\(\)*+,;=_~:@/?-]*)?)(?<![,.;])#iu',
+                                 '<a href="\\1" class="_blanktarget">\\1</a>', $text);
+            $text = preg_replace('#(?<!=["\']|//)((www\.([\pLl0-9]([\pLl0-9]|-)*[\pLl0-9]|[\pLl0-9])\.)+([\pLl]([\pLl0-9]|-)*[\pLl0-9]|[\pLl])(:[\pL0-9]*)?(/([\pLl0-9\.!$&\'\(\)*+,;=_~:@-]|%[a-fA-F0-9]{2})*)*(\?([\pLl0-9\.!$&\'\(\)*+,;=_~:@/?-]|%[a-fA-F0-9]{2})*)?(\#[\pLl0-9\.!$&\'\(\)*+,;=_~:@/?-]*)?)(?<![,.;])#iu',
+                                 '<a href="http://\\1" class="_blanktarget">\\1</a>', $text);
+        } else { //We cannot use unicode modifiers
+            $text = preg_replace('#(?<!=["\'])(((http(s?))://)(((([a-z0-9]([a-z0-9]|-)*[a-z0-9]|[a-z0-9])\.)+([a-z]([a-z0-9]|-)*[a-z0-9]|[a-z]))|(([0-9]{1,3}\.){3}[0-9]{1,3}))(:[a-zA-Z0-9]*)?(/([a-z0-9\.!$&\'\(\)*+,;=_~:@-]|%[a-f0-9]{2})*)*(\?([a-z0-9\.!$&\'\(\)*+,;=_~:@/?-]|%[a-fA-F0-9]{2})*)?(\#[a-z0-9\.!$&\'\(\)*+,;=_~:@/?-]*)?)(?<![,.;])#i',
+                                 '<a href="\\1" class="_blanktarget">\\1</a>', $text);
+            $text = preg_replace('#(?<!=["\']|//)((www\.([a-z0-9]([a-z0-9]|-)*[a-z0-9]|[a-z0-9])\.)+([a-z]([a-z0-9]|-)*[a-z0-9]|[a-z])(:[a-zA-Z0-9]*)?(/([a-z0-9\.!$&\'\(\)*+,;=_~:@-]|%[a-f0-9]{2})*)*(\?([a-z0-9\.!$&\'\(\)*+,;=_~:@/?-]|%[a-fA-F0-9]{2})*)?(\#[a-z0-9\.!$&\'\(\)*+,;=_~:@/?-]*)?)(?<![,.;])#i',
+                                 '<a href="http://\\1" class="_blanktarget">\\1</a>', $text);
+        }
+
+        if (!empty($ignoretags)) {
+            $ignoretags = array_reverse($ignoretags); /// Reversed so "progressive" str_replace() will solve some nesting problems.
+            $text = str_replace(array_keys($ignoretags),$ignoretags,$text);
+        }
+    }
+}
diff --git a/filter/urltolink/filtersettings.php b/filter/urltolink/filtersettings.php
new file mode 100644 (file)
index 0000000..1fa15aa
--- /dev/null
@@ -0,0 +1,33 @@
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * @package    plugintype
+ * @subpackage pluginname
+ * @copyright  2010 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+if ($ADMIN->fulltree) {
+
+    $settings->add(new admin_setting_configmulticheckbox('filter_urltolink/formats',
+            get_string('settingformats', 'filter_urltolink'),
+            get_string('settingformats_desc', 'filter_urltolink'),
+            array(FORMAT_MOODLE => 1), format_text_menu()));
+}
diff --git a/filter/urltolink/lang/en/filter_urltolink.php b/filter/urltolink/lang/en/filter_urltolink.php
new file mode 100644 (file)
index 0000000..c51afbf
--- /dev/null
@@ -0,0 +1,31 @@
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Strings for filter_urltolink
+ *
+ * @package    filter
+ * @subpackage urltolink
+ * @copyright  2010 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$string['filtername'] = 'Convert URLs into links';
+$string['settingformats'] = 'Apply to formats';
+$string['settingformats_desc'] = 'The filter will be applied only if the original text was inserted in one of the selected formats.';
diff --git a/filter/urltolink/simpletest/sample.txt b/filter/urltolink/simpletest/sample.txt
new file mode 100644 (file)
index 0000000..23a45fe
--- /dev/null
@@ -0,0 +1,16 @@
+http://www.lipsum.com
+Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
+Why do we use it?<a href="dummylink.htm">dummy</a>
+
+It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).
+
+Where does it come from?
+
+Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32.
+
+The standard chunk of Lorem Ipsum used since the 1500s is reproduced below for those interested. Sections 1.10.32 and 1.10.33 from "de Finibus Bonorum et Malorum" by Cicero are also reproduced in their exact original form, accompanied by English versions from the 1914 translation by H. Rackham.
+Where can I get some?
+
+There are many variations of passages of Lorem Ipsum available, but the majority have suffered alteration in some form, by injected humour, or randomised words which don't look even slightly believable. If you are going to use a passage of Lorem Ipsum, you need to be sure there isn't anything embarrassing hidden in the middle of text. All the Lorem Ipsum generators on the Internet tend to repeat predefined chunks as necessary, making this the first true generator on the Internet. It uses a dictionary of over 200 Latin words, combined with a handful of model sentence structures, to generate Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore always free from repetition, injected humour, or non-characteristic words etc.
+<a href="http://en.wikipedia.org/wiki/Lorem_ipsum">Wikipedia</a>
+http://www.lorem-ipsum.info/
diff --git a/filter/urltolink/simpletest/testfilter.php b/filter/urltolink/simpletest/testfilter.php
new file mode 100644 (file)
index 0000000..2310378
--- /dev/null
@@ -0,0 +1,201 @@
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Unit test for the filter_urltolink
+ *
+ * @package    filter
+ * @subpackage urltolink
+ * @copyright  2010 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->dirroot . '/filter/urltolink/filter.php'); // Include the code to test
+
+/**
+ * Test subclass that makes all the protected methods we want to test public.
+ */
+class testable_filter_urltolink extends filter_urltolink {
+    public function __construct() {
+    }
+    public function convert_urls_into_links(&$text) {
+        parent::convert_urls_into_links($text);
+    }
+}
+
+/**
+ * Test cases for filter_urltolink class
+ */
+class filter_urltolink_test extends UnitTestCase {
+
+    /**
+     * Helper function that represents the legacy implementation
+     * of convert_urls_into_links()
+     */
+    protected function old_convert_urls_into_links(&$text) {
+        /// Make lone URLs into links.   eg http://moodle.com/
+        $text = preg_replace("%([[:space:]]|^|\(|\[)([[:alnum:]]+)://([^[:space:]]*)([[:alnum:]#?/&=])%i",
+                          '$1<a href="$2://$3$4" target="_blank">$2://$3$4</a>', $text);
+        /// eg www.moodle.com
+        $text = preg_replace("%([[:space:]]|^|\(|\[)www\.([^[:space:]]*)([[:alnum:]#?/&=])%i",
+                          '$1<a href="http://www.$2$3" target="_blank">www.$2$3</a>', $text);
+    }
+
+    function test_convert_urls_into_links() {
+        $texts = array (
+                //just a url
+                'http://moodle.org - URL' => '<a href="http://moodle.org" class="_blanktarget">http://moodle.org</a> - URL',
+                'www.moodle.org - URL' => '<a href="http://www.moodle.org" class="_blanktarget">www.moodle.org</a> - URL',
+                //url with params
+                'URL: http://moodle.org/s/i=1&j=2' => 'URL: <a href="http://moodle.org/s/i=1&j=2" class="_blanktarget">http://moodle.org/s/i=1&j=2</a>',
+                //url with escaped params
+                'URL: www.moodle.org/s/i=1&amp;j=2' => 'URL: <a href="http://www.moodle.org/s/i=1&amp;j=2" class="_blanktarget">www.moodle.org/s/i=1&amp;j=2</a>',
+                //https url with params
+                'URL: https://moodle.org/s/i=1&j=2' => 'URL: <a href="https://moodle.org/s/i=1&j=2" class="_blanktarget">https://moodle.org/s/i=1&j=2</a>',
+                //url with port and params
+                'URL: http://moodle.org:8080/s/i=1' => 'URL: <a href="http://moodle.org:8080/s/i=1" class="_blanktarget">http://moodle.org:8080/s/i=1</a>',
+                //url in brackets
+                '(http://moodle.org) - URL' => '(<a href="http://moodle.org" class="_blanktarget">http://moodle.org</a>) - URL',
+                '(www.moodle.org) - URL' => '(<a href="http://www.moodle.org" class="_blanktarget">www.moodle.org</a>) - URL',
+                //url in square brackets
+                '[http://moodle.org] - URL' => '[<a href="http://moodle.org" class="_blanktarget">http://moodle.org</a>] - URL',
+                '[www.moodle.org] - URL' => '[<a href="http://www.moodle.org" class="_blanktarget">www.moodle.org</a>] - URL',
+                //url in brackets with anchor
+                '[http://moodle.org/main#anchor] - URL' => '[<a href="http://moodle.org/main#anchor" class="_blanktarget">http://moodle.org/main#anchor</a>] - URL',
+                '[www.moodle.org/main#anchor] - URL' => '[<a href="http://www.moodle.org/main#anchor" class="_blanktarget">www.moodle.org/main#anchor</a>] - URL',
+                //brackets within the url
+                'URL: http://cc.org/url_(withpar)_go/?i=2' => 'URL: <a href="http://cc.org/url_(withpar)_go/?i=2" class="_blanktarget">http://cc.org/url_(withpar)_go/?i=2</a>',
+                'URL: www.cc.org/url_(withpar)_go/?i=2' => 'URL: <a href="http://www.cc.org/url_(withpar)_go/?i=2" class="_blanktarget">www.cc.org/url_(withpar)_go/?i=2</a>',
+                'URL: http://cc.org/url_(with)_(par)_go/?i=2' => 'URL: <a href="http://cc.org/url_(with)_(par)_go/?i=2" class="_blanktarget">http://cc.org/url_(with)_(par)_go/?i=2</a>',
+                'URL: www.cc.org/url_(with)_(par)_go/?i=2' => 'URL: <a href="http://www.cc.org/url_(with)_(par)_go/?i=2" class="_blanktarget">www.cc.org/url_(with)_(par)_go/?i=2</a>',
+                'http://en.wikipedia.org/wiki/Slash_(punctuation)'=>'<a href="http://en.wikipedia.org/wiki/Slash_(punctuation)" class="_blanktarget">http://en.wikipedia.org/wiki/Slash_(punctuation)</a>',
+                'http://en.wikipedia.org/wiki/%28#Parentheses_.28_.29 - URL' => '<a href="http://en.wikipedia.org/wiki/%28#Parentheses_.28_.29" class="_blanktarget">http://en.wikipedia.org/wiki/%28#Parentheses_.28_.29</a> - URL',
+                'http://en.wikipedia.org/wiki/(#Parentheses_.28_.29 - URL' => '<a href="http://en.wikipedia.org/wiki/(#Parentheses_.28_.29" class="_blanktarget">http://en.wikipedia.org/wiki/(#Parentheses_.28_.29</a> - URL',
+                //escaped brackets in url
+                'http://en.wikipedia.org/wiki/Slash_%28punctuation%29'=>'<a href="http://en.wikipedia.org/wiki/Slash_%28punctuation%29" class="_blanktarget">http://en.wikipedia.org/wiki/Slash_%28punctuation%29</a>',
+                //anchor tag
+                'URL: <a href="http://moodle.org">http://moodle.org</a>' => 'URL: <a href="http://moodle.org">http://moodle.org</a>',
+                'URL: <a href="http://moodle.org">www.moodle.org</a>' => 'URL: <a href="http://moodle.org">www.moodle.org</a>',
+                'URL: <a href="http://moodle.org"> http://moodle.org</a>' => 'URL: <a href="http://moodle.org"> http://moodle.org</a>',
+                'URL: <a href="http://moodle.org"> www.moodle.org</a>' => 'URL: <a href="http://moodle.org"> www.moodle.org</a>',
+                //escaped anchor tag. Commented out as part of MDL-21183
+                //htmlspecialchars('escaped anchor tag <a href="http://moodle.org">www.moodle.org</a>') => 'escaped anchor tag &lt;a href="http://moodle.org"&gt; www.moodle.org&lt;/a&gt;',
+                //trailing fullstop
+                'URL: http://moodle.org/s/i=1&j=2.' => 'URL: <a href="http://moodle.org/s/i=1&j=2" class="_blanktarget">http://moodle.org/s/i=1&j=2</a>.',
+                'URL: www.moodle.org/s/i=1&amp;j=2.' => 'URL: <a href="http://www.moodle.org/s/i=1&amp;j=2" class="_blanktarget">www.moodle.org/s/i=1&amp;j=2</a>.',
+                //trailing unmatched bracket
+                'URL: http://moodle.org)<br />' => 'URL: <a href="http://moodle.org" class="_blanktarget">http://moodle.org</a>)<br />',
+                //partially escaped html
+                'URL: <p>text www.moodle.org&lt;/p> text' => 'URL: <p>text <a href="http://www.moodle.org" class="_blanktarget">www.moodle.org</a>&lt;/p> text',
+                //decimal url parameter
+                'URL: www.moodle.org?u=1.23' => 'URL: <a href="http://www.moodle.org?u=1.23" class="_blanktarget">www.moodle.org?u=1.23</a>',
+                //escaped space in url
+                'URL: www.moodle.org?u=test+param&' => 'URL: <a href="http://www.moodle.org?u=test+param&" class="_blanktarget">www.moodle.org?u=test+param&</a>',
+                //odd characters in url param
+                'URL: www.moodle.org?param=:)' => 'URL: <a href="http://www.moodle.org?param=:)" class="_blanktarget">www.moodle.org?param=:)</a>',
+                //multiple urls
+                'URL: http://moodle.org www.moodle.org'
+                => 'URL: <a href="http://moodle.org" class="_blanktarget">http://moodle.org</a> <a href="http://www.moodle.org" class="_blanktarget">www.moodle.org</a>',
+                //containing anchor tags including a class parameter and a url to convert
+                'URL: <a href="http://moodle.org">http://moodle.org</a> www.moodle.org <a class="customclass" href="http://moodle.org">http://moodle.org</a>'
+                => 'URL: <a href="http://moodle.org">http://moodle.org</a> <a href="http://www.moodle.org" class="_blanktarget">www.moodle.org</a> <a class="customclass" href="http://moodle.org">http://moodle.org</a>',
+                //subdomain
+                'http://subdomain.moodle.org - URL' => '<a href="http://subdomain.moodle.org" class="_blanktarget">http://subdomain.moodle.org</a> - URL',
+                //multiple subdomains
+                'http://subdomain.subdomain.moodle.org - URL' => '<a href="http://subdomain.subdomain.moodle.org" class="_blanktarget">http://subdomain.subdomain.moodle.org</a> - URL',
+                //looks almost like a link but isnt
+                'This contains http, http:// and www but no actual links.'=>'This contains http, http:// and www but no actual links.',
+                //no link at all
+                'This is a story about moodle.coming to a cinema near you.'=>'This is a story about moodle.coming to a cinema near you.',
+                //URLs containing utf 8 characters
+                'http://Iñtërnâtiônàlizætiøn.com?ô=nëø'=>'<a href="http://Iñtërnâtiônàlizætiøn.com?ô=nëø" class="_blanktarget">http://Iñtërnâtiônàlizætiøn.com?ô=nëø</a>',
+                'www.Iñtërnâtiônàlizætiøn.com?ô=nëø'=>'<a href="http://www.Iñtërnâtiônàlizætiøn.com?ô=nëø" class="_blanktarget">www.Iñtërnâtiônàlizætiøn.com?ô=nëø</a>',
+                //text containing utf 8 characters outside of a url
+                'Iñtërnâtiônàlizætiøn is important to http://moodle.org'=>'Iñtërnâtiônàlizætiøn is important to <a href="http://moodle.org" class="_blanktarget">http://moodle.org</a>',
+                //too hard to identify without additional regexs
+                'moodle.org' => 'moodle.org',
+                //some text with no link between related html tags
+                '<b>no link here</b>' => '<b>no link here</b>',
+                //some text with a link between related html tags
+                '<b>a link here www.moodle.org</b>' => '<b>a link here <a href="http://www.moodle.org" class="_blanktarget">www.moodle.org</a></b>',
+                //some text containing a link within unrelated tags
+                '<br />This is some text. www.moodle.com then some more text<br />' => '<br />This is some text. <a href="http://www.moodle.com" class="_blanktarget">www.moodle.com</a> then some more text<br />',
+                //check we aren't modifying img tags
+                'image<img src="http://moodle.org/logo/logo-240x60.gif" />' => 'image<img src="http://moodle.org/logo/logo-240x60.gif" />',
+                'image<img src="www.moodle.org/logo/logo-240x60.gif" />' => 'image<img src="www.moodle.org/logo/logo-240x60.gif" />',
+                //and another url within one tag
+                '<td background="http://moodle.org">&nbsp;</td>' => '<td background="http://moodle.org">&nbsp;</td>',
+                '<td background="www.moodle.org">&nbsp;</td>' => '<td background="www.moodle.org">&nbsp;</td>',
+                '<form name="input" action="http://moodle.org/submit.asp" method="get">'=>'<form name="input" action="http://moodle.org/submit.asp" method="get">',
+                //partially escaped img tag
+                'partially escaped img tag &lt;img src="http://moodle.org/logo/logo-240x60.gif" />' => 'partially escaped img tag &lt;img src="http://moodle.org/logo/logo-240x60.gif" />',
+                //fully escaped img tag. Commented out as part of MDL-21183
+                //htmlspecialchars('fully escaped img tag <img src="http://moodle.org/logo/logo-240x60.gif" />') => 'fully escaped img tag &lt;img src="http://moodle.org/logo/logo-240x60.gif" /&gt;',
+                //Double http with www
+                'One more link like http://www.moodle.org to test' => 'One more link like <a href="http://www.moodle.org" class="_blanktarget">http://www.moodle.org</a> to test',
+                //Encoded URLs in the path
+                'URL: http://127.0.0.1/one%28parenthesis%29/path?param=value' => 'URL: <a href="http://127.0.0.1/one%28parenthesis%29/path?param=value" class="_blanktarget">http://127.0.0.1/one%28parenthesis%29/path?param=value</a>',
+                'URL: www.localhost.com/one%28parenthesis%29/path?param=value' => 'URL: <a href="http://www.localhost.com/one%28parenthesis%29/path?param=value" class="_blanktarget">www.localhost.com/one%28parenthesis%29/path?param=value</a>',
+                //Encoded URLs in the query
+                'URL: http://127.0.0.1/path/to?param=value_with%28parenthesis%29&param2=1' => 'URL: <a href="http://127.0.0.1/path/to?param=value_with%28parenthesis%29&param2=1" class="_blanktarget">http://127.0.0.1/path/to?param=value_with%28parenthesis%29&param2=1</a>',
+                'URL: www.localhost.com/path/to?param=value_with%28parenthesis%29&param2=1' => 'URL: <a href="http://www.localhost.com/path/to?param=value_with%28parenthesis%29&param2=1" class="_blanktarget">www.localhost.com/path/to?param=value_with%28parenthesis%29&param2=1</a>',
+                //URLs in Javascript. Commented out as part of MDL-21183
+                //'var url="http://moodle.org";'=>'var url="http://moodle.org";',
+                //'var url = "http://moodle.org";'=>'var url = "http://moodle.org";',
+                //'var url="www.moodle.org";'=>'var url="www.moodle.org";',
+                //'var url = "www.moodle.org";'=>'var url = "www.moodle.org";',
+                //doctype. do we care about this failing?
+                //'<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN http://www.w3.org/TR/html4/strict.dtd">'=>'<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN http://www.w3.org/TR/html4/strict.dtd">'
+            );
+
+        $testablefilter = new testable_filter_urltolink();
+
+        foreach ($texts as $text => $correctresult) {
+            $msg = "Testing text: ". str_replace('%', '%%', $text) . ": %s"; // Escape original '%' so sprintf() wont get confused
+
+            $testablefilter->convert_urls_into_links($text);
+
+            $this->assertEqual($text, $correctresult, $msg);
+        }
+
+        //performance testing
+        $reps = 1000;
+        $text = file_get_contents(dirname(__FILE__) . '/sample.txt');
+        $time_start = microtime(true);
+        for($i=0;$i<$reps;$i++) {
+            $testablefilter->convert_urls_into_links($text);
+        }
+        $time_end = microtime(true);
+        $new_time = $time_end - $time_start;
+
+        $time_start = microtime(true);
+        for($i=0;$i<$reps;$i++) {
+            $this->old_convert_urls_into_links($text);
+        }
+        $time_end = microtime(true);
+        $old_time = $time_end - $time_start;
+
+        $fast_enough = false;
+        if( $new_time < $old_time ) {
+            $fast_enough = true;
+        }
+
+        $this->assertEqual($fast_enough, true, 'Timing test: ' . $new_time . 'secs (new) < ' . $old_time . 'secs (old)');
+    }
+}
diff --git a/filter/urltolink/version.php b/filter/urltolink/version.php
new file mode 100644 (file)
index 0000000..8618552
--- /dev/null
@@ -0,0 +1,27 @@
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * @package    filter
+ * @subpackage urltolink
+ * @copyright  2010 David Mudrak <david@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->version = 2010100500;