Happy New Year
[squirrelmail.git] / functions / url_parser.php
index 05aca966c2e3567b45cd324689cfa1134b29fdb0..a70600046e14962102119f1d32c2e723aacbb325 100644 (file)
 <?php
-   /* URL Passing code to allow links from with in emails */
-
-   $url_parser_php = true;
-
-   function replaceBlock ($in, $replace, $start, $end) {
-      $begin = substr($in,0,$start);
-      $end   = substr($in,$end,strlen($in)-$end);
-      $ret   = $begin.$replace.$end;
-      return $ret;
-   }
-
-   function parseEmail ($body) {
-      global $color;
-      /*
-        This is here in case we ever decide to use highlighting of searched
-        text.  this does it for email addresses
-        
-      if ($what && ($where == "BODY" || $where == "TEXT")) {
-         eregi ("([a-z]|[0-9]|_|\.|-)+\@([a-z]|[0-9]|_|-)+(\.([a-z]|[0-9]|_|-)+)*", $body, $regs);
-         $oldaddr = $regs[0];
-         if ($oldaddr) {
-            $newaddr = eregi_replace ($what, "<b><font color=\"$color[2]\">$what</font></font></b>", $oldaddr);
-            $body = str_replace ($oldaddr, "<a href=\"../src/compose.php?send_to=$oldaddr\">$newaddr</a>", $body); 
-         }
-      } else { 
-         $body = eregi_replace ("([a-z]|[0-9]|_|\.|-)+\@([a-z]|[0-9]|_|-)+(\.([a-z]|[0-9]|_|-)+)*", "<a href=\"../src/compose.php?send_to=\\0\">\\0</a>", $body);
-      }
-      */
-      $body = eregi_replace ("([a-z]|[0-9]|_|\.|-)+\@([a-z]|[0-9]|_|-)+(\.([a-z]|[0-9]|_|-)+)*", "<a href=\"../src/compose.php?send_to=\\0\">\\0</a>", $body);
-      return $body;
-   }
-
-   function parseUrl ($body) {
-      #Possible ways a URL could finish.
-
-      $poss_ends=array(" ", "\n", "\r", "<", ">", ".\r", ".\n", ".&nbsp;", "&nbsp;", ")", "(", 
-                       "&quot;", "&lt;", "&gt;", ".<");
-      $done=False;
-      while (!$done) {
-         #Look for when a URL starts
-         $url_tokens = array(
-                         "http://",
-                         "https://",
-                         "ftp://",
-                         "telnet://");
-         for($i = 0; $i < sizeof($url_tokens); $i++) {
-           if($where = strpos(strtolower("^^".$body), $url_tokens[$i], $start))
-             break;
-         }
-         //$where = strpos(strtolower($body),"http://",$start);
-         if ($where) {
-            $where = $where - 2;  // because we added the ^^ at the begining
-            # Find the end of that URL
-            reset($poss_ends); $end=0; 
-            while (list($key, $val) = each($poss_ends)) {
-               $enda = strpos($body,$val,$where);
-               if ($end == 0) $end = $enda;
-               if ($enda < $end and $enda != 0) $end = $enda;
-            } 
-            if (!$end) $end = strlen($body);
-            #Extract URL
-            $url = substr($body,$where,$end-$where);
-            #Replace URL with HyperLinked Url
-            if ($url != "") {
-               $url_str = "<a href=\"$url\" target=\"_blank\">$url</a>";
-               #    $body = str_replace($url,$url_str,$body); 
-               # echo "$where, $end<br>";
-               $body = replaceBlock($body,$url_str,$where,$end);
-               $start = strpos($body,"</a>",$where);
-            } else { 
-               $start = $where + 7; 
+
+/**
+ * url_parser.php
+ *
+ * This code provides various string manipulation functions that are
+ * used by the rest of the SquirrelMail code.
+ *
+ * @copyright 1999-2020 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ */
+
+/**
+ * Undocumented - complain, then patch.
+ */
+function replaceBlock (&$in, $replace, $start, $end) {
+    $begin = substr($in,0,$start);
+    $end   = substr($in,$end,strlen($in)-$end);
+    $in    = $begin.$replace.$end;
+}
+
+/* Having this defined in just one spot could help when changes need
+ * to be made to the pattern
+ * Make sure that the expression is evaluated case insensitively
+ *
+ * RFC2822 (and RFC822) defines the left side of an email address as (roughly):
+ *  1*atext *("." 1*atext)
+ * where atext is: a-zA-Z0-9!#$%&'*+-/=?^_`{|}~
+ *
+ * Here's pretty sophisticated IP matching:
+ * $IPMatch = '(2[0-5][0-9]|1?[0-9]{1,2})';
+ * $IPMatch = '\[?' . $IPMatch . '(\.' . $IPMatch . '){3}\]?';
+ */
+/* Here's enough: */
+global $IP_RegExp_Match, $Host_RegExp_Match, $Email_RegExp_Match;
+//FIXME: these were written for use in an ereg().... they are now being used in preg()... we need to run some tests to make sure they are fully working still
+$IP_RegExp_Match = '\\[?[0-9]{1,3}(\\.[0-9]{1,3}){3}\\]?';
+$Host_RegExp_Match = '(' . $IP_RegExp_Match .
+    '|[0-9a-z]([-.]?[0-9a-z])*\\.[a-z][a-z]+)';
+// NB: the backslash in the following line escapes the forward slash, which assumes that the regular expression will be enclosed in /.../
+$atext = '([a-z0-9!#$&%*+\/=?^_`{|}~-]|&amp;)';
+$dot_atom = $atext . '+(\.' . $atext . '+)*';
+$Email_RegExp_Match = $dot_atom . '(%' . $Host_RegExp_Match . ')?@' .
+                      $Host_RegExp_Match;
+
+/**
+ * Parses a body and converts all found email addresses to clickable links.
+ *
+ * @param string body the body to process, by ref
+ * @return int the number of unique addresses found
+ */
+function parseEmail (&$body) {
+    global $Email_RegExp_Match;
+    $sbody     = $body;
+    $addresses = array();
+
+    /* Find all the email addresses in the body */
+    while (preg_match('/' . $Email_RegExp_Match . '/i', $sbody, $regs)) {
+        $addresses[$regs[0]] = strtr($regs[0], array('&amp;' => '&'));
+        $start = strpos($sbody, $regs[0]) + strlen($regs[0]);
+        $sbody = substr($sbody, $start);
+    }
+
+    /* Replace each email address with a compose URL */
+    foreach ($addresses as $text => $email) {
+        $comp_uri = makeComposeLink('src/compose.php?send_to='.urlencode($email), $text);
+        $body = str_replace($text, $comp_uri, $body);
+    }
+
+    /* Return number of unique addresses found */
+    return count($addresses);
+}
+
+
+/* We don't want to re-initialize this stuff for every line.  Save work
+ * and just do it once here.
+ */
+global $url_parser_url_tokens;
+$url_parser_url_tokens = array(
+    'http://',
+    'https://',
+    'ftp://',
+    'telnet:',  // Special case -- doesn't need the slashes
+    'mailto:',  // Special case -- doesn't use the slashes
+    'gopher://',
+    'news://');
+
+global $url_parser_poss_ends;
+$url_parser_poss_ends = array(' ', "\n", "\r", '<', '>', ".\r", ".\n",
+    '.&nbsp;', '&nbsp;', ')', '(', '&quot;', '&lt;', '&gt;', '.<',
+    ']', '[', '{', '}', "\240", ', ', '. ', ",\n", ",\r");
+
+
+/**
+ * rfc 2368 (mailto URL) preg_match() regexp
+ * @link http://www.ietf.org/rfc/rfc2368.txt
+ * @global string MailTo_PReg_Match the encapsulated regexp for preg_match()
+ */
+global $MailTo_PReg_Match;
+$Mailto_Email_RegExp = '[0-9a-z%]([-_.+%]?[0-9a-z])*(%' . $Host_RegExp_Match . ')?@' . $Host_RegExp_Match;
+$MailTo_PReg_Match = '/((?:' . $Mailto_Email_RegExp . ')*)((?:\?(?:to|cc|bcc|subject|body)=[^\s\?&=,()]+)?(?:&amp;(?:to|cc|bcc|subject|body)=[^\s\?&=,()]+)*)/i';
+
+/**
+ * Parses a body and converts all found URLs to clickable links.
+ *
+ * @param string body the body to process, by ref
+ * @return void
+ */
+function parseUrl (&$body) {
+    global $url_parser_poss_ends, $url_parser_url_tokens;
+    $start      = 0;
+    $blength    = strlen($body);
+
+    while ($start < $blength) {
+        $target_token = '';
+        $target_pos = $blength;
+
+        /* Find the first token to replace */
+        foreach ($url_parser_url_tokens as $the_token) {
+            $pos = strpos(strtolower($body), $the_token, $start);
+            if (is_int($pos) && $pos < $target_pos) {
+                $target_pos   = $pos;
+                $target_token = $the_token;
+            }
+        }
+
+        /* Look for email addresses between $start and $target_pos */
+        $check_str = substr($body, $start, $target_pos-$start);
+
+        if (parseEmail($check_str)) {
+            replaceBlock($body, $check_str, $start, $target_pos);
+            $blength    = strlen($body);
+            $target_pos = strlen($check_str) + $start;
+        }
+
+        // rfc 2368 (mailto URL)
+        if ($target_token == 'mailto:') {
+            $target_pos += 7;    //skip mailto:
+            $end = $blength;
+
+            $mailto = substr($body, $target_pos, $end-$target_pos);
+
+            global $MailTo_PReg_Match;
+            if ((preg_match($MailTo_PReg_Match, $mailto, $regs)) && ($regs[0] != '')) {
+                //sm_print_r($regs);
+                $mailto_before = $target_token . $regs[0];
+                /**
+                 * '+' characters in a mailto URI don't need to be percent-encoded.
+                 * However, when mailto URI data is transported via HTTP, '+' must
+                 * be percent-encoded as %2B so that when the HTTP data is
+                 * percent-decoded, you get '+' back and not a space.
+                 */
+                $mailto_params = str_replace("+", "%2B", $regs[10]);
+                if ($regs[1]) {    //if there is an email addr before '?', we need to merge it with the params
+                    $to = 'to=' . str_replace("+", "%2B", $regs[1]);
+                    if (strpos($mailto_params, 'to=') > -1)    //already a 'to='
+                        $mailto_params = str_replace('to=', $to . '%2C%20', $mailto_params);
+                    else {
+                        if ($mailto_params)    //already some params, append to them
+                            $mailto_params .= '&amp;' . $to;
+                        else
+                            $mailto_params .= '?' . $to;
+                    }
+                }
+                $url_str = preg_replace(array('/to=/i', '/(?<!b)cc=/i', '/bcc=/i'), array('send_to=', 'send_to_cc=', 'send_to_bcc='), $mailto_params);
+                $comp_uri = makeComposeLink('src/compose.php' . $url_str, $mailto_before);
+                replaceBlock($body, $comp_uri, $target_pos - 7, $target_pos + strlen($regs[0]));
+                $target_pos += strlen($comp_uri) - 7;
+            }
+        }
+        else
+        /* If there was a token to replace, replace it */
+        if ($target_token != '') {
+            /* Find the end of the URL */
+            $end = $blength;
+            foreach ($url_parser_poss_ends as $val) {
+                $enda = strpos($body, $val, $target_pos);
+                if (is_int($enda) && $enda < $end) {
+                    $end = $enda;
+                }
+            }
+
+            /* make sure that there are no 8bit chars between $target_pos and suspected end of URL */
+            if (!is_bool($first8bit=sq_strpos_8bit($body,$target_pos,$end))) {
+                $end = $first8bit;
             } 
-         } else {
-            $done=true;
-         }
-      }
 
-      return $body;
-   }
+            /* Extract URL */
+            $url = substr($body, $target_pos, $end-$target_pos);
+
+            /* Needed since lines are not passed with \n or \r */
+            while ( preg_match('/[,.]$/', $url) ) {
+                $url = substr( $url, 0, -1 );
+                $end--;
+            }
+
+            /* Replace URL with HyperLinked Url, requires 1 char in link */
+            if ($url != '' && $url != $target_token) {
+                $url_str = "<a href=\"$url\" target=\"_blank\">$url</a>";
+                replaceBlock($body,$url_str,$target_pos,$end);
+                $target_pos += strlen($url_str);
+            }
+            else {
+                // Not quite a valid link, skip ahead to next chance
+                $target_pos += strlen($target_token);
+            }
+        }
+
+        /* Move forward */
+        $start   = $target_pos;
+        $blength = strlen($body);
+    }
+}
+
+/**
+ * Parses a string and returns the first e-mail address found.
+ *
+ * @param string string the string to process
+ * @return string the first e-mail address found
+ */
+function getEmail($string) {
+    global $Email_RegExp_Match;
+    $addresses = array();
+
+    /* Find all the email addresses in the body */
+    while (preg_match('/' . $Email_RegExp_Match . '/i', $string, $regs)) {
+        $addresses[$regs[0]] = strtr($regs[0], array('&amp;' => '&'));
+        $start = strpos($string, $regs[0]) + strlen($regs[0]);
+        $string = substr($string, $start);
+    }
+
+    /* Return the first address, or an empty string if no address was found */
+    $addresses = array_values($addresses);
+    return (array_key_exists(0, $addresses) ? $addresses[0] : '');
+}
+
+/**
+ * Finds first occurrence of 8bit data in the string
+ *
+ * Function finds first 8bit symbol or html entity that represents 8bit character.
+ * Search start is defined by $offset argument. Search ends at $maxlength position.
+ * If $maxlength is not defined or bigger than provided string, search ends when 
+ * string ends.
+ *
+ * Check returned data type in order to avoid confusion between bool(false) 
+ * (not found) and int(0) (first char in the string).
+ * @param string $haystack
+ * @param integer $offset
+ * @param integer $maxlength
+ * @return mixed integer with first 8bit character position or boolean false 
+ * @since 1.5.2
+ */
+function sq_strpos_8bit($haystack,$offset=0,$maxlength=false) {
+    $ret = false;
 
-?>
+    if ($maxlength===false || strlen($haystack) < $maxlength) {
+        $maxlength=strlen($haystack);
+    }
 
+    for($i=$offset;$i<$maxlength;$i++) {
+        /* rh7-8 compatibility. don't use full 8bit range in regexp */
+        if (preg_match('/[\200-\237]|\240|[\241-\377]/',$haystack[$i])) {
+            /* we have 8bit char. stop here and return position */
+            $ret = $i;
+            break;
+        } elseif ($haystack[$i]=='&') {
+            $substring = substr($haystack,$i);
+            /**
+             * 1. look for "&#(decimal number);" where decimal_number is bigger than 127
+             * 2. look for "&x(hexadecimal number);", where hex number is bigger than x7f
+             * 3. look for any html character entity that is not 7bit html special char. Use 
+             * own sq_get_html_translation_table() function with 'utf-8' character set in 
+             * order to get all html entities.
+             */
+            if ((preg_match('/^&#(\d+);/',$substring,$match) && $match[1]>127) ||
+                (preg_match('/^&x([0-9a-f]+);/i',$substring,$match) && $match[1]>"\x7f") ||
+                (preg_match('/^&([a-z]+);/i',$substring,$match) && 
+                 !in_array($match[0],get_html_translation_table(HTML_SPECIALCHARS)) && 
+                 in_array($match[0],sq_get_html_translation_table(HTML_ENTITIES,ENT_COMPAT,'utf-8')))) {
+                $ret = $i;
+                break;
+            }
+        }
+    }
+    return $ret;
+}