Changeset 292 for branches/1.1dev/lib

Timestamp:

Dec 9, 2007 1:14:19 AM (16 years ago)

Author:

quinn

Message:

Back-ported the Email class to codebase v1.1dev.

File:

• branches/1.1dev/lib/Email.inc.php (copied) (copied from trunk/lib/Email.inc.php) (17 diffs)

branches/1.1dev/lib/Email.inc.php

@@ -7 +7 @@
  *
  * @author  Quinn Comendant <quinn@strangecode.com>
- * @version 1.0
+ * @version 1.0 - backported to codebase v1.1dev
  * 
  
@@ -13 +13 @@
 $email = new Email(array(
     'to' => array($frm['email'], 'q@lovemachine.local'),
-    'from' => sprintf('%s <%s>', $app->getParam('site_name'), $app->getParam('site_email')),
+    'from' => sprintf('%s <%s>', $CFG->site_name, $CFG->site_email),
     'subject' => 'Your account has been activated',
 ));
@@ -19 +19 @@
 // $email->setString('Or you can pass your message body as a string, also with {VARIABLES}.');
 $email->replace(array(
-    'site_name' => $app->getParam('site_name'),
-    'site_url' => $app->getParam('site_url'),
-    'username' => $frm['username'],
-    'password' => $frm['password1'],
+    'SITE_NAME' => $CFG->site_name,
+    'SITE_URL' => $CFG->site_url,
+    'USERNAME' => $frm['username'],
+    'PASSWORD' => $frm['password1'],
 ));
 if ($email->send()) {
-    $app->raiseMsg(sprintf(_("A confirmation email has been sent to %s."), $frm['email']), MSG_SUCCESS, __FILE__, __LINE__);
+    raiseMsg(sprintf(_("A confirmation email has been sent to %s."), $frm['email']), MSG_SUCCESS, __FILE__, __LINE__);
 } else {
-    $app->logMsg(sprintf('Error sending confirmation email to address %s', $frm['email']), LOG_NOTICE, __FILE__, __LINE__);
+    logMsg(sprintf('Error sending confirmation email to address %s', $frm['email']), LOG_NOTICE, __FILE__, __LINE__);
 }
 
@@ -99 +99 @@
     function setParam($params)
     {
-        $app =& App::getInstance();
-    
         if (isset($params) && is_array($params)) {
             // Enforce valid email addresses.
@@ -113 +111 @@
             $this->_params = array_merge($this->_params, $params);
         } else {
-            $app->logMsg(sprintf('Parameters are not an array: %s', $params), LOG_ERR, __FILE__, __LINE__);
+            logMsg(sprintf('Parameters are not an array: %s', $params), LOG_ERR, __FILE__, __LINE__);
         }
     }
