[23] | 1 | <?php |
---|
| 2 | /** |
---|
[362] | 3 | * The Strangecode Codebase - a general application development framework for PHP |
---|
| 4 | * For details visit the project site: <http://trac.strangecode.com/codebase/> |
---|
| 5 | * Copyright 2001-2009 Strangecode Internet Consultancy |
---|
| 6 | * |
---|
| 7 | * This file is part of The Strangecode Codebase. |
---|
| 8 | * |
---|
| 9 | * The Strangecode Codebase is free software: you can redistribute it and/or |
---|
| 10 | * modify it under the terms of the GNU General Public License as published by the |
---|
| 11 | * Free Software Foundation, either version 3 of the License, or (at your option) |
---|
| 12 | * any later version. |
---|
| 13 | * |
---|
| 14 | * The Strangecode Codebase is distributed in the hope that it will be useful, but |
---|
| 15 | * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
---|
| 16 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
---|
| 17 | * details. |
---|
| 18 | * |
---|
| 19 | * You should have received a copy of the GNU General Public License along with |
---|
| 20 | * The Strangecode Codebase. If not, see <http://www.gnu.org/licenses/>. |
---|
| 21 | */ |
---|
| 22 | |
---|
| 23 | /** |
---|
[23] | 24 | * Email.inc.php |
---|
| 25 | * |
---|
| 26 | * Easy email template usage. |
---|
| 27 | * |
---|
| 28 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 29 | * @version 1.0 |
---|
[136] | 30 | * |
---|
| 31 | |
---|
[23] | 32 | // Example. |
---|
| 33 | $email = new Email(array( |
---|
| 34 | 'to' => array($frm['email'], 'q@lovemachine.local'), |
---|
[136] | 35 | 'from' => sprintf('%s <%s>', $app->getParam('site_name'), $app->getParam('site_email')), |
---|
[24] | 36 | 'subject' => 'Your account has been activated', |
---|
[23] | 37 | )); |
---|
| 38 | $email->setTemplate('email_registration_confirm.ihtml'); |
---|
[41] | 39 | // $email->setString('Or you can pass your message body as a string, also with {VARIABLES}.'); |
---|
[23] | 40 | $email->replace(array( |
---|
[136] | 41 | 'site_name' => $app->getParam('site_name'), |
---|
| 42 | 'site_url' => $app->getParam('site_url'), |
---|
[23] | 43 | 'username' => $frm['username'], |
---|
| 44 | 'password' => $frm['password1'], |
---|
| 45 | )); |
---|
| 46 | if ($email->send()) { |
---|
[136] | 47 | $app->raiseMsg(sprintf(_("A confirmation email has been sent to %s."), $frm['email']), MSG_SUCCESS, __FILE__, __LINE__); |
---|
[23] | 48 | } else { |
---|
[136] | 49 | $app->logMsg(sprintf('Error sending confirmation email to address %s', $frm['email']), LOG_NOTICE, __FILE__, __LINE__); |
---|
[23] | 50 | } |
---|
[136] | 51 | |
---|
| 52 | * |
---|
[23] | 53 | */ |
---|
| 54 | class Email { |
---|
| 55 | |
---|
[24] | 56 | // Default parameters, to be overwritten by setParam() and read with getParam() |
---|
[23] | 57 | var $_params = array( |
---|
| 58 | 'to' => null, |
---|
| 59 | 'from' => null, |
---|
| 60 | 'subject' => null, |
---|
[38] | 61 | 'headers' => null, |
---|
[212] | 62 | 'regex' => null, |
---|
| 63 | |
---|
| 64 | // A single carriage return (\n) should terminate lines for locally injected mail. |
---|
| 65 | // A carriage return + line-feed (\r\n) should be used if sending mail directly with SMTP. |
---|
| 66 | 'crlf' => "\n", |
---|
| 67 | |
---|
| 68 | // RFC 2822 says line length MUST be no more than 998 characters, and SHOULD be no more than 78 characters, excluding the CRLF. |
---|
| 69 | // http://mailformat.dan.info/body/linelength.html |
---|
| 70 | 'wrap' => true, |
---|
| 71 | 'line_length' => 75, |
---|
[23] | 72 | ); |
---|
[42] | 73 | |
---|
[24] | 74 | // String that contains the email body. |
---|
[23] | 75 | var $_template; |
---|
[42] | 76 | |
---|
[24] | 77 | // String that contains the email body after replacements. |
---|
[23] | 78 | var $_template_replaced; |
---|
| 79 | |
---|
| 80 | /** |
---|
| 81 | * Constructor. |
---|
| 82 | * |
---|
| 83 | * @access public |
---|
| 84 | * @param array $params Array of object parameters. |
---|
| 85 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 86 | * @since 28 Nov 2005 12:59:41 |
---|
| 87 | */ |
---|
| 88 | function Email($params=null) |
---|
| 89 | { |
---|
[334] | 90 | // The regex used in validEmail(). Set here instead of in the default _params above so we can use the concatenation . dot. |
---|
[357] | 91 | // This matches a (valid) email address as complex as: |
---|
| 92 | // "Jane & Bob Smith" <bob&smith's/dep=sales!@smith-wick.ca.us> (Sales department) |
---|
[24] | 93 | // ...and something as simple as: |
---|
| 94 | // x@x.com |
---|
[357] | 95 | $this->setParam(array('regex' => '/^(?:(?:"[^"]*?"\s*|[^,@]*)(<)|(?:"[^"]*?"|[^,@]*)\s+|)' // Display name |
---|
| 96 | . '((?:[^.<>\s@",\[\]]+[^<>\s@",\[\]])*[^.<>\s@",\[\]]+)' // Local-part |
---|
[23] | 97 | . '@' // @ |
---|
| 98 | . '((?:(\[)|[A-Z0-9]?)' // Domain, first char |
---|
| 99 | . '(?(4)' // Domain conditional for if first domain char is [ |
---|
| 100 | . '(?:[0-9]{1,3}\.){3}[0-9]{1,3}\]' // TRUE, matches IP address |
---|
| 101 | . '|' |
---|
| 102 | . '[.-]?(?:[A-Z0-9]+[-.])*(?:[A-Z0-9]+\.)+[A-Z]{2,6}))' // FALSE, matches domain name |
---|
| 103 | . '(?(1)' // Comment conditional for if initial < exists |
---|
| 104 | . '(?:>\s*|>\s+\([^,@]+\)\s*)' // TRUE, ensure ending > |
---|
| 105 | . '|' |
---|
| 106 | . '(?:|\s*|\s+\([^,@]+\)\s*))$/i')); // FALSE ensure there is no ending > |
---|
| 107 | |
---|
[25] | 108 | if (isset($params)) { |
---|
| 109 | $this->setParam($params); |
---|
| 110 | } |
---|
[23] | 111 | } |
---|
| 112 | |
---|
| 113 | /** |
---|
| 114 | * Set (or overwrite existing) parameters by passing an array of new parameters. |
---|
| 115 | * |
---|
| 116 | * @access public |
---|
| 117 | * @param array $params Array of parameters (key => val pairs). |
---|
| 118 | */ |
---|
| 119 | function setParam($params) |
---|
| 120 | { |
---|
[136] | 121 | $app =& App::getInstance(); |
---|
| 122 | |
---|
[23] | 123 | if (isset($params) && is_array($params)) { |
---|
| 124 | // Enforce valid email addresses. |
---|
| 125 | if (isset($params['to']) && !$this->validEmail($params['to'])) { |
---|
| 126 | $params['to'] = null; |
---|
| 127 | } |
---|
| 128 | if (isset($params['from']) && !$this->validEmail($params['from'])) { |
---|
| 129 | $params['from'] = null; |
---|
| 130 | } |
---|
| 131 | |
---|
| 132 | // Merge new parameters with old overriding only those passed. |
---|
| 133 | $this->_params = array_merge($this->_params, $params); |
---|
| 134 | } else { |
---|
[136] | 135 | $app->logMsg(sprintf('Parameters are not an array: %s', $params), LOG_ERR, __FILE__, __LINE__); |
---|
[23] | 136 | } |
---|
| 137 | } |
---|
| 138 | |
---|
| 139 | /** |
---|
| 140 | * Return the value of a parameter, if it exists. |
---|
| 141 | * |
---|
| 142 | * @access public |
---|
| 143 | * @param string $param Which parameter to return. |
---|
| 144 | * @return mixed Configured parameter value. |
---|
| 145 | */ |
---|
| 146 | function getParam($param) |
---|
| 147 | { |
---|
[136] | 148 | $app =& App::getInstance(); |
---|
| 149 | |
---|
[23] | 150 | if (isset($this->_params[$param])) { |
---|
| 151 | return $this->_params[$param]; |
---|
| 152 | } else { |
---|
[146] | 153 | $app->logMsg(sprintf('Parameter is not set: %s', $param), LOG_DEBUG, __FILE__, __LINE__); |
---|
[23] | 154 | return null; |
---|
| 155 | } |
---|
| 156 | } |
---|
| 157 | |
---|
| 158 | /** |
---|
| 159 | * Loads template from file to generate email body. |
---|
| 160 | * |
---|
| 161 | * @access public |
---|
| 162 | * @param string $template Filename of email template. |
---|
| 163 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 164 | * @since 28 Nov 2005 12:56:23 |
---|
| 165 | */ |
---|
| 166 | function setTemplate($template) |
---|
| 167 | { |
---|
[136] | 168 | $app =& App::getInstance(); |
---|
| 169 | |
---|
[23] | 170 | // Load file, using include_path. |
---|
| 171 | if (!$this->_template = file_get_contents($template, true)) { |
---|
[136] | 172 | $app->logMsg(sprintf('Email template file does not exist: %s', $template), LOG_ERR, __FILE__, __LINE__); |
---|
[23] | 173 | $this->_template = null; |
---|
| 174 | $this->_template_replaced = null; |
---|
| 175 | return false; |
---|
| 176 | } |
---|
[24] | 177 | // This could be a new template, so reset the _template_replaced. |
---|
[23] | 178 | $this->_template_replaced = null; |
---|
| 179 | return true; |
---|
| 180 | } |
---|
| 181 | |
---|
| 182 | /** |
---|
| 183 | * Loads template from string to generate email body. |
---|
| 184 | * |
---|
| 185 | * @access public |
---|
| 186 | * @param string $template Filename of email template. |
---|
| 187 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 188 | * @since 28 Nov 2005 12:56:23 |
---|
| 189 | */ |
---|
| 190 | function setString($string) |
---|
| 191 | { |
---|
[136] | 192 | $app =& App::getInstance(); |
---|
| 193 | |
---|
[23] | 194 | // Load file, using include_path. |
---|
[41] | 195 | if ('' == trim($string)) { |
---|
[136] | 196 | $app->logMsg(sprintf('Empty string provided.', null), LOG_ERR, __FILE__, __LINE__); |
---|
[23] | 197 | $this->_template_replaced = null; |
---|
| 198 | return false; |
---|
| 199 | } else { |
---|
[41] | 200 | $this->_template = $string; |
---|
[24] | 201 | // This could be a new template, so reset the _template_replaced. |
---|
[23] | 202 | $this->_template_replaced = null; |
---|
| 203 | return true; |
---|
| 204 | } |
---|
| 205 | } |
---|
[42] | 206 | |
---|
[23] | 207 | /** |
---|
| 208 | * Replace variables in template with argument data. |
---|
| 209 | * |
---|
| 210 | * @access public |
---|
| 211 | * @param array $replacements Array keys are the values to search for, array vales are the replacement values. |
---|
| 212 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 213 | * @since 28 Nov 2005 13:08:51 |
---|
| 214 | */ |
---|
| 215 | function replace($replacements) |
---|
| 216 | { |
---|
[136] | 217 | $app =& App::getInstance(); |
---|
| 218 | |
---|
[24] | 219 | // Ensure template exists. |
---|
[23] | 220 | if (!isset($this->_template)) { |
---|
[136] | 221 | $app->logMsg(sprintf('Cannot replace variables, no template defined.', null), LOG_ERR, __FILE__, __LINE__); |
---|
[42] | 222 | return false; |
---|
[23] | 223 | } |
---|
[42] | 224 | |
---|
[24] | 225 | // Ensure replacements argument is an array. |
---|
[23] | 226 | if (!is_array($replacements)) { |
---|
[136] | 227 | $app->logMsg(sprintf('Cannot replace variables, invalid replacements.', null), LOG_ERR, __FILE__, __LINE__); |
---|
[42] | 228 | return false; |
---|
[23] | 229 | } |
---|
[42] | 230 | |
---|
[23] | 231 | // Apply regex pattern to search elements. |
---|
| 232 | $search = array_keys($replacements); |
---|
[247] | 233 | array_walk($search, create_function('&$v', '$v = "{" . mb_strtoupper($v) . "}";')); |
---|
[23] | 234 | |
---|
[35] | 235 | // Replacement values. |
---|
[23] | 236 | $replace = array_values($replacements); |
---|
[42] | 237 | |
---|
[24] | 238 | // Search and replace all values at once. |
---|
[216] | 239 | $this->_template_replaced = str_replace($search, $replace, $this->_template); |
---|
[23] | 240 | } |
---|
| 241 | |
---|
| 242 | /** |
---|
| 243 | * Send email using PHP's mail() function. |
---|
| 244 | * |
---|
| 245 | * @access public |
---|
| 246 | * @param string $to |
---|
| 247 | * @param string $from |
---|
| 248 | * @param string $subject |
---|
| 249 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 250 | * @since 28 Nov 2005 12:56:09 |
---|
| 251 | */ |
---|
[38] | 252 | function send($to=null, $from=null, $subject=null, $headers=null) |
---|
[23] | 253 | { |
---|
[136] | 254 | $app =& App::getInstance(); |
---|
[282] | 255 | |
---|
[24] | 256 | // Use arguments if provided. |
---|
[23] | 257 | if (isset($to)) { |
---|
[42] | 258 | $this->setParam(array('to' => $to)); |
---|
[23] | 259 | } |
---|
| 260 | if (isset($from)) { |
---|
[42] | 261 | $this->setParam(array('from' => $from)); |
---|
[23] | 262 | } |
---|
| 263 | if (isset($subject)) { |
---|
[42] | 264 | $this->setParam(array('subject' => $subject)); |
---|
[23] | 265 | } |
---|
[38] | 266 | if (isset($headers)) { |
---|
[42] | 267 | $this->setParam(array('headers' => $headers)); |
---|
[38] | 268 | } |
---|
[36] | 269 | |
---|
[24] | 270 | // Ensure required values exist. |
---|
[43] | 271 | if (!isset($this->_params['subject'])) { |
---|
[364] | 272 | $app->logMsg('Cannot send email. SUBJECT not defined.', LOG_ERR, __FILE__, __LINE__); |
---|
[23] | 273 | return false; |
---|
[43] | 274 | } else if (!isset($this->_template)) { |
---|
[136] | 275 | $app->logMsg(sprintf('Cannot send email: "%s". Template not set.', $this->_params['subject']), LOG_ERR, __FILE__, __LINE__); |
---|
[43] | 276 | return false; |
---|
[23] | 277 | } else if (!isset($this->_params['to'])) { |
---|
[136] | 278 | $app->logMsg(sprintf('Cannot send email: "%s". TO not defined.', $this->_params['subject']), LOG_NOTICE, __FILE__, __LINE__); |
---|
[23] | 279 | return false; |
---|
| 280 | } else if (!isset($this->_params['from'])) { |
---|
[136] | 281 | $app->logMsg(sprintf('Cannot send email: "%s". FROM not defined.', $this->_params['subject']), LOG_ERR, __FILE__, __LINE__); |
---|
[23] | 282 | return false; |
---|
| 283 | } |
---|
| 284 | |
---|
[24] | 285 | // Wrap email text body, using _template_replaced if replacements have been used, or just a fresh _template if not. |
---|
[212] | 286 | $final_body = isset($this->_template_replaced) ? $this->_template_replaced : $this->_template; |
---|
| 287 | if (false !== $this->getParam('wrap')) { |
---|
| 288 | $final_body = wordwrap($final_body, $this->getParam('line_length'), $this->getParam('crlf')); |
---|
| 289 | } |
---|
[24] | 290 | |
---|
| 291 | // Ensure all placeholders have been replaced. Find anything with {...} characters. |
---|
[23] | 292 | if (preg_match('/({[^}]+})/', $final_body, $unreplaced_match)) { |
---|
[311] | 293 | $app->logMsg(sprintf('Cannot send email. At least one variable left unreplaced in template: %s', (isset($unreplaced_match[1]) ? $unreplaced_match[1] : '')), LOG_ERR, __FILE__, __LINE__); |
---|
[23] | 294 | return false; |
---|
| 295 | } |
---|
[42] | 296 | |
---|
[24] | 297 | // Final "to" header can have multiple addresses if in an array. |
---|
[23] | 298 | $final_to = is_array($this->_params['to']) ? join(', ', $this->_params['to']) : $this->_params['to']; |
---|
[42] | 299 | |
---|
[24] | 300 | // From headers are custom headers. |
---|
[38] | 301 | $headers = array('From' => $this->_params['from']); |
---|
| 302 | |
---|
| 303 | // Additional headers. |
---|
| 304 | if (isset($this->_params['headers']) && is_array($this->_params['headers'])) { |
---|
| 305 | $headers = array_merge($this->_params['headers'], $headers); |
---|
| 306 | } |
---|
[42] | 307 | |
---|
[38] | 308 | // Process headers. |
---|
| 309 | $final_headers = array(); |
---|
| 310 | foreach ($headers as $key => $val) { |
---|
| 311 | $final_headers[] = sprintf('%s: %s', $key, $val); |
---|
| 312 | } |
---|
[212] | 313 | $final_headers = join($this->getParam('crlf'), $final_headers); |
---|
[42] | 314 | |
---|
[24] | 315 | // This is the address where delivery problems are sent to. We must strip off everything except the local@domain part. |
---|
[212] | 316 | $envelope_sender_address = preg_replace('/^.*<?([^\s@\[\]<>()]+\@[A-Za-z0-9.-]{1,}\.[A-Za-z]{2,5})>?$/iU', '$1', $this->_params['from']); |
---|
| 317 | if ('' != $envelope_sender_address && $this->validEmail($envelope_sender_address)) { |
---|
| 318 | $envelope_sender_header = sprintf('-f %s', $envelope_sender_address); |
---|
| 319 | } else { |
---|
| 320 | $envelope_sender_header = ''; |
---|
| 321 | } |
---|
[42] | 322 | |
---|
[36] | 323 | // Check for mail header injection attacks. |
---|
[212] | 324 | $full_mail_content = join($this->getParam('crlf'), array($final_to, $this->_params['subject'], $final_body)); |
---|
[293] | 325 | if (preg_match("/(^|[\n\r])(Content-Type|MIME-Version|Content-Transfer-Encoding|Bcc|Cc)\s*:/i", $full_mail_content)) { |
---|
[136] | 326 | $app->logMsg(sprintf('Mail header injection attack in content: %s', $full_mail_content), LOG_WARNING, __FILE__, __LINE__); |
---|
[42] | 327 | sleep(3); |
---|
[36] | 328 | return false; |
---|
| 329 | } |
---|
[346] | 330 | |
---|
| 331 | // Send email without 5th parameter if safemode is enabled. |
---|
[345] | 332 | if (ini_get('safe_mode')) { |
---|
[346] | 333 | $ret = mb_send_mail($final_to, $this->_params['subject'], $final_body, $final_headers); |
---|
| 334 | } else { |
---|
[347] | 335 | $ret = mb_send_mail($final_to, $this->_params['subject'], $final_body, $final_headers, $envelope_sender_header); |
---|
| 336 | } |
---|
| 337 | |
---|
[346] | 338 | // Ensure message was successfully accepted for delivery. |
---|
| 339 | if ($ret) { |
---|
| 340 | $app->logMsg(sprintf('Email successfully sent to %s', $final_to), LOG_INFO, __FILE__, __LINE__); |
---|
| 341 | return true; |
---|
| 342 | } else { |
---|
| 343 | $app->logMsg(sprintf('Email failure with parameters: %s, %s, %s, %s', $final_to, $this->_params['subject'], str_replace("\r\n", '\r\n', $final_headers), $envelope_sender_header), LOG_NOTICE, __FILE__, __LINE__); |
---|
| 344 | return false; |
---|
[347] | 345 | } |
---|
[23] | 346 | } |
---|
[42] | 347 | |
---|
[23] | 348 | /** |
---|
| 349 | * Validates an email address based on the recommendations in RFC 3696. |
---|
[42] | 350 | * Is more loose than restrictive, to allow the many valid variants of |
---|
[23] | 351 | * email addresses while catching the most common mistakes. Checks an array too. |
---|
| 352 | * http://www.faqs.org/rfcs/rfc822.html |
---|
| 353 | * http://www.faqs.org/rfcs/rfc2822.html |
---|
| 354 | * http://www.faqs.org/rfcs/rfc3696.html |
---|
| 355 | * http://www.faqs.org/rfcs/rfc1035.html |
---|
| 356 | * |
---|
| 357 | * @access public |
---|
| 358 | * @param mixed $email Address to check, string or array. |
---|
| 359 | * @return bool Validity of address. |
---|
| 360 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
| 361 | * @since 30 Nov 2005 22:00:50 |
---|
| 362 | */ |
---|
| 363 | function validEmail($email) |
---|
| 364 | { |
---|
[136] | 365 | $app =& App::getInstance(); |
---|
| 366 | |
---|
[24] | 367 | // If an array, check values recursively. |
---|
[23] | 368 | if (is_array($email)) { |
---|
| 369 | foreach ($email as $e) { |
---|
| 370 | if (!$this->validEmail($e)) { |
---|
| 371 | return false; |
---|
| 372 | } |
---|
| 373 | } |
---|
| 374 | return true; |
---|
| 375 | } else { |
---|
[334] | 376 | // To be valid email address must match regex and fit within the length constraints. |
---|
[247] | 377 | if (preg_match($this->getParam('regex'), $email, $e_parts) && mb_strlen($e_parts[2]) < 64 && mb_strlen($e_parts[3]) < 255) { |
---|
[24] | 378 | return true; |
---|
| 379 | } else { |
---|
[136] | 380 | $app->logMsg(sprintf('Invalid email: %s', $email), LOG_INFO, __FILE__, __LINE__); |
---|
[23] | 381 | return false; |
---|
| 382 | } |
---|
| 383 | } |
---|
| 384 | } |
---|
| 385 | } |
---|
| 386 | |
---|
[345] | 387 | ?> |
---|