Add phpdoc doc blocks to some files.
[squirrelmail.git] / functions / url_parser.php
index 30f95b3d179d058b1271ad24bc6071e36eb800db..eadebd37c9fbe2ba48c418d02fec63cf62baec47 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 $PHPSESSID;
-      $body = eregi_replace ("([a-z]|[0-9]|_|\.|-)+\@([a-z]|[0-9]|_|-)+(\.([a-z]|[0-9]|_|-)+)*", "<a href=\"../src/compose.php?PHPSESSID=$PHPSESSID&send_to=\\0\">\\0</a>", $body);
-      return $body;
-   }
-
-   function parseUrl ($body) {
-      #Possible ways a URL could finish.
-
-      $poss_ends=array(" ","\n","\r","<",".&nbsp","&nbsp");
-      $done=False;
-      while (!$done) {
-         #Look for when a URL starts
-         $where = strpos($body,"http:",$start);
-         if ($where) {
-            # 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;
-            } 
-            #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); 
-               $body = replaceBlock($body,$url_str,$where,$end);
-               $start = strpos($body,"</a>",$where);
-            } else { 
-               $start = $where + 7; 
-            } 
-         } else {
-            $done=true;
-         }
-      }
-
-      return $body;
-   }
 
-?>
+/**
+ * url_parser.php
+ *
+ * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * This code provides various string manipulation functions that are
+ * used by the rest of the Squirrelmail code.
+ *
+ * $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
+ *
+ * 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;
+$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]+)';
+$Email_RegExp_Match = '[0-9a-z]([-_.+]?[0-9a-z])*(%' . $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 $color, $Email_RegExp_Match;
+    $sbody     = $body;
+    $addresses = array();
+
+    /* Find all the email addresses in the body */
+    while(eregi($Email_RegExp_Match, $sbody, $regs)) {
+        $addresses[$regs[0]] = $regs[0];
+        $start = strpos($sbody, $regs[0]) + strlen($regs[0]);
+        $sbody = substr($sbody, $start);
+    }
+    /* Replace each email address with a compose URL */
+    foreach ($addresses as $email) {
+        $comp_uri = makeComposeLink('src/compose.php?send_to='.urlencode($email), $email);
+        $body = str_replace($email, $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
+    'gopher://',
+    'news://');
+
+global $url_parser_poss_ends;
+$url_parser_poss_ends = array(' ', "\n", "\r", '<', '>', ".\r", ".\n", 
+    '.&nbsp;', '&nbsp;', ')', '(', '&quot;', '&lt;', '&gt;', '.<', 
+    ']', '[', '{', '}', "\240", ', ', '. ', ",\n", ",\r");
+
+
+/**
+ * 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 < $blength) {
+                $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;
+        }
+
+        /* 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;
+                }
+            }
+
+            /* Extract URL */
+            $url = substr($body, $target_pos, $end-$target_pos);
+
+            /* Needed since lines are not passed with \n or \r */
+            while ( ereg("[,\.]$", $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);
+    }
+} 
+?>