Changeset 1021 for trunk/include

Timestamp:

Feb 1, 2006, 11:07:26 PM (19 years ago)

Author:

plg

Message:

Applying coding style guidelines to r1018 and r1019.

New function get_webmaster_mail_address used in include/page_tail.php and
include/functions_mail.inc.php.

Nothing else than functions in include/functions*, init_conf_mail() was
useless in include/functions_mail.inc.php because $conf_mail is only used in
function pwg_mail.

bug fixed: files include/functions_mail.inc.php and
include/functions_notification.inc.php had been commited in DOS format! Unix
file format is the only file format authorized.

Location:

trunk/include

Files:

• config_default.inc.php (modified) (1 diff)
• functions.inc.php (modified) (1 diff)
• functions_mail.inc.php (modified) (5 diffs)
• functions_notification.inc.php (modified) (1 diff)
• page_tail.php (modified) (2 diffs)

trunk/include/config_default.inc.php

@@ -183 +183 @@
 $conf['mail_options'] = false;
 
-// Send bcc mail to webmaster
-// Set true for debug or test
+// send_bcc_mail_webmaster: send bcc mail to webmaster. Set true for debug
+// or test.
 $conf['send_bcc_mail_webmaster'] = false;
 

trunk/include/functions.inc.php

@@ -954 +954 @@
   return $search_clause;
 }
+
+/**
+ * Returns webmaster mail address depending on $conf['webmaster_id']
+ *
+ * @return string
+ */
+function get_webmaster_mail_address()
+{
+  global $conf;
+
+  $query = '
+SELECT '.$conf['user_fields']['email'].'
+  FROM '.USERS_TABLE.'
+  WHERE '.$conf['user_fields']['id'].' = '.$conf['webmaster_id'].'
+;';
+  list($email) = mysql_fetch_array(pwg_query($query));
+
+  return $email;
+}
 ?>

trunk/include/functions_mail.inc.php

@@ -27 +27 @@
 // +-----------------------------------------------------------------------+
 
-// Extract mail fonctions of password.php
-// And Modify pwg_mail (add pararameters + news fonctionnalities)
-// And var conf_mail, function init_conf_mail, function format_email
-
-define('PHPWG_ROOT_PATH','./');
-include_once(PHPWG_ROOT_PATH.'include/common.inc.php');
+/**
+ * - Extract mail fonctions of password.php
+ * - Modify pwg_mail (add pararameters + news fonctionnalities)
+ * - Var conf_mail, function init_conf_mail, function format_email
+ */
 
 // +-----------------------------------------------------------------------+
@@ -39 +38 @@
 
 /*
- * Initialization of global variable $conf_mail
+ * Returns an array of mail configuration parameters :
+ *
+ * - mail_options: see $conf['mail_options']
+ * - send_bcc_mail_webmaster: see $conf['send_bcc_mail_webmaster']
+ * - email_webmaster: mail corresponding to $conf['webmaster_id']
+ * - formated_email_webmaster: the name of webmaster is $conf['gallery_title']
+ * - text_footer: PhpWebGallery and version
+ *
+ * @return array
  */
