Changeset 1809

Timestamp:

02/13/07 00:21:23 (6 years ago)

Author:

rub

Message:

When not template are selected for mail, PWG uses default template..

Sent multi-part message in MIME format. (With only one part for the moment).

Improvement pwg_mail function.

Location:

trunk

Files:

• admin/include/functions_notification_by_mail.inc.php (modified) (4 diffs)
• admin/notification_by_mail.php (modified) (2 diffs)
• include/functions_mail.inc.php (modified) (11 diffs)
• include/picture_comment.inc.php (modified) (1 diff)
• password.php (modified) (1 diff)
• register.php (modified) (1 diff)
• template/yoga/mail/text/html/header.tpl (modified) (1 diff)
• template/yoga/mail/text/plain/header.tpl (modified) (1 diff)

trunk/admin/include/functions_notification_by_mail.inc.php

@@ -258 +258 @@
  * Return none
  */
-function set_user_on_env_nbm($user_id, $is_action_send)
+function set_user_on_env_nbm(&$nbm_user, $is_action_send)
 {
   global $user, $lang, $lang_info, $env_nbm;
 
   $user = array();
-  $user['id'] = $user_id;
+  $user['id'] = $nbm_user['user_id'];
   $user = array_merge($user, getuserdata($user['id'], true));
 
@@ -287 +287 @@
   if ($is_action_send)
   {
-    $env_nbm['mail_template'] = get_mail_template($env_nbm['email_format']);
+    $nbm_user['template'] = $user['template'];
+    $nbm_user['theme'] = $user['theme'];
+    $env_nbm['mail_template'] =
+      get_mail_template($env_nbm['email_format'], 
+        array('template' => $nbm_user['template'], 'theme' => $nbm_user['theme']));
     $env_nbm['mail_template']->set_filename('notification_by_mail', 'admin/notification_by_mail.tpl');
   }
@@ -432 +436 @@
       {
         // set env nbm user
-        set_user_on_env_nbm($nbm_user['user_id'], true);
+        set_user_on_env_nbm($nbm_user, true);
 
         $subject = '['.$conf['gallery_title'].']: '.($is_subscribe ? l10n('nbm_object_subscribe'): l10n('nbm_object_unsubscribe'));
@@ -446 +450 @@
         );
 
-        if (pwg_mail(
+        if (pwg_mail
+            (
               format_email($nbm_user['username'], $nbm_user['mail_address']),
-              $env_nbm['send_as_mail_formated'],
-              $subject,
-              $env_nbm['mail_template']->parse('notification_by_mail', true),
-              $env_nbm['email_format'], $env_nbm['email_format']
-              ))
+              array
+              (
+                'from' => $env_nbm['send_as_mail_formated'],
+                'subject' => $subject,
+                'email_format' => $env_nbm['email_format'],
+                'content' => $env_nbm['mail_template']->parse('notification_by_mail', true),
+                'content_format' => $env_nbm['email_format'],
+                'template' => $nbm_user['template'],
+                'theme' => $nbm_user['theme']
+              )
+            ))
         {
           inc_mail_sent_success($nbm_user);

trunk/admin/notification_by_mail.php

@@ -274 +274 @@
 
           // set env nbm user
-          set_user_on_env_nbm($nbm_user['user_id'], $is_action_send);
+          set_user_on_env_nbm($nbm_user, $is_action_send);
 
           if ($is_action_send)
@@ -378 +378 @@
               );
 
-              if (pwg_mail(
+              if (pwg_mail
+                  (
                     format_email($nbm_user['username'], $nbm_user['mail_address']),
-                    $env_nbm['send_as_mail_formated'],
-                    $subject,
-                    $env_nbm['mail_template']->parse('notification_by_mail', true),
-                    $env_nbm['email_format'], $env_nbm['email_format']
-                    ))
+                    array
+                    (
+                      'from' => $env_nbm['send_as_mail_formated'],
+                      'subject' => $subject,
+                      'email_format' => $env_nbm['email_format'],
+                      'content' => $env_nbm['mail_template']->parse('notification_by_mail', true),
+                      'content_format' => $env_nbm['email_format'],
+                      'template' => $nbm_user['template'],
+                      'theme' => $nbm_user['theme']
+                    )
+                  ))
               {
                 inc_mail_sent_success($nbm_user);

trunk/include/functions_mail.inc.php

@@ -65 +65 @@
     format_email($conf['gallery_title'], $conf_mail['email_webmaster']);
 
+  $conf_mail['boundary_key'] = generate_key(32);
+
   return $conf_mail;
 }
@@ -98 +100 @@
 
 /**
- * Returns an new mail template
- *
- * @param none
- */
-function get_mail_template($email_format)
-{
-  global $user;
-
-  $mail_template = new Template(PHPWG_ROOT_PATH.'template/'.$user['template'], $user['theme']);
-  $mail_template->set_rootdir(PHPWG_ROOT_PATH.'template/'.$user['template'].'/mail/'.$email_format);
+ * Return an completed array template/theme
+ * completed with $conf['default_template']
+ *
+ * @params:
+ *   - args: incompleted array of template/theme
+ *       o template: template to use [default $conf['default_template']]
+ *       o theme: template to use [default $conf['default_template']]
+ */
+function get_array_template_theme($args = array())
+{
+  global $conf;
+
+  $res = array();
+  
+  if (empty($args['template']) or empty($args['theme']))
+  {
+    list($res['template'], $res['theme']) = explode('/', $conf['default_template']);
+  }
+
+  if (!empty($args['template']))
+  {
+    $res['template'] = $args['template'];
+  }
+
+  if (!empty($args['theme']))
+  {
+    $res['theme'] = $args['theme'];
+  }
+
+  return $res;
+}
+
+/**
+ * Return an new mail template
+ *
+ * @params:
+ *   - email_format: mail format
+ *   - args: function params of mail function:
+ *       o template: template to use [default $conf['default_template']]
+ *       o theme: template to use [default $conf['default_template']]
+ */
+function get_mail_template($email_format, $args = array())
+{
+  $args = get_array_template_theme($args);
+
+  $mail_template = new Template(PHPWG_ROOT_PATH.'template/'.$args['template'], $args['theme']);
+  $mail_template->set_rootdir(PHPWG_ROOT_PATH.'template/'.$args['template'].'/mail/'.$email_format);
 
   return $mail_template;
@@ -124 +163 @@
 /**
  * sends an email, using PhpWebGallery specific informations
- */
-function pwg_mail($to, $from = '', $subject = 'PhpWebGallery', $infos = '', $format_infos = 'text/plain', $email_format = null)
-{
-  global $conf, $conf_mail, $lang_info, $page, $user;
-
-  $cvt7b_subject = str_translate_to_ascii7bits($subject);
+ *
+ * @param:
+ *   - to: Receiver, or receivers of the mail.
+ *   - args: function params of mail function:
+ *       o from: sender [default value webmaster email]
+ *       o subject  [default value 'PhpWebGallery']
+ *       o content: content of mail    [default value '']
+ *       o content_format: format of mail content  [default value 'text/plain']
+ *       o email_format: global mail format  [default value $conf_mail['default_email_format']]
+ *       o template: template to use [default $conf['default_template']]
+ *       o theme: template to use [default $conf['default_template']]
+ */
+//function pwg_mail($to, $from = '', $subject = 'PhpWebGallery', $infos = '', $infos_format = 'text/plain', $email_format = null)
+function pwg_mail($to, $args = array())
+{
+  global $conf, $conf_mail, $lang_info, $page;
 
   if (!isset($conf_mail))
@@ -136 +185 @@
   }
 
-  if (is_null($email_format))
-  {
-    $email_format = $conf_mail['default_email_format'];
-  }
-
-  if (($format_infos == 'text/html') and ($email_format == 'text/plain'))
+  if (empty($args['email_format']))
+  {
+    $args['email_format'] = $conf_mail['default_email_format'];
+  }
+
+  // Compute root_path in order have complete path
+  if ($args['email_format'] == 'text/html')
+  {
+    set_make_full_url();
+  }
+
+  $to = format_email('', $to);
+
+  if (empty($args['from']))
+  {
+    $args['from'] = $conf_mail['formated_email_webmaster'];
+  }
+  else
+  {
+    $args['from'] = format_email('', $args['from']);
+  }
+
+  if (empty($args['subject']))
+  {
+    $args['subject'] = 'PhpWebGallery';
+  }
+  $cvt7b_subject = str_translate_to_ascii7bits($args['subject']);
+
+  if (!isset($args['content']))
+  {
+    $args['content'] = '';
+  }
+
+  if (empty($args['content_format']))
+  {
+    $args['content_format'] = 'text/plain';
+  }
+
+  if (($args['content_format'] == 'text/html') and ($args['email_format'] == 'text/plain'))
   {
     // Todo find function to convert html text to plain text
@@ -147 +229 @@
   }
 
-  // Compute root_path in order have complete path
-  if ($email_format == 'text/html')
-  {
-    set_make_full_url();
-  }
-
-  $to = format_email('', $to);
-
-  if ($from == '')
-  {
-    $from = $conf_mail['formated_email_webmaster'];
-  }
-  else
-  {
-    $from = format_email('', $from);
-  }
-
-  $headers = 'From: '.$from."\n";
-  $headers.= 'Reply-To: '.$from."\n";
-  $headers.= 'Content-Type: '.$email_format.';format=flowed;charset="'.$lang_info['charset'].'";';
-  $headers.= 'reply-type=original'."\n";
+  $args = array_merge($args, get_array_template_theme($args));
+
+  $headers = 'From: '.$args['from']."\n";
+  $headers.= 'Reply-To: '.$args['from']."\n";
+  $headers.= 'Content-Type: multipart/alternative;'."\n";
+  $headers.= '  boundary="---='.$conf_mail['boundary_key'].'";'."\n";
+  $headers.= '  reply-type=original'."\n";
   $headers.= 'MIME-Version: 1.0'."\n";
 
@@ -177 +245 @@
   $content = '';
 
-  if (!isset($conf_mail[$email_format][$lang_info['charset']][$user['template']][$user['theme']]))
+  if (!isset($conf_mail[$args['email_format']][$lang_info['charset']][$args['template']][$args['theme']]))
   {
     if (!isset($mail_template))
     {
-      $mail_template = get_mail_template($email_format);
+      $mail_template = get_mail_template($args['email_format']);
     }
 
@@ -190 +258 @@
       array(
         //Header
+        'BOUNDARY_KEY' => $conf_mail['boundary_key'],
+        'CONTENT_TYPE' => $args['email_format'],
         'CONTENT_ENCODING' => $lang_info['charset'],
         'LANG' => $lang_info['code'],
@@ -208 +278 @@
         ));
 
-    if ($email_format == 'text/html')
+    if ($args['email_format'] == 'text/html')
     {
       $old_root = $mail_template->root;
@@ -218 +288 @@
       }
 
-      $mail_template->root = PHPWG_ROOT_PATH.'template/'.$user['template'].'/theme/'.$user['theme'];
+      $mail_template->root = PHPWG_ROOT_PATH.'template/'.$args['template'].'/theme/'.$args['theme'];
       if (is_file($mail_template->root.'/mail-css.tpl'))
       {
@@ -236 +306 @@
 
     // what are displayed on the header of each mail ?
-    $conf_mail[$email_format]
+    $conf_mail[$args['email_format']]
       [$lang_info['charset']]
-      [$user['template']][$user['theme']]['header'] =
+      [$args['template']][$args['theme']]['header'] =
         $mail_template->parse('mail_header', true);
 
     // what are displayed on the footer of each mail ?
-    $conf_mail[$email_format]
+    $conf_mail[$args['email_format']]
       [$lang_info['charset']]
-      [$user['template']][$user['theme']]['footer'] =
+      [$args['template']][$args['theme']]['footer'] =
         $mail_template->parse('mail_footer', true);
   }
 
-  $content.= $conf_mail[$email_format]
+  // Header
+  $content.= $conf_mail[$args['email_format']]
               [$lang_info['charset']]
-              [$user['template']][$user['theme']]['header'];
-
-  if (($format_infos == 'text/plain') and ($email_format == 'text/html'))
-  {
-    $content.= '<pre>'.htmlentities($infos).'</pre>';
+              [$args['template']][$args['theme']]['header'];
+
+  // Content
+  if (($args['content_format'] == 'text/plain') and ($args['email_format'] == 'text/html'))
+  {
+    $content.= '<p>'.nl2br(htmlentities($args['content'])).'</p>';
   }
   else
   {
-    $content.= $infos;
-  }
-
-  $content.= $conf_mail[$email_format]
+    $content.= $args['content'];
+  }
+
+  // Footer
+  $content.= $conf_mail[$args['email_format']]
               [$lang_info['charset']]
-              [$user['template']][$user['theme']]['footer'];
-  
+              [$args['template']][$args['theme']]['footer'];
+
+  // Close boundary
+  $content.= "\n".'-----='.$conf_mail['boundary_key'].'--'."\n";
+
    // Undo Compute root_path in order have complete path
-  if ($email_format == 'text/html')
+  if ($args['email_format'] == 'text/html')
   {
     unset_make_full_url();
@@ -276 +352 @@
     @mkdir(PHPWG_ROOT_PATH.'testmail');
     $filename = PHPWG_ROOT_PATH.'testmail/mail.'.$user['username'];
-    if ($format_infos == 'text/plain')
+    if ($args['content_format'] == 'text/plain')
     {
       $filename .= '.txt';

trunk/include/picture_comment.inc.php

@@ -224 +224 @@
           .'comments.php?validate='.$comm['id'];
       }
-      pwg_mail( get_webmaster_mail_address(), '',
-          'PWG comment by '.$comm['author'],
-          $content
-          );
+      pwg_mail(get_webmaster_mail_address(),
+        array('subject' => 'PWG comment by '.$comm['author'], 'content' => $content));
     }
   }

trunk/password.php

@@ -85 +85 @@
           ;
 
-        if (pwg_mail($row['email'], '', l10n('password updated'), $infos))
+        if (pwg_mail($row['email'],
+              array('subject' => l10n('password updated'), 'content' => $infos)))
         {
           $data =

trunk/register.php

@@ -71 +71 @@
         .l10n('admin').': '.$admin_url;
 
-      pwg_mail( get_webmaster_mail_address(), '',
-          'PWG '.l10n('register_title').' '.$username,
-          $content
-          );
+      pwg_mail(get_webmaster_mail_address(),
+        array
+        (
+          'subject' => 'PWG '.l10n('register_title').' '.$username,
+          'content' => $content
+        )
+      );
     }
     redirect(make_index_url());

trunk/template/yoga/mail/text/html/header.tpl

@@ -1 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-            "http://www.w3.org/TR/html4/loose.dtd">
+-----={BOUNDARY_KEY}
+Content-Type: {CONTENT_TYPE}; charset={CONTENT_ENCODING};
+Content-Transfer-Encoding: 8bit
+
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <html lang="{LANG}" dir="{DIR}">
 <head>

trunk/template/yoga/mail/text/plain/header.tpl

@@ -1 @@
-{FAKE_SIMULATE_EMPTY_FILE}
+-----={BOUNDARY_KEY}
+Content-Type: {CONTENT_TYPE}; charset={CONTENT_ENCODING}; format=flowed;
+Content-Transfer-Encoding: 8bit