Issue 0000598: NBM: Add new informations

Notification by mail:
Add new informations about last categories and last images like new feature of RSS notification.

2 parts:
  - Possibility to send HTML mail
  - Include last categories and last images on HTML format into notification mail


ccs & HTML experts! Please! Check, fix, improve and enhance HTML mail content!


git-svn-id: http://piwigo.org/svn/trunk@1784 68402e56-0260-453c-a942-63ccdbb3a9ee
This commit is contained in:
rub
2007-02-06 22:55:12 +00:00
parent 5f94909b42
commit e517cfad64
18 changed files with 581 additions and 231 deletions
@@ -2,8 +2,8 @@
// +-----------------------------------------------------------------------+
// | PhpWebGallery - a PHP based picture gallery |
// | Copyright (C) 2002-2003 Pierrick LE GALL - pierrick@phpwebgallery.net |
// | Copyright (C) 2003-2006 PhpWebGallery Team - http://phpwebgallery.net |
// | Copyright (C) 2006 Ruben ARNAUD - team@phpwebgallery.net |
// | Copyright (C) 2003-2007 PhpWebGallery Team - http://phpwebgallery.net |
// | Copyright (C) 2006-2007 Ruben ARNAUD - team@phpwebgallery.net |
// +-----------------------------------------------------------------------+
// | branch : BSF (Best So Far)
// | file : $RCSfile$
@@ -203,6 +203,7 @@ function begin_users_env_nbm($is_to_send_mail = false)
if ($is_to_send_mail)
{
// Init mail configuration
$env_nbm['email_format'] = get_str_email_format($conf['nbm_send_html_mail']);
$env_nbm['send_as_name'] = ((isset($conf['nbm_send_mail_as']) and !empty($conf['nbm_send_mail_as'])) ? $conf['nbm_send_mail_as'] : $conf['gallery_title']);
$env_nbm['send_as_mail_address'] = get_webmaster_mail_address();
$env_nbm['send_as_mail_formated'] = format_email($env_nbm['send_as_name'], $env_nbm['send_as_mail_address']);
@@ -229,14 +230,34 @@ function end_users_env_nbm()
$user = $env_nbm['save_user'];
$lang_info = $env_nbm['save_lang_info'];
$lang = $env_nbm['save_lang'];
if ($env_nbm['is_to_send_mail'])
{
unset($env_nbm['email_format']);
unset($env_nbm['send_as_name']);
unset($env_nbm['send_as_mail_address']);
unset($env_nbm['send_as_mail_formated']);
// Don t unset counter
//unset($env_nbm['error_on_mail_count']);
//unset($env_nbm['sent_mail_count']);
unset($env_nbm['msg_info']);
unset($env_nbm['msg_error']);
}
unset($env_nbm['save_user']);
unset($env_nbm['save_lang_info']);
unset($env_nbm['save_lang']);
unset($env_nbm['last_language']);
unset($env_nbm['is_to_send_mail']);
}
/*
* Set user_id on nbm enviromnent
* Set user on nbm enviromnent
*
* Return none
*/
function set_user_id_on_env_nbm($user_id)
function set_user_on_env_nbm($user_id, $is_action_send)
{
global $user, $lang, $lang_info, $env_nbm;
@@ -260,6 +281,24 @@ function set_user_id_on_env_nbm($user_id)
trigger_action('loading_lang');
@include(get_language_filepath('local.lang.php'));
}
if ($is_action_send)
{
$env_nbm['mail_template'] = get_mail_template($env_nbm['email_format']);
$env_nbm['mail_template']->set_filename('notification_by_mail', 'admin/notification_by_mail.tpl');
}
}
/*
* Unset user on nbm enviromnent
*
* Return none
*/
function unset_user_on_env_nbm()
{
global $env_nbm;
unset($env_nbm['mail_template']);
}
/*
@@ -299,36 +338,40 @@ function display_counter_info()
if ($env_nbm['error_on_mail_count'] != 0)
{
array_push($page['errors'], sprintf(l10n('nbm_msg_no_mail_to_send'), $env_nbm['error_on_mail_count']));
array_push($page['errors'], l10n_dec('nbm_msg_n_mail_not_send', 'nbm_msg_n_mails_not_send', $env_nbm['error_on_mail_count']));
if ($env_nbm['sent_mail_count'] != 0)
array_push($page['infos'], sprintf(l10n('nbm_msg_n_mails_sent'), $env_nbm['sent_mail_count']));
array_push($page['infos'], l10n_dec('nbm_msg_n_mail_sent', 'nbm_msg_n_mails_sent', $env_nbm['sent_mail_count']));
}
else
{
if ($env_nbm['sent_mail_count'] == 0)
array_push($page['infos'], l10n('nbm_no_mail_to_send'));
else
array_push($page['infos'], sprintf(l10n('nbm_msg_n_mails_sent'), $env_nbm['sent_mail_count']));
array_push($page['infos'], l10n_dec('nbm_msg_n_mail_sent', 'nbm_msg_n_mails_sent', $env_nbm['sent_mail_count']));
}
}
function get_mail_content_subscribe_unsubcribe($nbm_user)
function assign_vars_nbm_mail_content($nbm_user)
{
global $env_nbm;
$content = "\n\n\n";
set_make_full_url();
$content .= "___________________________________________________\n\n";
$content .= sprintf(l10n('nbm_content_unsubscribe_link'), add_url_params(get_root_url().'nbm.php', array('unsubscribe' => $nbm_user['check_key'])))."\n";
$content .= sprintf(l10n('nbm_content_subscribe_link'), add_url_params(get_root_url().'nbm.php', array('subscribe' => $nbm_user['check_key'])))."\n";
$content .= sprintf(l10n('nbm_content_subscribe_unsubscribe_contact'), $env_nbm['send_as_mail_address'])."\n";
$content .= "___________________________________________________\n\n\n\n";
$env_nbm['mail_template']->assign_vars
(
array
(
'USERNAME' => $nbm_user['username'],
'SEND_AS_NAME' => $env_nbm['send_as_name'],
'UNSUBSCRIBE_LINK' => add_url_params(get_root_url().'nbm.php', array('unsubscribe' => $nbm_user['check_key'])),
'SUBSCRIBE_LINK' => add_url_params(get_root_url().'nbm.php', array('subscribe' => $nbm_user['check_key'])),
'CONTACT_EMAIL' => $env_nbm['send_as_mail_address']
)
);
unset_make_full_url();
return $content;
}
/*
@@ -386,28 +429,27 @@ function do_subscribe_unsubcribe_notification_by_mail($is_admin_request, $is_sub
if ($nbm_user['mail_address'] != '')
{
// set env nbm user
set_user_id_on_env_nbm($nbm_user['user_id']);
$message = '';
set_user_on_env_nbm($nbm_user['user_id'], true);
$subject = '['.$conf['gallery_title'].']: '.($is_subscribe ? l10n('nbm_object_subcribe'): l10n('nbm_object_unsubcribe'));
$message .= sprintf(l10n('nbm_content_hello'), $nbm_user['username']).",\n\n";
if ($is_subscribe)
{
$message .= l10n($is_admin_request ? 'nbm_content_subscribe_by_admin' : 'nbm_content_subscribe_by_himself');
}
else
{
$message .= l10n($is_admin_request ? 'nbm_content_unsubscribe_by_admin' : 'nbm_content_unsubscribe_by_himself');
}
// Assign current var for nbm mail
assign_vars_nbm_mail_content($nbm_user);
$message .= "\n\n";
$message .= l10n('nbm_content_byebye')."\n ".$env_nbm['send_as_name']."\n\n";
$section_action_by = ($is_subscribe ? 'subscribe_by_' : 'unsubscribe_by_');
$section_action_by .= ($is_admin_request ? 'admin' : 'himself');
$env_nbm['mail_template']->assign_block_vars
(
$section_action_by, array('DUMMY' => 'dummy')
);
$message .= get_mail_content_subscribe_unsubcribe($nbm_user);
if (pwg_mail(format_email($nbm_user['username'], $nbm_user['mail_address']), $env_nbm['send_as_mail_formated'], $subject, $message))
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']
))
{
inc_mail_sent_success($nbm_user);
}
@@ -416,6 +458,10 @@ function do_subscribe_unsubcribe_notification_by_mail($is_admin_request, $is_sub
inc_mail_sent_failed($nbm_user);
$do_update = false;
}
// unset env nbm user
unset_user_on_env_nbm();
}
if ($do_update)
@@ -456,10 +502,13 @@ function do_subscribe_unsubcribe_notification_by_mail($is_admin_request, $is_sub
}
array_push($page['infos'], sprintf(l10n('nbm_user_change_enabled_updated_data_count'), $updated_data_count));
array_push($page['infos'], l10n_dec('nbm_user_change_enabled_updated_data_count', 'nbm_users_change_enabled_updated_data_count', $updated_data_count));
if ($error_on_updated_data_count != 0)
{
array_push($page['errors'], sprintf(l10n('nbm_user_change_enabled_error_on_updated_data_count'), $error_on_updated_data_count));
array_push($page['errors'],
l10n_dec('nbm_user_change_enabled_error_on_updated_data_count',
'nbm_users_change_enabled_error_on_updated_data_count',
$error_on_updated_data_count));
}
return $check_key_treated;
+96 -21
View File
@@ -84,7 +84,10 @@ function do_timeout_treatment($post_keyname, $check_key_treated = array())
$_POST[$post_keyname] = array_diff($_POST[$post_keyname], $check_key_treated);
$must_repost = true;
array_push($page['errors'], sprintf(l10n('nbm_background_treatment_redirect'), $time_refresh));
array_push($page['errors'],
l10n_dec('nbm_background_treatment_redirect_second',
'nbm_background_treatment_redirect_seconds',
$time_refresh));
}
}
@@ -270,17 +273,17 @@ function do_action_send_mail_notification($action = 'list_to_send', $check_key_l
}
// set env nbm user
set_user_id_on_env_nbm($nbm_user['user_id']);
set_user_on_env_nbm($nbm_user['user_id'], $is_action_send);
if ($is_action_send)
{
set_make_full_url();
// Fill return list of "treated" check_key for 'send'
array_push($return_list, $nbm_user['check_key']);
$message = '';
if ($conf['nbm_send_detailed_content'])
{
$news = news($nbm_user['last_send'], $dbnow);
$news = news($nbm_user['last_send'], $dbnow, false, $conf['nbm_send_html_mail']);
$exist_data = count($news) > 0;
}
else
@@ -291,35 +294,96 @@ function do_action_send_mail_notification($action = 'list_to_send', $check_key_l
if ($exist_data)
{
$subject = '['.$conf['gallery_title'].']: '.l10n('nbm_object_news');
$message .= sprintf(l10n('nbm_content_hello'), $nbm_user['username']).",\n\n";
// Assign current var for nbm mail
assign_vars_nbm_mail_content($nbm_user);
$end_punct = ($conf['nbm_send_detailed_content'] ? ':' : '.');
if (!is_null($nbm_user['last_send']))
$message .= sprintf(l10n('nbm_content_new_elements_between'), $nbm_user['last_send'], $dbnow);
{
$env_nbm['mail_template']->assign_block_vars
(
'content_new_elements_between',
array
(
'DATE_BETWEEN_1' => $nbm_user['last_send'],
'DATE_BETWEEN_2' => $dbnow,
'END_PUNCT' => $end_punct
)
);
}
else
$message .= sprintf(l10n('nbm_content_new_elements'), $dbnow);
{
$env_nbm['mail_template']->assign_block_vars
(
'content_new_elements_single',
array
(
'DATE_SINGLE' => $dbnow,
'END_PUNCT' => $end_punct
)
);
}
if ($conf['nbm_send_detailed_content'])
{
$message .= ":\n";
foreach ($news as $line)
foreach ($news as $data)
{
$message .= ' o '.$line."\n";
$env_nbm['mail_template']->assign_block_vars
(
'global_new_line.new_line', array('DATA' => $data)
);
}
$message .= "\n";
}
else
if (!empty($customize_mail_content))
{
$message .= ".\n";
$env_nbm['mail_template']->assign_block_vars
(
'custom', array('CUSTOMIZE_MAIL_CONTENT' => $customize_mail_content)
);
}
$message .= sprintf(l10n('nbm_content_goto'), $conf['gallery_title'], $conf['gallery_url'])."\n\n";
$message .= $customize_mail_content."\n\n";
$message .= l10n('nbm_content_byebye')."\n ".$env_nbm['send_as_name']."\n\n";
if ($conf['nbm_send_html_mail'] and $conf['nbm_send_recent_post_dates'])
{
$recent_post_dates = get_recent_post_dates(7, 5, 9);
foreach ($recent_post_dates as $date_detail)
{
$env_nbm['mail_template']->assign_block_vars
(
'recent_post.recent_post_block',
array
(
'TITLE' => get_title_recent_post_date($date_detail),
'HTML_DATA' => get_html_description_recent_post_date($date_detail)
)
);
}
}
$message .= get_mail_content_subscribe_unsubcribe($nbm_user);
$env_nbm['mail_template']->assign_block_vars
(
'goto',
array
(
'GALLERY_TITLE' => $conf['gallery_title'],
'GALLERY_URL' => $conf['gallery_url']
)
);
if (pwg_mail(format_email($nbm_user['username'], $nbm_user['mail_address']), $env_nbm['send_as_mail_formated'], $subject, $message))
$env_nbm['mail_template']->assign_block_vars
(
'byebye', array('SEND_AS_NAME' => $env_nbm['send_as_name'])
);
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']
))
{
inc_mail_sent_success($nbm_user);
@@ -331,6 +395,8 @@ function do_action_send_mail_notification($action = 'list_to_send', $check_key_l
{
inc_mail_sent_failed($nbm_user);
}
unset_make_full_url();
}
}
else
@@ -341,6 +407,9 @@ function do_action_send_mail_notification($action = 'list_to_send', $check_key_l
array_push($return_list, $nbm_user);
}
}
// unset env nbm user
unset_user_on_env_nbm();
}
// Restore nbm environment
@@ -437,7 +506,9 @@ where
}
}
array_push($page['infos'], sprintf(l10n('nbm_updated_param_count'), $updated_param_count));
array_push($page['infos'],
l10n_dec('nbm_updated_param_count', 'nbm_updated_params_count',
$updated_param_count));
// Reload conf with new values
load_conf_from_db('param like \'nbm\\_%\'');
@@ -542,10 +613,14 @@ switch ($page['mode'])
$template->assign_block_vars(
$page['mode'],
array(
'SEND_HTML_MAIL_YES' => ($conf['nbm_send_html_mail'] ? 'checked="checked"' : ''),
'SEND_HTML_MAIL_NO' => (!$conf['nbm_send_html_mail'] ? 'checked="checked"' : ''),
'SEND_MAIL_AS' => $conf['nbm_send_mail_as'],
'SEND_DETAILED_CONTENT_YES' => ($conf['nbm_send_detailed_content'] ? 'checked="checked"' : ''),
'SEND_DETAILED_CONTENT_NO' => (!$conf['nbm_send_detailed_content'] ? 'checked="checked"' : ''),
'COMPLEMENTARY_MAIL_CONTENT' => $conf['nbm_complementary_mail_content']
'COMPLEMENTARY_MAIL_CONTENT' => $conf['nbm_complementary_mail_content'],
'SEND_RECENT_POST_DATES_YES' => ($conf['nbm_send_recent_post_dates'] ? 'checked="checked"' : ''),
'SEND_RECENT_POST_DATES_NO' => (!$conf['nbm_send_recent_post_dates'] ? 'checked="checked"' : '')
));
break;
}