-function init_conf_mail()
+function get_mail_configuration()
 {
-  global $conf, $conf_mail;
+  global $conf;
 
-  if (count($conf_mail) == 0)
-  {
-    $conf_mail['mail_options'] = $conf['mail_options'];
-    $conf_mail['send_bcc_mail_webmaster'] = ($conf['send_bcc_mail_webmaster'] == true ? true : false);
-    list($conf_mail['email_webmaster']) = mysql_fetch_array(pwg_query('select '.$conf['user_fields']['email'].' from '.USERS_TABLE.' where '.$conf['user_fields']['id'].' = '.$conf['webmaster_id'].';'));
-    $conf_mail['formated_email_webmaster'] = format_email($conf['gallery_title'], $conf_mail['email_webmaster']);
-    $conf_mail['text_footer'] = "\n\n-- \nPhpWebGallery ".($conf['show_version'] ? PHPWG_VERSION : '');
-  }
+  $conf_mail = array(
+    'mail_options' => $conf['mail_options'],
+    'send_bcc_mail_webmaster' => $conf['send_bcc_mail_webmaster'],
+    );
 
-  return true;
+  // we have webmaster id among user list, what's his email address ?
+  $conf_mail['email_webmaster'] = get_webmaster_mail_address();
+
+  // name of the webmaster is the title of the gallery
+  $conf_mail['formated_email_webmaster'] =
+    format_email($conf['gallery_title'], $conf_mail['email_webmaster']);
+
+  // what to display at the bottom of each mail ?
+  $conf_mail['text_footer'] =
+    "\n\n-- \nPhpWebGallery ".($conf['show_version'] ? PHPWG_VERSION : '');
+  
+  return $conf_mail;
 }
 
+/**
+ * Returns an email address with an associated real name
+ *
+ * @param string name
+ * @param string email
+ */
 function format_email($name, $email)
 {
   if (strpos($email, '<') === false)
+  {
     return $name.' <'.$email.'>';
+  }
   else
+  {
     return $name.$email;
+  }
 }
 
@@ -72 +96 @@
   global $conf, $conf_mail;
 
+  if (!isset($conf_mail))
+  {
+    $conf_mail = get_mail_configuration();
+  }
+
   $to = format_email('', $to);
 
-  if ($from =='')
+  if ($from == '')
+  {
     $from = $conf_mail['formated_email_webmaster'];
+  }
   else
+  {
     $from = format_email('', $from);
+  }
 
   $headers = 'From: '.$from."\n";
   $headers.= 'Reply-To: '.$from."\n";
+  
   if ($conf_mail['send_bcc_mail_webmaster'])
+  {
     $headers.= 'Bcc: '.$conf_mail['formated_email_webmaster']."\n";
-
-
-  $options = '-f '.$from;
-
+  }
+  
   $content = $infos;
   $content.= $conf_mail['text_footer'];
@@ -92 +125 @@
   if ($conf_mail['mail_options'])
   {
+    $options = '-f '.$from;
+    
     return mail($to, $subject, $content, $headers, $options);
   }
@@ -99 +134 @@
   }
 }
-
-// +-----------------------------------------------------------------------+
-// | Global Variables
-// +-----------------------------------------------------------------------+
-$conf_mail = array();
-
-init_conf_mail();
-
 ?>

trunk/include/functions_notification.inc.php

@@ -27 +27 @@
 
 
-// Extract news fonctions of feed.php
-
-define('PHPWG_ROOT_PATH','./');
-include_once(PHPWG_ROOT_PATH.'include/common.inc.php');
+/**
+ * Extract news fonctions of feed.php
+ */
 
 // +-----------------------------------------------------------------------+

trunk/include/page_tail.php

@@ -37 +37 @@
     'L_POWERED_BY'=>$lang['powered_by']
     ));
+
+//--------------------------------------------------------------------- contact
+
+if (!$user['is_the_guest'])
+{
+  $template->assign_block_vars(
+    'contact',
+    array(
+      'MAIL' => get_webmaster_mail_address()
+      )
+    );
+}
+
 //------------------------------------------------------------- generation time
 if ($conf['show_gt'])
@@ -63 +76 @@
 }
 
-//--------------------------------------------------------------------- contact
-
-if (!$user['is_the_guest'])
-{
-  $query = '
-SELECT '.$conf['user_fields']['email'].'
-  FROM '.USERS_TABLE.'
-  WHERE '.$conf['user_fields']['id'].' = '.$conf['webmaster_id'].'
-;';
-  list($email) = mysql_fetch_array(pwg_query($query));
-  
-  $template->assign_block_vars(
-    'contact',
-    array(
-      'MAIL' => $email
-      )
-    );
-}
-
 //
 // Generate the page