[NBM] Step 4: Screen NBM is available

o Add news parameters
  o Add file functions_notification_by_mail.inc.php in order to use in future, these functions on php file of subscribe/unsubscribe
  o Write a little html help file

+ improve mass_update in order to used binary fields (used collate and SHOW COLUMNS FROM)
 


git-svn-id: http://piwigo.org/svn/trunk@1105 68402e56-0260-453c-a942-63ccdbb3a9ee
This commit is contained in:
rub
2006-03-26 22:06:20 +00:00
parent 1b1400c3c8
commit d63d25a61d
11 changed files with 718 additions and 200 deletions
+5 -1
View File
@@ -743,7 +743,7 @@ UPDATE '.$tablename.'
{
// creation of the temporary table
$query = '
DESCRIBE '.$tablename.'
SHOW FULL COLUMNS FROM '.$tablename.'
;';
$result = pwg_query($query);
$columns = array();
@@ -762,6 +762,10 @@ DESCRIBE '.$tablename.'
{
$column.= " default '".$row['Default']."'";
}
if (isset($row['Collation']))
{
$column.= " collate '".$row['Collation']."'";
}
array_push($columns, $column);
}
}
@@ -0,0 +1,168 @@
<?php
// +-----------------------------------------------------------------------+
// | 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 |
// +-----------------------------------------------------------------------+
// | branch : BSF (Best So Far)
// | file : $RCSfile$
// | last update : $Date: 2006-03-23 02:49:04 +0100 (jeu., 23 mars 2006) $
// | last modifier : $Author: rvelices $
// | revision : $Revision: 1094 $
// +-----------------------------------------------------------------------+
// | This program is free software; you can redistribute it and/or modify |
// | it under the terms of the GNU General Public License as published by |
// | the Free Software Foundation |
// | |
// | This program is distributed in the hope that it will be useful, but |
// | WITHOUT ANY WARRANTY; without even the implied warranty of |
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
// | General Public License for more details. |
// | |
// | You should have received a copy of the GNU General Public License |
// | along with this program; if not, write to the Free Software |
// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
// | USA. |
// +-----------------------------------------------------------------------+
/*
* Search an available check_key
*
* It's a copy of function find_available_feed_id
*
* @return string nbm identifier
*/
function find_available_check_key()
{
while (true)
{
$key = generate_key(128);
$query = '
select
count(*)
from
'.USER_MAIL_NOTIFICATION_TABLE.'
where
check_key = \''.$key.'\';';
list($count) = mysql_fetch_row(pwg_query($query));
if ($count == 0)
{
return $key;
}
}
}
/*
* Add quote to all elements of check_key_list
*
* @return quoted check key list
*/
function quote_check_key_list($check_key_list = array())
{
return array_map(create_function('$s', 'return \'\\\'\'.$s.\'\\\'\';'), $check_key_list);
}
/*
* Subscribe or unsubscribe notification by mail
*
* is_subscribe define if action=subscribe or unsubscribe
* check_key list where action will be done
*
* @return updated data count
*/
function do_subscribe_unsubcribe_notification_by_mail($is_subscribe = false, $check_key_list = array())
{
global $page;
$updated_data_count = 0;
if ($is_subscribe)
{
$msg_info = l10n('nbm_user_change_enabled_true');
}
else
{
$msg_info = l10n('nbm_user_change_enabled_false');
}
if (count($check_key_list) != 0)
{
$quoted_check_key_list = quote_check_key_list($check_key_list);
$query = '
select
N.check_key, U.username, U.mail_address
from
'.USER_MAIL_NOTIFICATION_TABLE.' as N,
'.USERS_TABLE.' as U
where
N.user_id = U.id and
N.enabled = \''.boolean_to_string(!$is_subscribe).'\' and
check_key in ('.implode(",", $quoted_check_key_list).')
order by
username;';
$result = pwg_query($query);
if (!empty($result))
{
$updates = array();
$enabled_value = boolean_to_string($is_subscribe);
while ($row = mysql_fetch_array($result))
{
array_push
(
$updates,
array
(
'check_key' => $row['check_key'],
'enabled' => $enabled_value
)
);
$updated_data_count += 1;
array_push($page['infos'], sprintf($msg_info, $row['username'], $row['mail_address']));
}
mass_updates(
USER_MAIL_NOTIFICATION_TABLE,
array(
'primary' => array('check_key'),
'update' => array('enabled')
),
$updates
);
}
}
array_push($page['infos'], sprintf(l10n('nbm_user_change_enabled_updated_data_count'), $updated_data_count));
return $updated_data_count;
}
/*
* Unsubscribe notification by mail
*
* check_key list where action will be done
*
* @return updated data count
*/
function unsubcribe_notification_by_mail($check_key_list = array())
{
return do_subscribe_unsubcribe_notification_by_mail(false, $check_key_list);
}
/*
* Subscribe notification by mail
*
* check_key list where action will be done
*
* @return updated data count
*/
function subcribe_notification_by_mail($check_key_list = array())
{
return do_subscribe_unsubcribe_notification_by_mail(true, $check_key_list);
}
?>
+324 -159
View File
@@ -36,7 +36,7 @@ if (!defined('PHPWG_ROOT_PATH'))
}
include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
include_once(PHPWG_ROOT_PATH.'admin/include/functions_notification_by_mail.inc.php');
include_once(PHPWG_ROOT_PATH.'include/common.inc.php');
include_once(PHPWG_ROOT_PATH.'include/functions_notification.inc.php');
include_once(PHPWG_ROOT_PATH.'include/functions_mail.inc.php');
@@ -49,38 +49,34 @@ check_status(ACCESS_ADMINISTRATOR);
// +-----------------------------------------------------------------------+
// | functions |
// +-----------------------------------------------------------------------+
/*
* Search an available check_key
*
* It's a copy of function find_available_feed_id
*
* @return string feed identifier
*/
function find_available_check_key()
{
while (true)
{
$key = generate_key(128);
$query = '
select
count(*)
from
'.USER_MAIL_NOTIFICATION_TABLE.'
where
check_key = \''.$key.'\';';
list($count) = mysql_fetch_row(pwg_query($query));
if ($count == 0)
{
return $key;
}
/*
* Get the authorized_status for each tab
* return corresponding status
*/
function get_tab_status($mode)
{
$result = ACCESS_WEBMASTER;
switch ($mode)
{
case 'param':
case 'subscribe' :
$result = ACCESS_WEBMASTER;
break;
case 'send' :
$result = ACCESS_ADMINISTRATOR;
break;
default:
$result = ACCESS_WEBMASTER;
break;
}
return $result;
}
/*
* Updating News users
* Inserting News users
*/
function update_data_user_mail_notification()
function insert_new_data_user_mail_notification()
{
global $conf, $page;
@@ -94,6 +90,7 @@ where
trim(mail_address) = \'\';';
pwg_query($query);
// null mail_address are not selected in the list
$query = '
select
u.id user_id, u.username, u.mail_address
@@ -110,57 +107,108 @@ order by
if (mysql_num_rows($result) > 0)
{
$inserts = array();
$check_key_list = array();
while ($row = mysql_fetch_array($result))
{
array_push($inserts, array('user_id' => $row['user_id'],
'check_key' => find_available_check_key(),
'enabled' => ($conf['default_value_user_mail_notification_enabled'] == true ? 'true' : 'false')));
// Calculate key
$row['check_key'] = find_available_check_key();
// Save key
array_push($check_key_list, $row['check_key']);
// Insert new rows
array_push
(
$inserts,
array
(
'user_id' => $row['user_id'],
'check_key' => $row['check_key'],
'enabled' => 'false' // By default if false, set to true with specific functions
)
);
array_push($page['infos'], sprintf(l10n('nbm_User %s [%s] added.'), $row['username'], $row['mail_address']));
}
// Insert new rows
mass_inserts(USER_MAIL_NOTIFICATION_TABLE, array('user_id', 'check_key', 'enabled'), $inserts);
// Update field enabled with specific function
do_subscribe_unsubcribe_notification_by_mail
(
($conf['default_value_user_mail_notification_enabled'] == true ? true : false),
$check_key_list
);
}
}
/*
* Updating News users
* Send mail for notification to all users
* Return list of "treated/selected" users
*/
function send_all_user_mail_notification()
function do_action_send_mail_notification($action = 'prepare', $check_key_list = array(), $customize_mail_content = '')
{
global $conf, $conf_mail, $page, $user, $lang_info, $lang;
global $conf, $page, $user, $lang_info, $lang;
list($dbnow) = mysql_fetch_row(pwg_query('SELECT NOW();'));
$return_list = array();
$is_action_send = ($action == 'send');
$quoted_check_key_list = quote_check_key_list($check_key_list);
if (count($quoted_check_key_list) != 0 )
{
$query_and_check_key = ' and
check_key in ('.implode(",", $quoted_check_key_list).') ';
}
else
{
$query_and_check_key = '';
}
if (isset($customize_mail_content))
{
$customize_mail_content = $conf['nbm_complementary_mail_content'];
}
// disabled and null mail_address are not selected in the list
$query = '
select
N.user_id, U.username, U.mail_address, N.last_send
N.user_id, N.check_key, U.username, U.mail_address, N.last_send
from
'.USER_MAIL_NOTIFICATION_TABLE.' as N,
'.USERS_TABLE.' as U
where
N.user_id = U.id and
N.enabled = \'true\' and
U.mail_address is not null
U.mail_address is not null'.$query_and_check_key.'
order by
user_id;';
username;';
$result = pwg_query($query);
if (mysql_num_rows($result) > 0)
{
$error_on_mail_count = 0;
$sended_mail_count = 0;
$sent_mail_count = 0;
$datas = array();
// Save $user, $lang_info and $lang arrays (include/user.inc.php has been executed)
$sav_mailtousers_user = $user;
$sav_mailtousers_lang_info = $lang_info;
$sav_mailtousers_lang = $lang;
// Save message info and error in the original language
$msg_info = l10n('nbm_Mail sended to %s [%s].');
$msg_info = l10n('nbm_Mail sent to %s [%s].');
$msg_error = l10n('nbm_Error when sending email to %s [%s].');
// Last Language
$last_mailtousers_language = $user['language'];
if ($is_action_send)
{
// Init mail configuration
$send_as_name = ((isset($conf['nbm_send_mail_as']) and !empty($conf['nbm_send_mail_as'])) ? $conf['nbm_send_mail_as'] : $conf['gallery_title']);
$send_as_mail_address = get_webmaster_mail_address();
$send_as_mail_formated = format_email($send_as_name, $send_as_mail_address);
}
while ($row = mysql_fetch_array($result))
{
$user = array();
@@ -186,35 +234,51 @@ order by
$news = news($row['last_send'], $dbnow);
if (count($news) > 0)
{
$subject = '['.$conf['gallery_title'].']: '.l10n('nbm_New elements added');
$message .= sprintf(l10n('nbm_Hello %s'), $row['username']).",\n\n";
array_push($return_list, $row);
if (!is_null($row['last_send']))
$message .= sprintf(l10n('nbm_New elements were added between %s and %s:'), $row['last_send'], $dbnow);
else
$message .= sprintf(l10n('nbm_New elements were added on %s:'), $dbnow);
$message .= "\n";
foreach ($news as $line)
if ($is_action_send)
{
$message .= ' o '.$line."\n";
}
$subject = '['.$conf['gallery_title'].']: '.l10n('nbm_ContentObject');
$message .= sprintf(l10n('nbm_ContentHello'), $row['username']).",\n\n";
$message .= "\n".sprintf(l10n('nbm_Go to %s %s.'), $conf['gallery_title'], $conf['gallery_url'])."\n\n";
$message .= "\n".sprintf(l10n('nbm_To unsubscribe send a message to %s.'), $conf_mail['email_webmaster'])."\n\n";
if (!is_null($row['last_send']))
$message .= sprintf(l10n('nbm_ContentNewElementsBetween'), $row['last_send'], $dbnow);
else
$message .= sprintf(l10n('nbm_ContentNewElements'), $dbnow);
if (pwg_mail(format_email($row['username'], $row['mail_address']), '', $subject, $message))
{
$sended_mail_count += 1;
array_push($page['infos'], sprintf($msg_info, $row['username'], $row['mail_address']));
$data = array('user_id' => $row['user_id'],
'last_send' => $dbnow);
array_push($datas, $data);
}
else
{
$error_on_mail_count += 1;
array_push($page['errors'], sprintf($msg_error, $row['username'], $row['mail_address']));
if ($conf['nbm_send_detailed_content'])
{
$message .= ":\n";
foreach ($news as $line)
{
$message .= ' o '.$line."\n";
}
$message .= "\n";
}
else
{
$message .= ".\n";
}
$message .= sprintf(l10n('nbm_ContentGoTo'), $conf['gallery_title'], $conf['gallery_url'])."\n\n";
$message .= $customize_mail_content."\n\n";
$message .= l10n('nbm_ContentByeBye')."\n ".$send_as_name."\n\n";
$message .= "\n".sprintf(l10n('nbm_ContentUnsubscribe'), $send_as_mail_address)."\n\n";
if (pwg_mail(format_email($row['username'], $row['mail_address']), $send_as_mail_formated, $subject, $message))
{
$sent_mail_count += 1;
array_push($page['infos'], sprintf($msg_info, $row['username'], $row['mail_address']));
$data = array('user_id' => $row['user_id'],
'last_send' => $dbnow);
array_push($datas, $data);
}
else
{
$error_on_mail_count += 1;
array_push($page['errors'], sprintf($msg_error, $row['username'], $row['mail_address']));
}
}
}
}
@@ -224,39 +288,43 @@ order by
$lang_info = $sav_mailtousers_lang_info;
$lang = $sav_mailtousers_lang;
mass_updates(
USER_MAIL_NOTIFICATION_TABLE,
array(
'primary' => array('user_id'),
'update' => array('last_send')
),
$datas
);
if ($is_action_send)
{
mass_updates(
USER_MAIL_NOTIFICATION_TABLE,
array(
'primary' => array('user_id'),
'update' => array('last_send')
),
$datas
);
if ($error_on_mail_count != 0)
{
array_push($page['errors'], sprintf(l10n('nbm_%d mails were not sended.'), $error_on_mail_count));
}
else
{
if ($sended_mail_count == 0)
array_push($page['infos'], l10n('nbm_No mail to send.'));
if ($error_on_mail_count != 0)
{
array_push($page['errors'], sprintf(l10n('nbm_%d mails were not sent.'), $error_on_mail_count));
}
else
array_push($page['infos'], sprintf(l10n('nbm_%d mails were sended.'), $sended_mail_count));
{
if ($sent_mail_count == 0)
array_push($page['infos'], l10n('nbm_No mail to send.'));
else
array_push($page['infos'], sprintf(l10n('nbm_%d mails were sent.'), $sent_mail_count));
}
}
}
else
{
array_push($page['errors'], l10n('nbm_No user to send notifications by mail.'));
if ($is_action_send)
{
array_push($page['errors'], l10n('nbm_No user to send notifications by mail.'));
}
}
return $return_list;
}
// +-----------------------------------------------------------------------+
// | Main |
// +-----------------------------------------------------------------------+
update_data_user_mail_notification();
//send_all_user_mail_notification();
if (!isset($_GET['mode']))
{
$page['mode'] = 'send';
@@ -266,27 +334,132 @@ else
$page['mode'] = $_GET['mode'];
}
// +-----------------------------------------------------------------------+
// | Check Access and exit when user status is not ok |
// +-----------------------------------------------------------------------+
check_status(get_tab_status($page['mode']));
// +-----------------------------------------------------------------------+
// | Insert new users with mails |
// +-----------------------------------------------------------------------+
if (!isset($_POST) or (count($_POST) ==0))
{
// No insert data in post mode
insert_new_data_user_mail_notification();
}
// +-----------------------------------------------------------------------+
// | Treatment of tab post |
// +-----------------------------------------------------------------------+
switch ($page['mode'])
{
case 'param' :
{
$updated_param_count = 0;
// Update param
$result = pwg_query('select param, value from '.CONFIG_TABLE.' where param like \'nbm\\_%\'');
while ($row = mysql_fetch_array($result))
{
if (isset($_POST['param_submit']))
{
if (isset($_POST[$row['param']]))
{
$value = $_POST[$row['param']];
$query = '
update
'.CONFIG_TABLE.'
set
value = \''. str_replace("\'", "''", $value).'\'
where
param = \''.$row['param'].'\';';
pwg_query($query);
$updated_param_count += 1;
}
}
$conf[$row['param']] = $row['value'];
// if the parameter is present in $_POST array (if a form is submited), we
// override it with the submited value
if (isset($_POST[$row['param']]))
{
$conf[$row['param']] = stripslashes($_POST[$row['param']]);
}
// If the field is true or false, the variable is transformed into a
// boolean value.
if ($conf[$row['param']] == 'true' or $conf[$row['param']] == 'false')
{
$conf[$row['param']] = get_boolean($conf[$row['param']]);
}
}
if ($updated_param_count != 0)
{
array_push($page['infos'], sprintf(l10n('nbm_updated_param_count'), $updated_param_count));
}
}
case 'subscribe' :
{
if (isset($_POST['falsify']) and isset($_POST['cat_true']))
{
unsubcribe_notification_by_mail($_POST['cat_true']);
}
else
if (isset($_POST['trueify']) and isset($_POST['cat_false']))
{
subcribe_notification_by_mail($_POST['cat_false']);
}
break;
}
case 'send' :
{
if (isset($_POST['send_submit']) and isset($_POST['send_selection']) and isset($_POST['send_customize_mail_content']))
{
do_action_send_mail_notification('send', $_POST['send_selection'], $_POST['send_customize_mail_content']);
}
}
}
// +-----------------------------------------------------------------------+
// | template initialization |
// +-----------------------------------------------------------------------+
$template->set_filenames(
array(
$template->set_filenames
(
array
(
'double_select' => 'admin/double_select.tpl',
'notification_by_mail'=>'admin/notification_by_mail.tpl'
)
);
)
);
$base_url = get_root_url().'admin.php';
$template->assign_vars(
array(
$template->assign_vars
(
array
(
'U_TABSHEET_TITLE' => l10n('nbm_'.$page['mode'].'_mode'),
'U_HELP' => add_url_params(get_root_url().'/popuphelp.php', array('page'=>'notification_by_mail') ),
'U_PARAM_MODE' => add_url_params($base_url.get_query_string_diff(array('mode')), array('mode'=>'param') ),
'U_SUBSCRIBE_MODE' => add_url_params($base_url.get_query_string_diff(array('mode')), array('mode'=>'subscribe') ),
'U_SEND_MODE' => add_url_params($base_url.get_query_string_diff(array('mode')), array('mode'=>'send') ),
'U_HELP' => add_url_params(get_root_url().'/popuphelp.php', array('page' => 'notification_by_mail')),
'F_ACTION'=> $base_url.get_query_string_diff(array())
));
)
);
if (is_autorize_status(ACCESS_WEBMASTER))
{
$template->assign_block_vars
(
'header_link',
array
(
'PARAM_MODE' => add_url_params($base_url.get_query_string_diff(array('mode', 'select')), array('mode' => 'param')),
'SUBSCRIBE_MODE' => add_url_params($base_url.get_query_string_diff(array('mode', 'select')), array('mode' => 'subscribe')),
'SEND_MODE' => add_url_params($base_url.get_query_string_diff(array('mode', 'select')), array('mode' => 'send'))
)
);
}
switch ($page['mode'])
{
@@ -295,16 +468,19 @@ switch ($page['mode'])
$template->assign_block_vars(
$page['mode'],
array(
//'HISTORY_YES'=>$history_yes
'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']
));
break;
}
case 'subscribe' :
{
$template->assign_block_vars(
$page['mode'],
array(
//'HISTORY_YES'=>$history_yes
));
$template->assign_vars(
@@ -314,82 +490,71 @@ switch ($page['mode'])
)
);
$query = '
select
N.check_key, N.enabled, U.username, U.mail_address
from
'.USER_MAIL_NOTIFICATION_TABLE.' as N,
'.USERS_TABLE.' as U
where
N.user_id = U.id
order by
username;';
/* $template->assign_block_vars(
$blockname,
array('SELECTED'=>$selected,
'VALUE'=>$category['id'],
'OPTION'=>$option
));*/
$template->assign_block_vars(
'category_option_true',
array('SELECTED'=>'',
'VALUE'=>'rub',
'OPTION'=>'rub [rub@phpwebgallery.net]'
));
$result = pwg_query($query);
if (!empty($result))
{
while ($row = mysql_fetch_array($result))
{
$template->assign_block_vars(
(get_boolean($row['enabled']) ? 'category_option_true' : 'category_option_false'),
array('SELECTED' => '',
'VALUE' => $row['check_key'],
'OPTION' => $row['username'].'['.$row['mail_address'].']'
));
}
}
break;
}
case 'send' :
{
$template->assign_block_vars(
$page['mode'],
array(
//'HISTORY_YES'=>$history_yes
));
$template->assign_block_vars($page['mode'], array());
$template->assign_vars(
array(
'L_CAT_OPTIONS_TRUE' => l10n('nbm_send_col'),
'L_CAT_OPTIONS_FALSE' => l10n('nbm_nosend_col')
)
);
$data_rows = do_action_send_mail_notification('prepare');
if (count($data_rows) == 0)
{
$template->assign_block_vars($page['mode'].'.send_empty', array());
}
else
{
$template->assign_block_vars(
$page['mode'].'.send_data',
array(
// 'URL_CHECK_ALL' => add_url_params($base_url.get_query_string_diff(array('select')), array('select' => 'all')),
// 'URL_UNCHECK_ALL' => add_url_params($base_url.get_query_string_diff(array('select')), array('select' => 'none')),
'CUSTOMIZE_MAIL_CONTENT' => isset($_POST['send_customize_mail_content']) ? $_POST['send_customize_mail_content'] : $conf['nbm_complementary_mail_content']
));
/* $template->assign_block_vars(
$blockname,
array('SELECTED'=>$selected,
'VALUE'=>$category['id'],
'OPTION'=>$option
));*/
$template->assign_block_vars(
'category_option_true',
array('SELECTED'=>' selected="selected"',
'VALUE'=>'rub',
'OPTION'=>'rub [2006-03-20 23:35:23]'
));
foreach ($data_rows as $num => $local_user)
$template->assign_block_vars(
$page['mode'].'.send_data.user_send_mail',
array(
'CLASS' => ($num % 2 == 1) ? 'row2' : 'row1',
'ID' => $local_user['check_key'],
'CHECKED' => isset($_POST['send_uncheck_all']) ? '' : 'checked="checked"',
'USERNAME'=> $local_user['username'],
'EMAIL' => $local_user['mail_address'],
'LAST_SEND'=> $local_user['last_send']
));
}
break;
}
}
// +-----------------------------------------------------------------------+
// | infos & errors display |
// +-----------------------------------------------------------------------+
/*echo '<pre>';
if (count($page['errors']) != 0)
{
echo "\n\nErrors:\n";
foreach ($page['errors'] as $error)
{
echo $error."\n";
}
}
if (count($page['infos']) != 0)
{
echo "\n\nInformations:\n";
foreach ($page['infos'] as $info)
{
echo $info."\n";
}
}
echo '</pre>';
*/
// +-----------------------------------------------------------------------+
// | Sending html code |
// +-----------------------------------------------------------------------+