class_RFC822.php
上传用户:gzy2002
上传日期:2010-02-11
资源大小:1785k
文件大小:27k
源码类别:

电子政务应用

开发平台:

Java

  1. <?php
  2. class Mail_RFC822
  3. {
  4.     /**
  5.      * The address being parsed by the RFC822 object.
  6.      * @var string $address
  7.      */
  8.     var $address = '';
  9.     /**
  10.      * The default domain to use for unqualified addresses.
  11.      * @var string $default_domain
  12.      */
  13.     var $default_domain = 'localhost';
  14.     /**
  15.      * Should we return a nested array showing groups, or flatten everything?
  16.      * @var boolean $nestGroups
  17.      */
  18.     var $nestGroups = true;
  19.     /**
  20.      * Whether or not to validate atoms for non-ascii characters.
  21.      * @var boolean $validate
  22.      */
  23.     var $validate = true;
  24.     /**
  25.      * The array of raw addresses built up as we parse.
  26.      * @var array $addresses
  27.      */
  28.     var $addresses = array();
  29.     /**
  30.      * The final array of parsed address information that we build up.
  31.      * @var array $structure
  32.      */
  33.     var $structure = array();
  34.     /**
  35.      * The current error message, if any.
  36.      * @var string $error
  37.      */
  38.     var $error = null;
  39.     /**
  40.      * An internal counter/pointer.
  41.      * @var integer $index
  42.      */
  43.     var $index = null;
  44.     /**
  45.      * The number of groups that have been found in the address list.
  46.      * @var integer $num_groups
  47.      * @access public
  48.      */
  49.     var $num_groups = 0;
  50.     /**
  51.      * A variable so that we can tell whether or not we're inside a
  52.      * Mail_RFC822 object.
  53.      * @var boolean $mailRFC822
  54.      */
  55.     var $mailRFC822 = true;
  56.     
  57.     /**
  58.     * A limit after which processing stops
  59.     * @var int $limit
  60.     */
  61.     var $limit = null;
  62.     /**
  63.      * Sets up the object. The address must either be set here or when
  64.      * calling parseAddressList(). One or the other.
  65.      *
  66.      * @access public
  67.      * @param string  $address         The address(es) to validate.
  68.      * @param string  $default_domain  Default domain/host etc. If not supplied, will be set to localhost.
  69.      * @param boolean $nest_groups     Whether to return the structure with groups nested for easier viewing.
  70.      * @param boolean $validate        Whether to validate atoms. Turn this off if you need to run addresses through before encoding the personal names, for instance.
  71.      * 
  72.      * @return object Mail_RFC822 A new Mail_RFC822 object.
  73.      */
  74.     function Mail_RFC822($address = null, $default_domain = null, $nest_groups = null, $validate = null, $limit = null)
  75.     {
  76.         if (isset($address))        $this->address        = $address;
  77.         if (isset($default_domain)) $this->default_domain = $default_domain;
  78.         if (isset($nest_groups))    $this->nestGroups     = $nest_groups;
  79.         if (isset($validate))       $this->validate       = $validate;
  80.         if (isset($limit))          $this->limit          = $limit;
  81.     }
  82.     /**
  83.      * Starts the whole process. The address must either be set here
  84.      * or when creating the object. One or the other.
  85.      *
  86.      * @access public
  87.      * @param string  $address         The address(es) to validate.
  88.      * @param string  $default_domain  Default domain/host etc.
  89.      * @param boolean $nest_groups     Whether to return the structure with groups nested for easier viewing.
  90.      * @param boolean $validate        Whether to validate atoms. Turn this off if you need to run addresses through before encoding the personal names, for instance.
  91.      * 
  92.      * @return array A structured array of addresses.
  93.      */
  94.     function parseAddressList($address = null, $default_domain = null, $nest_groups = null, $validate = null, $limit = null)
  95.     {
  96.         if (!isset($this->mailRFC822)) {
  97.             $obj = new Mail_RFC822($address, $default_domain, $nest_groups, $validate, $limit);
  98.             return $obj->parseAddressList();
  99.         }
  100.         if (isset($address))        $this->address        = $address;
  101.         if (isset($default_domain)) $this->default_domain = $default_domain;
  102.         if (isset($nest_groups))    $this->nestGroups     = $nest_groups;
  103.         if (isset($validate))       $this->validate       = $validate;
  104.         if (isset($limit))          $this->limit          = $limit;
  105.         $this->structure  = array();
  106.         $this->addresses  = array();
  107.         $this->error      = null;
  108.         $this->index      = null;
  109.         while ($this->address = $this->_splitAddresses($this->address)) {
  110.             continue;
  111.         }
  112.         
  113.         if ($this->address === false || isset($this->error)) {
  114.             return false;
  115.         }
  116.         // Reset timer since large amounts of addresses can take a long time to
  117.         // get here
  118.         @set_time_limit(30);
  119.         // Loop through all the addresses
  120.         for ($i = 0; $i < count($this->addresses); $i++){
  121.             if (($return = $this->_validateAddress($this->addresses[$i])) === false
  122.                 || isset($this->error)) {
  123.                 return false;
  124.             }
  125.             
  126.             if (!$this->nestGroups) {
  127.                 $this->structure = array_merge($this->structure, $return);
  128.             } else {
  129.                 $this->structure[] = $return;
  130.             }
  131.         }
  132.         return $this->structure;
  133.     }
  134.     /**
  135.      * Splits an address into seperate addresses.
  136.      * 
  137.      * @access private
  138.      * @param string $address The addresses to split.
  139.      * @return boolean Success or failure.
  140.      */
  141.     function _splitAddresses($address)
  142.     {
  143.         if (!empty($this->limit) AND count($this->addresses) == $this->limit) {
  144.             return '';
  145.         }
  146.         if ($this->_isGroup($address) && !isset($this->error)) {
  147.             $split_char = ';';
  148.             $is_group   = true;
  149.         } elseif (!isset($this->error)) {
  150.             $split_char = ',';
  151.             $is_group   = false;
  152.         } elseif (isset($this->error)) {
  153.             return false;
  154.         }
  155.         // Split the string based on the above ten or so lines.
  156.         $parts  = explode($split_char, $address);
  157.         $string = $this->_splitCheck($parts, $split_char);
  158.         // If a group...
  159.         if ($is_group) {
  160.             // If $string does not contain a colon outside of
  161.             // brackets/quotes etc then something's fubar.
  162.             // First check there's a colon at all:
  163.             if (strpos($string, ':') === false) {
  164.                 $this->error = 'Invalid address: ' . $string;
  165.                 return false;
  166.             }
  167.             // Now check it's outside of brackets/quotes:
  168.             if (!$this->_splitCheck(explode(':', $string), ':'))
  169.                 return false;
  170.             // We must have a group at this point, so increase the counter:
  171.             $this->num_groups++;
  172.         }
  173.         // $string now contains the first full address/group.
  174.         // Add to the addresses array.
  175.         $this->addresses[] = array(
  176.                                    'address' => trim($string),
  177.                                    'group'   => $is_group
  178.                                    );
  179.         // Remove the now stored address from the initial line, the +1
  180.         // is to account for the explode character.
  181.         $address = trim(substr($address, strlen($string) + 1));
  182.         // If the next char is a comma and this was a group, then
  183.         // there are more addresses, otherwise, if there are any more
  184.         // chars, then there is another address.
  185.         if ($is_group && substr($address, 0, 1) == ','){
  186.             $address = trim(substr($address, 1));
  187.             return $address;
  188.         } elseif (strlen($address) > 0) {
  189.             return $address;
  190.         } else {
  191.             return '';
  192.         }
  193.         // If you got here then something's off
  194.         return false;
  195.     }
  196.     /**
  197.      * Checks for a group at the start of the string.
  198.      * 
  199.      * @access private
  200.      * @param string $address The address to check.
  201.      * @return boolean Whether or not there is a group at the start of the string.
  202.      */
  203.     function _isGroup($address)
  204.     {
  205.         // First comma not in quotes, angles or escaped:
  206.         $parts  = explode(',', $address);
  207.         $string = $this->_splitCheck($parts, ',');
  208.         // Now we have the first address, we can reliably check for a
  209.         // group by searching for a colon that's not escaped or in
  210.         // quotes or angle brackets.
  211.         if (count($parts = explode(':', $string)) > 1) {
  212.             $string2 = $this->_splitCheck($parts, ':');
  213.             return ($string2 !== $string);
  214.         } else {
  215.             return false;
  216.         }
  217.     }
  218.     /**
  219.      * A common function that will check an exploded string.
  220.      * 
  221.      * @access private
  222.      * @param array $parts The exloded string.
  223.      * @param string $char  The char that was exploded on.
  224.      * @return mixed False if the string contains unclosed quotes/brackets, or the string on success.
  225.      */
  226.     function _splitCheck($parts, $char)
  227.     {
  228.         $string = $parts[0];
  229.         for ($i = 0; $i < count($parts); $i++) {
  230.             if ($this->_hasUnclosedQuotes($string)
  231.                 || $this->_hasUnclosedBrackets($string, '<>')
  232.                 || $this->_hasUnclosedBrackets($string, '[]')
  233.                 || $this->_hasUnclosedBrackets($string, '()')
  234.                 || substr($string, -1) == '\') {
  235.                 if (isset($parts[$i + 1])) {
  236.                     $string = $string . $char . $parts[$i + 1];
  237.                 } else {
  238.                     $this->error = 'Invalid address spec. Unclosed bracket or quotes';
  239.                     return false;
  240.                 }
  241.             } else {
  242.                 $this->index = $i;
  243.                 break;
  244.             }
  245.         }
  246.         return $string;
  247.     }
  248.     /**
  249.      * Checks if a string has an unclosed quotes or not.
  250.      * 
  251.      * @access private
  252.      * @param string $string The string to check.
  253.      * @return boolean True if there are unclosed quotes inside the string, false otherwise.
  254.      */
  255.     function _hasUnclosedQuotes($string)
  256.     {
  257.         $string     = explode('"', $string);
  258.         $string_cnt = count($string);
  259.         for ($i = 0; $i < (count($string) - 1); $i++)
  260.             if (substr($string[$i], -1) == '\')
  261.                 $string_cnt--;
  262.         return ($string_cnt % 2 === 0);
  263.     }
  264.     /**
  265.      * Checks if a string has an unclosed brackets or not. IMPORTANT:
  266.      * This function handles both angle brackets and square brackets;
  267.      * 
  268.      * @access private
  269.      * @param string $string The string to check.
  270.      * @param string $chars  The characters to check for.
  271.      * @return boolean True if there are unclosed brackets inside the string, false otherwise.
  272.      */
  273.     function _hasUnclosedBrackets($string, $chars)
  274.     {
  275.         $num_angle_start = substr_count($string, $chars[0]);
  276.         $num_angle_end   = substr_count($string, $chars[1]);
  277.         $this->_hasUnclosedBracketsSub($string, $num_angle_start, $chars[0]);
  278.         $this->_hasUnclosedBracketsSub($string, $num_angle_end, $chars[1]);
  279.         if ($num_angle_start < $num_angle_end) {
  280.             $this->error = 'Invalid address spec. Unmatched quote or bracket (' . $chars . ')';
  281.             return false;
  282.         } else {
  283.             return ($num_angle_start > $num_angle_end);
  284.         }
  285.     }
  286.     /**
  287.      * Sub function that is used only by hasUnclosedBrackets().
  288.      * 
  289.      * @access private
  290.      * @param string $string The string to check.
  291.      * @param integer &$num    The number of occurences.
  292.      * @param string $char   The character to count.
  293.      * @return integer The number of occurences of $char in $string, adjusted for backslashes.
  294.      */
  295.     function _hasUnclosedBracketsSub($string, &$num, $char)
  296.     {
  297.         $parts = explode($char, $string);
  298.         for ($i = 0; $i < count($parts); $i++){
  299.             if (substr($parts[$i], -1) == '\' || $this->_hasUnclosedQuotes($parts[$i]))
  300.                 $num--;
  301.             if (isset($parts[$i + 1]))
  302.                 $parts[$i + 1] = $parts[$i] . $char . $parts[$i + 1];
  303.         }
  304.         
  305.         return $num;
  306.     }
  307.     /**
  308.      * Function to begin checking the address.
  309.      *
  310.      * @access private
  311.      * @param string $address The address to validate.
  312.      * @return mixed False on failure, or a structured array of address information on success.
  313.      */
  314.     function _validateAddress($address)
  315.     {
  316.         $is_group = false;
  317.         if ($address['group']) {
  318.             $is_group = true;
  319.             // Get the group part of the name
  320.             $parts     = explode(':', $address['address']);
  321.             $groupname = $this->_splitCheck($parts, ':');
  322.             $structure = array();
  323.             // And validate the group part of the name.
  324.             if (!$this->_validatePhrase($groupname)){
  325.                 $this->error = 'Group name did not validate.';
  326.                 return false;
  327.             } else {
  328.                 // Don't include groups if we are not nesting
  329.                 // them. This avoids returning invalid addresses.
  330.                 if ($this->nestGroups) {
  331.                     $structure = new stdClass;
  332.                     $structure->groupname = $groupname;
  333.                 }
  334.             }
  335.             $address['address'] = ltrim(substr($address['address'], strlen($groupname . ':')));
  336.         }
  337.         // If a group then split on comma and put into an array.
  338.         // Otherwise, Just put the whole address in an array.
  339.         if ($is_group) {
  340.             while (strlen($address['address']) > 0) {
  341.                 $parts       = explode(',', $address['address']);
  342.                 $addresses[] = $this->_splitCheck($parts, ',');
  343.                 $address['address'] = trim(substr($address['address'], strlen(end($addresses) . ',')));
  344.             }
  345.         } else {
  346.             $addresses[] = $address['address'];
  347.         }
  348.         // Check that $addresses is set, if address like this:
  349.         // Groupname:;
  350.         // Then errors were appearing.
  351.         if (!isset($addresses)){
  352.             $this->error = 'Empty group.';
  353.             return false;
  354.         }
  355.         for ($i = 0; $i < count($addresses); $i++) {
  356.             $addresses[$i] = trim($addresses[$i]);
  357.         }
  358.         // Validate each mailbox.
  359.         // Format could be one of: name 
  360.         //                         geezer
  361.         // ... or any other format valid by RFC 822.
  362.         array_walk($addresses, array($this, 'validateMailbox'));
  363.         // Nested format
  364.         if ($this->nestGroups) {
  365.             if ($is_group) {
  366.                 $structure->addresses = $addresses;
  367.             } else {
  368.                 $structure = $addresses[0];
  369.             }
  370.         // Flat format
  371.         } else {
  372.             if ($is_group) {
  373.                 $structure = array_merge($structure, $addresses);
  374.             } else {
  375.                 $structure = $addresses;
  376.             }
  377.         }
  378.         return $structure;
  379.     }
  380.     /**
  381.      * Function to validate a phrase.
  382.      *
  383.      * @access private
  384.      * @param string $phrase The phrase to check.
  385.      * @return boolean Success or failure.
  386.      */
  387.     function _validatePhrase($phrase)
  388.     {
  389.         // Splits on one or more Tab or space.
  390.         $parts = preg_split('/[ \x09]+/', $phrase, -1, PREG_SPLIT_NO_EMPTY);
  391.         $phrase_parts = array();
  392.         while (count($parts) > 0){
  393.             $phrase_parts[] = $this->_splitCheck($parts, ' ');
  394.             for ($i = 0; $i < $this->index + 1; $i++)
  395.                 array_shift($parts);
  396.         }
  397.         for ($i = 0; $i < count($phrase_parts); $i++) {
  398.             // If quoted string:
  399.             if (substr($phrase_parts[$i], 0, 1) == '"') {
  400.                 if (!$this->_validateQuotedString($phrase_parts[$i]))
  401.                     return false;
  402.                 continue;
  403.             }
  404.             // Otherwise it's an atom:
  405.             if (!$this->_validateAtom($phrase_parts[$i])) return false;
  406.         }
  407.         return true;
  408.     }
  409.     /**
  410.      * Function to validate an atom which from rfc822 is:
  411.      * atom = 1*<any CHAR except specials, SPACE and CTLs>
  412.      * 
  413.      * If validation ($this->validate) has been turned off, then
  414.      * validateAtom() doesn't actually check anything. This is so that you
  415.      * can split a list of addresses up before encoding personal names
  416.      * (umlauts, etc.), for example.
  417.      * 
  418.      * @access private
  419.      * @param string $atom The string to check.
  420.      * @return boolean Success or failure.
  421.      */
  422.     function _validateAtom($atom)
  423.     {
  424.         if (!$this->validate) {
  425.             // Validation has been turned off; assume the atom is okay.
  426.             return true;
  427.         }
  428.         // Check for any char from ASCII 0 - ASCII 127
  429.         if (!preg_match('/^[\x00-\x7E]+$/i', $atom, $matches)) {
  430.             return false;
  431.         }
  432.         // Check for specials:
  433.         if (preg_match('/[][()<>@,;\:". ]/', $atom)) {
  434.             return false;
  435.         }
  436.         // Check for control characters (ASCII 0-31):
  437.         if (preg_match('/[\x00-\x1F]+/', $atom)) {
  438.             return false;
  439.         }
  440.         return true;
  441.     }
  442.     /**
  443.      * Function to validate quoted string, which is:
  444.      * quoted-string = <"> *(qtext/quoted-pair) <">
  445.      * 
  446.      * @access private
  447.      * @param string $qstring The string to check
  448.      * @return boolean Success or failure.
  449.      */
  450.     function _validateQuotedString($qstring)
  451.     {
  452.         // Leading and trailing "
  453.         $qstring = substr($qstring, 1, -1);
  454.         // Perform check.
  455.         return !(preg_match('/(.)[x0D\\"]/', $qstring, $matches) && $matches[1] != '\');
  456.     }
  457.     /**
  458.      * Function to validate a mailbox, which is:
  459.      * mailbox =   addr-spec         ; simple address
  460.      *           / phrase route-addr ; name and route-addr
  461.      * 
  462.      * @access public
  463.      * @param string &$mailbox The string to check.
  464.      * @return boolean Success or failure.
  465.      */
  466.     function validateMailbox(&$mailbox)
  467.     {
  468.         // A couple of defaults.
  469.         $phrase  = '';
  470.         $comment = '';
  471.         // Catch any RFC822 comments and store them separately
  472.         $_mailbox = $mailbox;
  473.         while (strlen(trim($_mailbox)) > 0) {
  474.             $parts = explode('(', $_mailbox);
  475.             $before_comment = $this->_splitCheck($parts, '(');
  476.             if ($before_comment != $_mailbox) {
  477.                 // First char should be a (
  478.                 $comment    = substr(str_replace($before_comment, '', $_mailbox), 1);
  479.                 $parts      = explode(')', $comment);
  480.                 $comment    = $this->_splitCheck($parts, ')');
  481.                 $comments[] = $comment;
  482.                 // +1 is for the trailing )
  483.                 $_mailbox   = substr($_mailbox, strpos($_mailbox, $comment)+strlen($comment)+1);
  484.             } else {
  485.                 break;
  486.             }
  487.         }
  488. if (isset($comments)) {
  489.         for($i=0; $i<count(@$comments); $i++){
  490.              $mailbox = str_replace('('.$comments[$i].')', '', $mailbox);
  491.          }
  492. }
  493.         $mailbox = trim($mailbox);
  494.         // Check for name + route-addr
  495.         if (substr($mailbox, -1) == '>' && substr($mailbox, 0, 1) != '<') {
  496.             $parts  = explode('<', $mailbox);
  497.             $name   = $this->_splitCheck($parts, '<');
  498.             $phrase     = trim($name);
  499.             $route_addr = trim(substr($mailbox, strlen($name.'<'), -1));
  500.             if ($this->_validatePhrase($phrase) === false || ($route_addr = $this->_validateRouteAddr($route_addr)) === false)
  501.                 return false;
  502.         // Only got addr-spec
  503.         } else {
  504.             // First snip angle brackets if present.
  505.             if (substr($mailbox,0,1) == '<' && substr($mailbox,-1) == '>')
  506.                 $addr_spec = substr($mailbox,1,-1);
  507.             else
  508.                 $addr_spec = $mailbox;
  509.             if (($addr_spec = $this->_validateAddrSpec($addr_spec)) === false)
  510.                 return false;
  511.         }
  512.         // Construct the object that will be returned.
  513.         $mbox = new stdClass();
  514.         // Add the phrase (even if empty) and comments
  515.         $mbox->personal = $phrase;
  516.         $mbox->comment  = isset($comments) ? $comments : array();
  517.         if (isset($route_addr)) {
  518.             $mbox->mailbox = $route_addr['local_part'];
  519.             $mbox->host    = $route_addr['domain'];
  520.             $route_addr['adl'] !== '' ? $mbox->adl = $route_addr['adl'] : '';
  521.         } else {
  522.             $mbox->mailbox = $addr_spec['local_part'];
  523.             $mbox->host    = $addr_spec['domain'];
  524.         }
  525.         $mailbox = $mbox;
  526.         return true;
  527.     }
  528.     /**
  529.      * This function validates a route-addr which is:
  530.      * route-addr = "<" [route] addr-spec ">"
  531.      *
  532.      * Angle brackets have already been removed at the point of
  533.      * getting to this function.
  534.      * 
  535.      * @access private
  536.      * @param string $route_addr The string to check.
  537.      * @return mixed False on failure, or an array containing validated address/route information on success.
  538.      */
  539.     function _validateRouteAddr($route_addr)
  540.     {
  541.         // Check for colon.
  542.         if (strpos($route_addr, ':') !== false) {
  543.             $parts = explode(':', $route_addr);
  544.             $route = $this->_splitCheck($parts, ':');
  545.         } else {
  546.             $route = $route_addr;
  547.         }
  548.         // If $route is same as $route_addr then the colon was in
  549.         // quotes or brackets or, of course, non existent.
  550.         if ($route === $route_addr){
  551.             unset($route);
  552.             $addr_spec = $route_addr;
  553.             if (($addr_spec = $this->_validateAddrSpec($addr_spec)) === false) {
  554.                 return false;
  555.             }
  556.         } else {
  557.             // Validate route part.
  558.             if (($route = $this->_validateRoute($route)) === false) {
  559.                 return false;
  560.             }
  561.             $addr_spec = substr($route_addr, strlen($route . ':'));
  562.             // Validate addr-spec part.
  563.             if (($addr_spec = $this->_validateAddrSpec($addr_spec)) === false) {
  564.                 return false;
  565.             }
  566.         }
  567.         if (isset($route)) {
  568.             $return['adl'] = $route;
  569.         } else {
  570.             $return['adl'] = '';
  571.         }
  572.         $return = array_merge($return, $addr_spec);
  573.         return $return;
  574.     }
  575.     /**
  576.      * Function to validate a route, which is:
  577.      * route = 1#("@" domain) ":"
  578.      * 
  579.      * @access private
  580.      * @param string $route The string to check.
  581.      * @return mixed False on failure, or the validated $route on success.
  582.      */
  583.     function _validateRoute($route)
  584.     {
  585.         // Split on comma.
  586.         $domains = explode(',', trim($route));
  587.         for ($i = 0; $i < count($domains); $i++) {
  588.             $domains[$i] = str_replace('@', '', trim($domains[$i]));
  589.             if (!$this->_validateDomain($domains[$i])) return false;
  590.         }
  591.         return $route;
  592.     }
  593.     /**
  594.      * Function to validate a domain, though this is not quite what
  595.      * you expect of a strict internet domain.
  596.      *
  597.      * domain = sub-domain *("." sub-domain)
  598.      * 
  599.      * @access private
  600.      * @param string $domain The string to check.
  601.      * @return mixed False on failure, or the validated domain on success.
  602.      */
  603.     function _validateDomain($domain)
  604.     {
  605.         // Note the different use of $subdomains and $sub_domains                        
  606.         $subdomains = explode('.', $domain);
  607.         while (count($subdomains) > 0) {
  608.             $sub_domains[] = $this->_splitCheck($subdomains, '.');
  609.             for ($i = 0; $i < $this->index + 1; $i++)
  610.                 array_shift($subdomains);
  611.         }
  612.         for ($i = 0; $i < count($sub_domains); $i++) {
  613.             if (!$this->_validateSubdomain(trim($sub_domains[$i])))
  614.                 return false;
  615.         }
  616.         // Managed to get here, so return input.
  617.         return $domain;
  618.     }
  619.     /**
  620.      * Function to validate a subdomain:
  621.      *   subdomain = domain-ref / domain-literal
  622.      * 
  623.      * @access private
  624.      * @param string $subdomain The string to check.
  625.      * @return boolean Success or failure.
  626.      */
  627.     function _validateSubdomain($subdomain)
  628.     {
  629.         if (preg_match('|^[(.*)]$|', $subdomain, $arr)){
  630.             if (!$this->_validateDliteral($arr[1])) return false;
  631.         } else {
  632.             if (!$this->_validateAtom($subdomain)) return false;
  633.         }
  634.         // Got here, so return successful.
  635.         return true;
  636.     }
  637.     /**
  638.      * Function to validate a domain literal:
  639.      *   domain-literal =  "[" *(dtext / quoted-pair) "]"
  640.      * 
  641.      * @access private
  642.      * @param string $dliteral The string to check.
  643.      * @return boolean Success or failure.
  644.      */
  645.     function _validateDliteral($dliteral)
  646.     {
  647.         return !preg_match('/(.)[][x0D\\]/', $dliteral, $matches) && $matches[1] != '\';
  648.     }
  649.     /**
  650.      * Function to validate an addr-spec.
  651.      *
  652.      * addr-spec = local-part "@" domain
  653.      * 
  654.      * @access private
  655.      * @param string $addr_spec The string to check.
  656.      * @return mixed False on failure, or the validated addr-spec on success.
  657.      */
  658.     function _validateAddrSpec($addr_spec)
  659.     {
  660.         $addr_spec = trim($addr_spec);
  661.         // Split on @ sign if there is one.
  662.         if (strpos($addr_spec, '@') !== false) {
  663.             $parts      = explode('@', $addr_spec);
  664.             $local_part = $this->_splitCheck($parts, '@');
  665.             $domain     = substr($addr_spec, strlen($local_part . '@'));
  666.         // No @ sign so assume the default domain.
  667.         } else {
  668.             $local_part = $addr_spec;
  669.             $domain     = $this->default_domain;
  670.         }
  671.         if (($local_part = $this->_validateLocalPart($local_part)) === false) return false;
  672.         if (($domain     = $this->_validateDomain($domain)) === false) return false;
  673.         
  674.         // Got here so return successful.
  675.         return array('local_part' => $local_part, 'domain' => $domain);
  676.     }
  677.     /**
  678.      * Function to validate the local part of an address:
  679.      *   local-part = word *("." word)
  680.      * 
  681.      * @access private
  682.      * @param string $local_part
  683.      * @return mixed False on failure, or the validated local part on success.
  684.      */
  685.     function _validateLocalPart($local_part)
  686.     {
  687.         $parts = explode('.', $local_part);
  688.         // Split the local_part into words.
  689.         while (count($parts) > 0){
  690.             $words[] = $this->_splitCheck($parts, '.');
  691.             for ($i = 0; $i < $this->index + 1; $i++) {
  692.                 array_shift($parts);
  693.             }
  694.         }
  695.         // Validate each word.
  696.         for ($i = 0; $i < count($words); $i++) {
  697.             if ($this->_validatePhrase(trim($words[$i])) === false) return false;
  698.         }
  699.         // Managed to get here, so return the input.
  700.         return $local_part;
  701.     }
  702.     /**
  703.     * Returns an approximate count of how many addresses are
  704.     * in the given string. This is APPROXIMATE as it only splits
  705.     * based on a comma which has no preceding backslash. Could be
  706.     * useful as large amounts of addresses will end up producing
  707.     * *large* structures when used with parseAddressList().
  708.     *
  709.     * @param  string $data Addresses to count
  710.     * @return int          Approximate count
  711.     */
  712.     function approximateCount($data)
  713.     {
  714.         return count(preg_split('/(?<!\\),/', $data));
  715.     }
  716.     
  717.     /**
  718.     * This is a email validating function seperate to the rest
  719.     * of the class. It simply validates whether an email is of
  720.     * the common internet form: <user>@<domain>. This can be
  721.     * sufficient for most people. Optional stricter mode can
  722.     * be utilised which restricts mailbox characters allowed
  723.     * to alphanumeric, full stop, hyphen and underscore.
  724.     *
  725.     * @param  string  $data   Address to check
  726.     * @param  boolean $strict Optional stricter mode
  727.     * @return mixed           False if it fails, an indexed array
  728.     *                         username/domain if it matches
  729.     */
  730.     function isValidInetAddress($data, $strict = false)
  731.     {
  732.         $regex = $strict ? '/^([.0-9a-z_-]+)@(([0-9a-z-]+.)+[0-9a-z]{2,4})$/i' : '/^([*+!.&#$|'\%/0-9a-z^_`{}=?~:-]+)@(([0-9a-z-]+.)+[0-9a-z]{2,4})$/i';
  733.         if (preg_match($regex, trim($data), $matches)) {
  734.             return array($matches[1], $matches[2]);
  735.         } else {
  736.             return false;
  737.         }
  738.     }
  739. }
  740. ?>