@@ -126 +124 @@
     function getParam($param)
     {
-        $app =& App::getInstance();
-    
         if (isset($this->_params[$param])) {
             return $this->_params[$param];
         } else {
-            $app->logMsg(sprintf('Parameter is not set: %s', $param), LOG_DEBUG, __FILE__, __LINE__);
+            logMsg(sprintf('Parameter is not set: %s', $param), LOG_DEBUG, __FILE__, __LINE__);
             return null;
         }
@@ -146 +142 @@
     function setTemplate($template)
     {
-        $app =& App::getInstance();
-    
         // Load file, using include_path.
         if (!$this->_template = file_get_contents($template, true)) {
-            $app->logMsg(sprintf('Email template file does not exist: %s', $template), LOG_ERR, __FILE__, __LINE__);
+            logMsg(sprintf('Email template file does not exist: %s', $template), LOG_ERR, __FILE__, __LINE__);
             $this->_template = null;
             $this->_template_replaced = null;
@@ -170 +164 @@
     function setString($string)
     {
-        $app =& App::getInstance();
-    
         // Load file, using include_path.
         if ('' == trim($string)) {
-            $app->logMsg(sprintf('Empty string provided.', null), LOG_ERR, __FILE__, __LINE__);
+            logMsg(sprintf('Empty string provided.', null), LOG_ERR, __FILE__, __LINE__);
             $this->_template_replaced = null;
             return false;
@@ -195 +187 @@
     function replace($replacements)
     {
-        $app =& App::getInstance();
     
         // Ensure template exists.
         if (!isset($this->_template)) {
-            $app->logMsg(sprintf('Cannot replace variables, no template defined.', null), LOG_ERR, __FILE__, __LINE__);
+            logMsg(sprintf('Cannot replace variables, no template defined.', null), LOG_ERR, __FILE__, __LINE__);
             return false;
         }
@@ -205 +196 @@
         // Ensure replacements argument is an array.
         if (!is_array($replacements)) {
-            $app->logMsg(sprintf('Cannot replace variables, invalid replacements.', null), LOG_ERR, __FILE__, __LINE__);
+            logMsg(sprintf('Cannot replace variables, invalid replacements.', null), LOG_ERR, __FILE__, __LINE__);
             return false;
         }
@@ -232 +223 @@
     function send($to=null, $from=null, $subject=null, $headers=null)
     {
-        $app =& App::getInstance();
-
         // Use arguments if provided.
         if (isset($to)) {
@@ -250 +239 @@
         // Ensure required values exist.
         if (!isset($this->_params['subject'])) {
-            $app->logMsg(sprintf('Cannot send email to %s. SUBJECT not defined.', $this->_params['to']), LOG_ERR, __FILE__, __LINE__);
+            logMsg(sprintf('Cannot send email to %s. SUBJECT not defined.', $this->_params['to']), LOG_ERR, __FILE__, __LINE__);
             return false;
         } else if (!isset($this->_template)) {
-            $app->logMsg(sprintf('Cannot send email: "%s". Template not set.', $this->_params['subject']), LOG_ERR, __FILE__, __LINE__);
+            logMsg(sprintf('Cannot send email: "%s". Template not set.', $this->_params['subject']), LOG_ERR, __FILE__, __LINE__);
             return false;
         } else if (!isset($this->_params['to'])) {
-            $app->logMsg(sprintf('Cannot send email: "%s". TO not defined.', $this->_params['subject']), LOG_NOTICE, __FILE__, __LINE__);
+            logMsg(sprintf('Cannot send email: "%s". TO not defined.', $this->_params['subject']), LOG_NOTICE, __FILE__, __LINE__);
             return false;
         } else if (!isset($this->_params['from'])) {
-            $app->logMsg(sprintf('Cannot send email: "%s". FROM not defined.', $this->_params['subject']), LOG_ERR, __FILE__, __LINE__);
+            logMsg(sprintf('Cannot send email: "%s". FROM not defined.', $this->_params['subject']), LOG_ERR, __FILE__, __LINE__);
             return false;
         }
@@ -271 +260 @@
         // Ensure all placeholders have been replaced. Find anything with {...} characters.
         if (preg_match('/({[^}]+})/', $final_body, $unreplaced_match)) {
-            $app->logMsg(sprintf('Cannot send email. Variables left unreplaced in template: %s', (isset($unreplaced_match[1]) ? $unreplaced_match[1] : '')), LOG_ERR, __FILE__, __LINE__);
+            logMsg(sprintf('Cannot send email. Variables left unreplaced in template: %s', (isset($unreplaced_match[1]) ? $unreplaced_match[1] : '')), LOG_ERR, __FILE__, __LINE__);
             return false;
         }
@@ -304 +293 @@
         $full_mail_content = join($this->getParam('crlf'), array($final_to, $this->_params['subject'], $final_body));
         if (preg_match("/(^|[\n\r])(Content-Type|MIME-Version|Content-Transfer-Encoding|Bcc|Cc):/i", $full_mail_content)) {
-            $app->logMsg(sprintf('Mail header injection attack in content: %s', $full_mail_content), LOG_WARNING, __FILE__, __LINE__);
+            logMsg(sprintf('Mail header injection attack in content: %s', $full_mail_content), LOG_WARNING, __FILE__, __LINE__);
             sleep(3);
             return false;
@@ -311 +300 @@
         // Ensure message was successfully accepted for delivery.
         if (mb_send_mail($final_to, $this->_params['subject'], $final_body, $final_headers, $envelope_sender_header)) {
-            $app->logMsg(sprintf('Email successfully sent to %s', $final_to), LOG_INFO, __FILE__, __LINE__);
+            logMsg(sprintf('Email successfully sent to %s', $final_to), LOG_INFO, __FILE__, __LINE__);
             return true;
         } else {
-            $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__);
+            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__);
             return false;
         }
@@ -336 +325 @@
     function validEmail($email)
     {
-        $app =& App::getInstance();
-    
         // If an array, check values recursively.
         if (is_array($email)) {
@@ -351 +338 @@
                 return true;
             } else {
-                $app->logMsg(sprintf('Invalid email: %s', $email), LOG_INFO, __FILE__, __LINE__);
+                logMsg(sprintf('Invalid email: %s', $email), LOG_INFO, __FILE__, __LINE__);
                 return false;
             }