'fieldset',
'#title' => t('General settings'),
'#weight' => -10,
);
$form['general']['notifications_sendself'] = array(
'#type' => 'checkbox',
'#title' => t('Notify poster of own posts'),
'#default_value' => variable_get('notifications_sendself', 0),
'#description' => t("Notifies a node poster about their own posts. Useful principally during testing. Default is OFF."),
);
$form['general']['notifications_send_immediate'] = array(
'#title' => t('Immediate sending'),
'#type' => 'checkbox',
'#default_value' => variable_get('notifications_send_immediate', 0),
'#description' => t('Notifications are usually queued to be sent on cron process later. Checking this option will cause immediate notifications to be sent right away, instead of being queued. This will produce more timely notifications for sites with a small number of users. Not recommended for sites with a large number of users. This may not work for AJAX forms and notifications will be queued anyway.'),
);
$form['general']['notifications_sender'] = array(
'#title' => t('Notifications Sender'),
'#type' => 'radios',
'#options' => array(
t('No one (All notifications will appear as coming from the web site)'),
t('User name, site data (Only the user name will be used)'),
t('Full user data (User name and available user information)'),
),
'#default_value' => variable_get('notifications_sender', 0),
'#description' => t('Use the site information as the sender for notification messages or use account data from the user causing the event. WARNING: Selecting the last option (Full user data) may disclose private information to subscribers like the user e-mail address.'),
);
// Logging settings
$period = array(0 => t('Disabled')) + drupal_map_assoc(array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200, 4838400, 9676800), 'format_interval');
$form['general']['notifications_log'] = array(
'#title' => t('Logging'),
'#type' => 'select',
'#options' => $period,
'#default_value' => variable_get('notifications_log', 0),
'#description' => t('If enabled all notifications will be logged and kept for the specified time after they\'re processed.'),
);
// Default options
$form['defaults'] = array(
'#type' => 'fieldset',
'#title' => t('Default settings'),
);
$form['defaults']['notifications_default_send_interval'] = array(
'#type' => 'select',
'#title' => t('Default send interval'),
'#options' => _notifications_send_intervals(),
'#default_value' => variable_get('notifications_default_send_interval', 0),
);
// Processing limits
$limit = variable_get('notifications_process_limit', array('row' => 0, 'message' => 0, 'percent' => 0, 'time' => 0));
$form['notifications_process_limit'] = array(
'#type' => 'fieldset',
'#title' => t('Limits for queue processing'),
'#tree' => TRUE,
'#description' => t('These are the limits for each cron run on queue processing. The process will stop when it first meets any of them. Set to 0 for no limit.'),
'#collapsible' => TRUE, '#collapsed' => TRUE,
);
$form['notifications_process_limit']['row'] = array(
'#title' => t('Number of rows'),
'#type' => 'textfield',
'#size' => 10,
'#default_value' => $limit['row'],
);
$form['notifications_process_limit']['message'] = array(
'#title' => t('Number of messages sent'),
'#type' => 'textfield',
'#size' => 10,
'#default_value' => $limit['message'],
);
$form['notifications_process_limit']['time'] = array(
'#title' => t('Time (seconds)'),
'#type' => 'textfield',
'#size' => 10,
'#default_value' => $limit['time'],
);
$form['notifications_process_limit']['percent'] = array(
'#title' => t('Time (% of cron time)'),
'#type' => 'textfield',
'#size' => 10,
'#default_value' => $limit['percent'],
'#description' => t('Maximum percentage of cron time the process may use.'),
);
return system_settings_form($form);
}
/**
* Send intervals administration
*/
function notifications_send_intervals_form() {
// Collect information about digesting methods and print out some help
$form['digest'] = array(
'#title' => t('Digest formats'),
'#type' => 'fieldset',
'#description' => t('These are the digest formats available for each interval.')
);
$digest_methods[''] = t('None');
foreach (notifications_digest_method() as $type => $method) {
$digest_methods[$type] = $method['name'];
$rows[] = array($method['name'], $method['description']);
}
$form['digest']['info'] = array('#value' => theme('table', array(), $rows));
// Build options. Need some complex formatting.
$units = array(
60 => t('Minutes'),
60*60 => t('Hours'),
24*60*60 => t('Days'),
);
$form['intervals'] = array(
'#type' => 'fieldset',
'#title' => t('Send intervals'),
'#tree' => TRUE,
//'#theme' => 'notifications_send_intervals',
'#description' => t('To delete an interval, set the time unit and the name empty. If the time is negative, notifications will never be sent.'),
);
$intervals = _notifications_send_intervals() + array('new1' => '', 'new2' => '');
// We need to use different indexes (not time value) as negative ones won't work
$index = 0;
$index_name = $time_index = array();
foreach ($intervals as $time => $name) {
// Store index => name mapping
$index_options[$index] = '';
$time_index[$time] = $index;
// Calculate value and unit
$current = $number = 0;
if (!is_numeric($time)) {
$number = $unit = '';
}
elseif ($time >= 0) {
foreach (array_reverse(array_keys($units)) as $unit) {
if ($time % $unit == 0) {
$current = $unit;
$number = $time / $unit;
break;
}
}
}
else {
// May be -1 for 'Never'
$number = $time;
$unit = '';
}
$form['intervals'][$index]['time'] = array(
'#default_value' => $number,
'#type' => 'textfield',
'#size' => 2,
);
$form['intervals'][$index]['unit'] = array(
'#type' => 'select',
'#options' => array('' => '') + $units,
'#default_value' => $unit,
);
$form['intervals'][$index]['name'] = array(
'#type' => 'textfield',
'#default_value' => $name,
'#size' => 40,
);
$digest = notifications_digest_method($time);
$form['intervals'][$index]['digest'] = array(
'#type' => 'select',
'#disabled' => ($number < 0),
'#default_value' => $digest ? $digest['type'] : '',
'#options' => $digest_methods,
);
// Store also index -> time mapping
$form['intervals'][$index]['key'] = array('#type' => 'value', '#value' => $time);
$index++;
}
$form['default'] = array('#type' => 'radios',
'#options' => $index_options,
'#default_value' => $time_index[variable_get('notifications_default_send_interval', 0)],
);
// New row
$form['submit'] = array('#type' => 'submit', '#value' => t('Update'));
$form['reset'] = array('#type' => 'submit', '#value' => t('Reset to defaults'));
return $form;
}
/**
* Form validate for time intervals
*/
function notifications_send_intervals_form_validate($form, &$form_state) {
// Check the default is a valid one, not one to be deleted
$default = $form_state['values']['default'];
if (empty($form_state['values']['intervals'][$default]['unit']) || empty($form_state['values']['intervals'][$default]['name'])) {
form_set_error('default', t('Invalid default send interval.'));
}
}
/**
* Form submit for time intervals
*/
function notifications_send_intervals_form_submit($form, &$form_state) {
$form_values = $form_state['values'];
if ($form_values['op'] == t('Reset to defaults')) {
variable_del('notifications_send_intervals');
variable_del('notifications_digest_methods');
variable_del('notifications_default_send_interval');
}
else {
$intervals = $digest = array();
foreach ($form_values['intervals'] as $index => $values) {
if (is_numeric($values['time']) && $values['name']) {
$unit = $values['unit'] ? (int)$values['unit'] : 1;
$time = (int)$values['time'] * $unit;
$intervals[$time] = $values['name'];
$digest[$time] = $values['digest'];
if ($index == $form_values['default']) {
variable_set('notifications_default_send_interval', $time);
}
}
}
ksort($intervals);
variable_set('notifications_send_intervals', $intervals);
variable_set('notifications_digest_methods', $digest);
}
drupal_set_message(t('The time intervals for your subscriptions have been updated'));
// Update orphaned notifications with invalid send interval
$valid = array_keys($intervals);
$params = array_merge(array(variable_get('notifications_default_send_interval', 0)), $valid);
db_query('UPDATE {notifications} SET send_interval = %d WHERE send_interval NOT IN (' . db_placeholders($valid) . ')', $params);
if ($updated = db_affected_rows()) {
drupal_set_message(format_plural($updated, 'Updated a subscription with invalid interval.', 'Updated @count subscriptions with invalid intervals.'));
}
}
/**
* Build a table with send intervals
*/
function theme_notifications_send_intervals_form($element) {
$output = ''; //drupal_render($element['digest']);
$header = array(array('data' => t('Time'), 'colspan' => 2), t('Display name'), t('Digest'), t('Default'));
foreach (element_children($element['intervals']) as $key) {
$rows[] = array(
drupal_render($element['intervals'][$key]['time']),
drupal_render($element['intervals'][$key]['unit']),
drupal_render($element['intervals'][$key]['name']),
drupal_render($element['intervals'][$key]['digest']),
drupal_render($element['default'][$key]),
);
}
$element['intervals']['#value'] = theme('table', $header, $rows);
//$output .= theme('table', $header, $rows);
$output .= drupal_render($element);
return $output;
}
/**
* Event configuration administration
*
* Will allow to define which events trigger a notification and which ones not
*/
function notifications_admin_events_form() {
// Compile array from plug-ins and settings
$events = notifications_event_types();
$current = variable_get('notifications_events', array());
if ($events) {
$form['notifications_events'] = array(
'#title' => t('Enabled events'),
'#type' => 'fieldset',
'#tree' => TRUE,
'#description' => t('Check the events for which notifications should be triggered.'),
);
foreach ($events as $object => $object_info) {
foreach ($object_info as $action => $action_info) {
$form['notifications_events'][$object][$action] = array(
'#type' => 'checkbox',
'#title' => !empty($action_info['description']) ? $action_info['description'] : "$object:$action",
'#default_value' => isset($current[$object][$action]) ? $current[$object][$action] : 1,
);
}
}
return system_settings_form($form);
} else {
$form['warning'] = array('#value' => t('You need to enable some plug-ins to provide notifications events.'));
return $form;
}
}
/* ********************************************t*********** */
/* user screens: display, edit functions */
/* ******************************************************* */
/**
* Theme subscriptions list
*/
function theme_notifications_form_table($element) {
$output = '';
if ($fields = element_children($element)) {
$header = $element['#header'];
$rows = array();
// The first element determines the number of columns
foreach (element_children($element[$fields[key($fields)]]) as $index) {
$row = array();
foreach ($fields as $key) {
$row[] = isset($element[$key][$index]) ? drupal_render($element[$key][$index]) : '';
}
$rows[] = $row;
}
$output .= theme('table', $header, $rows);
}
$output .= drupal_render($element);
return $output;
}
/** Administration pages **/
/**
* Current subscriptions page
*/
function notifications_admin_status_page() {
$output = '';
// Subscriptions summary by type
$header = array(t('Type'), t('Number'));
$result = db_query("SELECT type, count(*) AS count FROM {notifications} GROUP BY type");
$count = 0;
$types = notifications_subscription_types();
$rows = array();
while ($stype = db_fetch_object($result)) {
$rows[] = array(
!empty($types[$stype->type]['title']) ? $types[$stype->type]['title'] : '' . $stype->type . '' ,
$stype->count);
$count += $stype->count;
}
$summary = theme('table', $header, $rows);
$summary .= t('Total: %number', array('%number' => $count));
$output .= theme('box', t('Subscriptions by type'), $summary);
// Summary by sending method
$header = array(t('Method'), t('Number'));
$result = db_query("SELECT send_method, count(*) AS count FROM {notifications} GROUP BY send_method");
$rows = array();
while ($subs = db_fetch_object($result)) {
$name = messaging_method_info($subs->send_method, 'title');
$rows[] = array(
$name ? $name : '' . $subs->send_method . '' ,
$subs->count);
}
$summary = theme('table', $header, $rows);
$output .= theme('box', t('Subscriptions by send method'), $summary);
// Queue summary
$output .= notifications_admin_queue_summary();
return $output;
}
/**
* Summary of queued notifications
*/
function notifications_admin_queue_summary() {
$output = '';
// Queue status
$send_intervals = _notifications_send_intervals();
$header = array(t('Send interval'), t('Number'));
$count = 0;
$result = db_query("SELECT send_interval, count(*) AS count FROM {notifications_queue} WHERE cron = 1 GROUP BY send_interval");
$rows = array();
while ($stype = db_fetch_object($result)) {
$rows[] = array($send_intervals[$stype->send_interval], $stype->count);
$count += $stype->count;
}
$output .= theme('table', $header, $rows);
$output .= t('Total: %number', array('%number' => $count));
return theme('box', t('Notifications in queue'), $output);
}
/**
* Admin queue management
*
* @ TO DO Add confirmation before queue reset
*/
function notifications_admin_queue($op = 'status', $param = NULL) {
$output = '';
$output .= drupal_get_form('notifications_admin_queue_operations');
$output .= notifications_admin_queue_summary();
// Display logs from last process
if (!empty($_SESSION['notifications_logs'])) {
$output .= theme('box', t('Process log'), messaging_log_format($_SESSION['notifications_logs']));
unset($_SESSION['notifications_logs']);
}
return $output;
}
/**
* Form for queue operations
*/
function notifications_admin_queue_operations() {
$form['operations'] = array(
'#type' => 'fieldset',
'#title' => t('Operations'),
'#theme' => 'notifications_table_form',
'#table_fields' => array('description', 'button'),
);
foreach (notifications_queue_operations() as $op => $data) {
$form['operations']['description'][$op] = array(
'#value' => $data['description'],
);
$form['operations']['button'][$op] = array(
'#type' => 'submit',
'#value' => $data['label'],
);
}
return $form;
}
/**
* Operations form submit, translate op into callback
*/
function notifications_admin_queue_operations_submit($form, $form_state) {
include_once drupal_get_path('module', 'notifications') .'/notifications.cron.inc';
foreach (notifications_queue_operations() as $op => $data) {
if ($form_state['values']['op'] == $data['label']) {
$callback = $data['callback'];
$args = !empty($data['callback arguments']) ? $data['callback arguments'] : array();
call_user_func_array($callback, $args);
break;
}
}
// Store logs to render on next page redirect
$_SESSION['notifications_logs'] = notifications_log();
}
/**
* List of queue operations
*/
function notifications_queue_operations() {
$operations = array(
'run' => array(
'label' => t('Run process'),
'description' => t('Run normal queue processing, same as cron run.'),
'callback' => 'notifications_process_run',
'callback arguments' => array(FALSE),
),
'immediate' => array(
'label' => t('Process immediate'),
'description' => t('Process only rows marked for immediate sending.'),
'callback' => 'notifications_process_rows',
'callback arguments' => array(array('cron' => 1, 'send_interval' => 0)),
),
'clean' => array(
'label' => t('Clean queue'),
'description' => t('Delete all logs, processed rows and related data in queue.'),
'callback' => 'notifications_admin_queue_process',
'callback arguments' => array('clean queue'),
),
'reset' => array(
'label' => t('Reset queue'),
'description' => t('Delete all notifications in queue.'),
'callback' => 'notifications_admin_queue_process',
'callback arguments' => array('reset queue'),
),
'test' => array(
'label' => t('Run test'),
'description' => t('Test run queue processing, without updating nor sending messages.'),
'callback' => 'notifications_admin_queue_process',
'callback arguments' => array('test run'),
),
);
return $operations;
}
/**
* Queue operations callback
*/
function notifications_admin_queue_process($op) {
switch ($op) {
case 'reset queue':
db_query("DELETE FROM {notifications_queue}");
db_query("DELETE FROM {notifications_event}");
drupal_set_message(t('The queue has been reset.'));
break;
case 'test run':
notifications_process('option', 'test', TRUE);
notifications_process_run(FALSE);
break;
case 'clean queue':
// Delete logs and clean up events
notifications_queue_clean(array('cron' => 0));
break;
}
}
/**
* Generic table formatting for forms
*/
function theme_notifications_table_form($form) {
$output = '';
// Get table information from special form properties
$index = !empty($form['#table_index']) ? $form['#table_index'] : $form['#table_fields'][0];
$header = !empty($form['#table_header']) ? $form['#table_header'] : array();
foreach (element_children($form[$index]) as $key) {
$row = array();
foreach ($form['#table_fields'] as $field) {
$row[] = drupal_render($form[$field][$key]);
}
$rows[] = $row;
}
if ($rows) {
$output .= theme('table', $header, $rows);
} else {
$output .= '' . t('No elements') . '
';
}
$output .= drupal_render($form);
return $output;
}