Add new translation functions.inc.php

Translate subject of information mail.
Notification mails are sent on the default language.
No mail is sent to the author witch are not done actions

git-svn-id: http://piwigo.org/svn/trunk@1908 68402e56-0260-453c-a942-63ccdbb3a9ee

3 files changed, 178 insertions, 83 deletions

diff --git a/include/functions.inc.php b/include/functions.inc.php
index 00a915d90..b69c88a71 100644
--- a/include/functions.inc.php
+++ b/include/functions.inc.php
@@ -1018,7 +1018,7 @@ function l10n($key)
 {
   global $lang, $conf;
 
-  if ($conf['debug_l10n'] and !isset($lang[$key]))
+  if ($conf['debug_l10n'] and !isset($lang[$key]) and !empty($key))
   {
     echo '[l10n] language key "'.$key.'" is not defined<br />';
   }
@@ -1047,6 +1047,69 @@ function l10n_dec($singular_fmt_key, $plural_fmt_key, $decimal)
           : $singular_fmt_key
         )), $decimal);
 }
+/*
+ * returns a single element to use with l10n_args
+ *
+ * @param string key: translation key
+ * @param array/string/../number args:
+ *   arguments to use on sprintf($key, args)
+ *   if args is a array, each values are used on sprintf
+ * @return string
+ */
+function get_l10n_args($key, $args)
+{
+  if (is_array($args))
+  {
+    $key_arg = array_merge(array($key), $args);
+  }
+  else
+  {
+    $key_arg = array($key,  $args);
+  }
+  return array('key_args' => $key_arg);
+}
+
+/*
+ * returns a string with formated with l10n_args elements
+ *
+ * @param element/array $key_args: element or array of l10n_args elements
+ * @param $sep: if $key_args is array, 
+ *   separator is used when translated l10n_args elements are concated
+ * @return string
+ */
+function l10n_args($key_args, $sep = "\n")
+{
+  if (is_array($key_args))
+  {
+    foreach ($key_args as $key => $element)
+    {
+      if (isset($result))
+      {
+        $result .= $sep;
+      }
+      else
+      {
+        $result = '';
+      }
+
+      if ($key === 'key_args')
+      {
+        array_unshift($element, l10n(array_shift($element)));
+        $result .= call_user_func_array('sprintf', $element);
+      }
+      else
+      {
+        $result .= l10n_args($element, $sep);
+      }
+    }
+  }
+  else
+  {
+    die('l10n_args: Invalid arguments');
+  }
+
+  return $result;
+}
 
 /**
  * Translate string in string ascii7bits
diff --git a/include/functions_comment.inc.php b/include/functions_comment.inc.php
index 9db0a4c17..1a894b69d 100644
--- a/include/functions_comment.inc.php
+++ b/include/functions_comment.inc.php
@@ -197,28 +197,27 @@ INSERT INTO '.COMMENTS_TABLE.'
       $del_url =
           get_absolute_root_url().'comments.php?delete='.$comm['id'];
 
-      $content =
-         'Author: '.$comm['author']."\n"
-        .'Comment: '.$comm['content']."\n"
-        .get_block_mail_admin_info()
-        .'Delete: '.$del_url."\n";
+      $keyargs_content = array
+      (
+        get_l10n_args('Author: %s', $comm['author']),
+        get_l10n_args('Comment: %s', $comm['content']),
+        get_l10n_args('', ''),
+        get_l10n_args('Delete: %s', $del_url)
+      );
 
       if ($comment_action!='validate')
       {
-        $content .=
-          'Validate: '
-          .get_absolute_root_url().'comments.php?validate='.$comm['id'];
+        $keyargs_content[] =
+          get_l10n_args('', '');
+        $keyargs_content[] =
+          get_l10n_args('Validate: %s',
+            get_absolute_root_url().'comments.php?validate='.$comm['id']);
       }
 
-      pwg_mail
+      pwg_mail_notification_admins
       (
-        format_email('administrators', get_webmaster_mail_address()),
-        array
-        (
-          'subject' => 'PWG comment by '.$comm['author'], 
-          'content' => $content,
-          'Bcc' => get_administrators_email()
-        )
+        get_l10n_args('Comment by %s', $comm['author']),
+        $keyargs_content
       );
     }
   }
diff --git a/include/functions_mail.inc.php b/include/functions_mail.inc.php
index 8080e2243..ffafc2305 100644
--- a/include/functions_mail.inc.php
+++ b/include/functions_mail.inc.php
@@ -154,61 +154,6 @@ function get_str_email_format($is_html)
   return ($is_html ? 'text/html' : 'text/plain');

 }

 
-/**
- * Returns email of all administrator
- *
- * @return string
- */
-function get_administrators_email()
-{
-  global $conf;
-
-  $result = array();
-
-  $query = '
-select
-  U.'.$conf['user_fields']['username'].' as username,
-  U.'.$conf['user_fields']['email'].' as mail_address
-from
-  '.USERS_TABLE.' as U,
-  '.USER_INFOS_TABLE.' as I
-where
-  I.user_id =  U.'.$conf['user_fields']['id'].' and
-  I.status in (\'webmaster\',  \'admin\') and

-  I.adviser = \'false\' and

-  '.$conf['user_fields']['email'].' is not null
-order by
-  username
-';
-
-  $datas = pwg_query($query);
-  if (!empty($datas))
-  {
-    while ($admin = mysql_fetch_array($datas))
-    {
-      if (!empty($admin['mail_address']))
-      {
-        array_push($result, format_email($admin['username'], $admin['mail_address']));
-      }
-    }
-  }
-
-  return $result;
-}
-
-/* Return a standard block useful for admin mail */
-function get_block_mail_admin_info()
-{
-  global $user;
-
-  return 

-    "\n"
-    .'Connected user: '.$user['username']."\n"
-    .'IP: '.$_SERVER['REMOTE_ADDR']."\n"
-    .'Browser: '.$_SERVER['HTTP_USER_AGENT']."\n"

-    ."\n";
-}
-
 /* 
  * Switch language to param language
  * All entries are push on language stack
@@ -292,23 +237,106 @@ function switch_lang_back()
     }
   }
 }
+
+/**
+ * Returns email of all administrator
+ *
+ * @return string
+ */
+/*
+ * send en notification email to all administrators

+ * if a administrator is doing action, 

+ * he's be removed to email list
+ *
+ * @param:
+ *   - keyargs_subject: mail subject on l10n_args format
+ *   - keyargs_content: mail content on l10n_args format
+ *
+ * @return boolean (Ok or not)
+ */
+function pwg_mail_notification_admins($keyargs_subject, $keyargs_content)
+{
+  global $conf, $user;
+  $return = true;
+
+  $admins = array();
+
+  $query = '
+select
+  U.'.$conf['user_fields']['username'].' as username,
+  U.'.$conf['user_fields']['email'].' as mail_address
+from
+  '.USERS_TABLE.' as U,
+  '.USER_INFOS_TABLE.' as I
+where
+  I.user_id =  U.'.$conf['user_fields']['id'].' and
+  I.status in (\'webmaster\',  \'admin\') and
+  I.adviser = \'false\' and
+  '.$conf['user_fields']['email'].' is not null and

+  I.user_id <> '.$user['id'].'
+order by
+  username
+';
+
+  $datas = pwg_query($query);
+  if (!empty($datas))
+  {
+    while ($admin = mysql_fetch_array($datas))
+    {
+      if (!empty($admin['mail_address']))
+      {
+        array_push($admins, format_email($admin['username'], $admin['mail_address']));
+      }
+    }
+  }
+

+  $keyargs_content_admin_info = array

+  (

+    get_l10n_args('Connected user: %s', $user['username']),

+    get_l10n_args('IP: %s', $_SERVER['REMOTE_ADDR']),

+    get_l10n_args('Browser: %s', $_SERVER['HTTP_USER_AGENT'])

+  );

+
+  switch_lang_to($conf['default_language']);
+
+  $return = pwg_mail
+  (
+    '',
+    array
+    (

+      'Bcc' => $admins,

+      'subject' => '['.$conf['gallery_title'].'] '.l10n_args($keyargs_subject),
+      'content' => 
+         l10n_args($keyargs_content)."\n\n"

+        .l10n_args($keyargs_content_admin_info)."\n",
+      'content_format' => 'text/plain'
+    )
+  ) and $return;
+
+  switch_lang_back();
+
+  return $return;
+}
 

 /*
  * send en email to user's group
  *
-  * @param:

+ * @param:

  *   - group_id: mail are sent to group with this Id

  *   - email_format: mail format

- *   - key_subject:  TODO Include translations 

+ *   - keyargs_subject: mail subject on l10n_args format

  *   - tpl_shortname: short template name without extension

  *   - assign_vars: array used to assign_vars to mail template

  *   - language_selected: send mail only to user with this selected language

-*/
+ *
+ * @return boolean (Ok or not)
+ */
 function pwg_mail_group(

-  $group_id, $email_format, $key_subject, 

+  $group_id, $email_format, $keyargs_subject, 

   $tpl_shortname, $assign_vars = array(), $language_selected = '')
 {
   global $conf;
+  $return = true;
 
   $query = '
 SELECT
@@ -342,7 +370,6 @@ WHERE
     }

   }

 
-
   foreach ($list as $elem)
   {
     $query = '
@@ -375,26 +402,30 @@ WHERE
       switch_lang_to($elem['language']);
 
       $mail_template = get_mail_template($email_format, $elem);
-      $mail_template->set_filename($tpl_shortname, $tpl_shortname.'.tpl');
+      $mail_template->set_filename($tpl_shortname, 

+        (IN_ADMIN ? 'admin/' : '').$tpl_shortname.'.tpl');
       $mail_template->assign_vars($assign_vars);
 
-      pwg_mail
+      $return = pwg_mail
       (
         '',
         array
-        (
-          'subject' => $key_subject,
+        (

+          'Bcc' => $Bcc,
+          'subject' => l10n_args($keyargs_subject),
           'email_format' => $email_format,
           'content' => $mail_template->parse($tpl_shortname, true),
           'content_format' => $email_format,
           'template' => $elem['template'],
           'theme' => $elem['theme']
         )
-      );
+      ) and $return;
 
       switch_lang_back();
     }
   }
+
+  return $return;
 }
 
 
@@ -412,7 +443,9 @@ WHERE
  *       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']]

+ *       o theme: template to use [default $conf['default_template']]
+ *
+ * @return boolean (Ok or not)
  */

 function pwg_mail($to, $args = array())
 {