Index: simplenews.admin.inc =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/simplenews/simplenews.admin.inc,v retrieving revision 1.59.2.12 diff -u -p -r1.59.2.12 simplenews.admin.inc --- simplenews.admin.inc 13 Aug 2010 12:43:49 -0000 1.59.2.12 +++ simplenews.admin.inc 14 Aug 2010 22:34:47 -0000 @@ -42,6 +42,7 @@ function simplenews_admin_news(&$form_st $result = pager_query(db_rewrite_sql($query, 'n', 'nid'), 10, 0, db_rewrite_sql($count_query, 'n', 'nid'), 0); $rows = array(); + module_load_include('inc', 'simplenews', 'simplenews.mail'); while ($node = db_fetch_object($result)) { $row = array(); $operation = array(); Index: simplenews.mail.inc =================================================================== RCS file: simplenews.mail.inc diff -N simplenews.mail.inc --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ simplenews.mail.inc 14 Aug 2010 22:34:48 -0000 @@ -0,0 +1,638 @@ +. Added for compatebility with user account object + * language = language object. User preferred of default language + * ) + * NOTE: either snid, mail or uid is required. + */ +function simplenews_send_node($node, $accounts = array()) { + $mails = array(); + + if (is_numeric($node)) { + $node = node_load($node); + } + if (is_object($node)) { + $from = _simplenews_set_from($node); + $params['context']['node'] = $node; + $params['from'] = $from; + + $node_data['tid'] = $node->simplenews['tid']; + $node_data['nid'] = $node->nid; + $node_data['vid'] = $node->vid; + + + if (empty($accounts)) { + // No accounts specified. Get email address of all accounts subscribed to this newsletter. + $result = db_query('SELECT s.mail FROM {simplenews_subscriptions} s + INNER JOIN {simplenews_snid_tid} t ON s.snid = t.snid + WHERE s.activated = %d AND t.tid = %d AND t.status = %d', + 1, $node_data['tid'], SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED); + while ($account = db_fetch_object($result)) { + $mails[] = array('mail' => $account->mail); + } + } + else { + // Get email address of specified accounts. + foreach ($accounts as $account) { + $account = simplenews_get_subscription($account); + $mails[] = array('mail' => $account->mail); + } + } + + // To send the newsletter, the node id and target email addresses + // are stored in the spool. + // When cron is not used the newsletter is send immediately to the emails + // in the spool. When cron is used newsletters are send to addresses in the + // spool during the next (and following) cron run. + foreach ($mails as $mail) { + $data = array_merge($node_data, $mail); + simplenews_save_spool($data); + } + if (variable_get('simplenews_use_cron', TRUE) == FALSE) { + simplenews_mail_spool($node_data['nid'], $node_data['vid'], 999999); + drupal_set_message(t('Newsletter sent.')); + simplenews_clear_spool(); + } + else { + drupal_set_message(t('Newsletter pending.')); + } + } +} + +/** + * Send test version of newsletter. + * + * @param integer or object $node Newsletter node to be sent. Integer = nid; Object = node object + */ +function simplenews_send_test($node) { + if (is_numeric($node)) { + $node = node_load($node); + } + if (is_object($node)) { + // Send the test newsletter to the test address(es) specified in the node. + // Build array of test email addresses + $mails = explode(',', $node->simplenews['test_address']); + + // Send newsletter to test addresses. + // Emails are send direct, not using the spool. + $recipients = array('anonymous' => array(), 'user' => array()); + foreach ($mails as $mail) { + $mail = trim($mail); + if (!empty($mail)) { + $account = _simplenews_user_load($mail); + $subscription = simplenews_get_subscription($account); + if ($account->uid) { + $recipients['user'][] = $account->name . ' <'.$mail.'>'; + } + else { + $recipients['anonymous'][] = $mail; + } + $tmpres = simplenews_mail_mail($node->nid, $node->vid, $mail, 'test'); + } + } + if (count($recipients['user'])) { + $recipients_txt = implode(', ', $recipients['user']); + drupal_set_message(t('Test newsletter sent to user %recipient.', array('%recipient' => $recipients_txt))); + } + if (count($recipients['anonymous'])) { + $recipients_txt = implode(', ', $recipients['anonymous']); + drupal_set_message(t('Test newsletter sent to anonymous %recipient.', array('%recipient' => $recipients_txt))); + } + } +} + +/** + * Send a node to an email address. + * + * @param $nid node id of newsletter node + * @param $vid revision id of newsletter node + * @param $mail target email address + * @param $key email key [node|test] + * + * @return TRUE if email is succesfully delivered by php mail() + */ +function simplenews_mail_mail($nid, $vid, $mail, $key = 'node') { + static $cache; + + // Get subscription data for recipient and language + $account = new stdClass(); + $account->mail = $mail; + $subscription = simplenews_get_subscription($account); + $params['context']['account'] = $subscription; + + // Get node data for the mail + // Because node_load() only caches the most recent node we cache here based on nid and vid. + if (isset($cache["$nid:$vid"])) { + $node = $cache["$nid:$vid"]; + } + else { + $node = node_load($nid, $vid); + $cache["$nid:$vid"] = $node; + } + + if (is_object($node)) { + $params['from'] = _simplenews_set_from($node); + $params['context']['newsletter'] = taxonomy_get_term($node->simplenews['tid']); + $params['context']['node'] = $node; + + // Send mail + if (module_exists('mimemail')) { + // If mimemail module is installed ALL emails are send via this module. + // drupal_mail() builds the content of the email but does NOT send. + $message = drupal_mail('simplenews', $key, $subscription->mail, $subscription->language, $params, $params['from']['formatted'], FALSE); + $to = isset($message['params']['context']['account']) ? $message['params']['context']['account'] : $message['to']; + $plain = $message['params']['context']['node']->simplenews['s_format'] == 'plain' ? TRUE : NULL; + $message['result'] = mimemail( + $message['from'], + $to, + $message['subject'], + $message['body'], + $plain, + $message['headers'], + $plain ? $message['body'] : simplenews_html_to_text($message['body'], TRUE), + isset($message['params']['context']['node']->files) ? $message['params']['context']['node']->files : array(), + '' + ); + } + else { + $message = drupal_mail('simplenews', $key, $subscription->mail, $subscription->language, $params, $params['from']['formatted'], TRUE); + } + + // Log sent result in watchdog. + if (variable_get('simplenews_debug', FALSE)) { + if (module_exists('mimemail')) { + $via_mimemail = t('Sent via Mime Mail'); + } + //TODO Add line break before %mimemail. + if ($message['result']) { + watchdog('simplenews', 'Outgoing email. Message type: %type
Subject: %subject
Recipient: %to %mimemail', array('%type' => $key, '%to' => $message['to'], '%subject' => $message['subject'], '%mimemail' => $via_mimemail), WATCHDOG_DEBUG); + } + else { + watchdog('simplenews', 'Outgoing email failed. Message type: %type
Subject: %subject
Recipient: %to %mimemail', array('%type' => $key, '%to' => $message['to'], '%subject' => $message['subject'], '%mimemail' => $via_mimemail), WATCHDOG_ERROR); + } + } + + // Build array of sent results for spool table and reporting. + if ($message['result']) { + $message['result'] = array( + 'status' => SIMPLENEWS_SPOOL_DONE, + 'error' => FALSE, + ); + } + else { + // This error may be caused by faulty mailserver configuration or overload. + // Mark "pending" to keep trying. + $message['result'] = array( + 'status' => SIMPLENEWS_SPOOL_PENDING, + 'error' => TRUE, + ); + } + + } + else { + // Node could not be loaded. The node is probably deleted while pending to be sent. + // This error is not recoverable, mark "done". + $message['result'] = array( + 'status' => SIMPLENEWS_SPOOL_DONE, + 'error' => TRUE, + ); + watchdog('simplenews', 'Newsletter not send: newsletter issue does not exist (nid = @nid; vid = @vid).', array('@nid' => $message['nid'], '@vid' => $message['vid']), WATCHDOG_ERROR); + } + + return isset($message['result']) ? $message['result'] : FALSE; +} + +/** + * Send simplenews newsletters from the spool. + * + * Individual newsletter emails are stored in database spool. + * Sending is triggered by cron or immediately when the node is saved. + * Mail data is retreived from the spool, rendered and send one by one + * If sending is succesful the message is marked as send in the spool. + */ +function simplenews_mail_spool($nid = NULL, $vid = NULL, $limit = NULL) { + // Send pending messages from database cache + // A limited number of mails is retrieved from the spool + $limit = isset($limit) ? $limit : variable_get('simplenews_throttle', 20); + if ($messages = simplenews_get_spool(SIMPLENEWS_SPOOL_PENDING, $nid, $vid, $limit)) { + $count_fail = $count_success = 0; + + // Get PHP maximum execution time. 30 seconds default. + $max_execution_time = ini_get('max_execution_time') ? ini_get('max_execution_time') : SIMPLENEWS_MAX_EXECUTION_TIME; + + _simplenews_measure_usec(TRUE); + + $check_counter = 0; + foreach ($messages as $key => $message) { + $result = simplenews_mail_mail($message['nid'], $message['vid'], $message['mail']); + + // Update spool status. + // This is not optimal for performance but prevents duplicate emails + // in case of PHP execution time overrun. + simplenews_update_spool(array($key), $result); + if ($result['status'] == SIMPLENEWS_SPOOL_DONE) { + $count_success ++; + } + if ($result['error']) { + $count_fail ++; + } + + // Check every n emails if we exceed the limit. + // When PHP maximum execution time is almost elapsed we interrupt + // sending. The remainder will be sent during the next cron run. + if (++$check_counter >= SIMPLENEWS_SEND_CHECK_INTERVAL) { + $check_counter = 0; + // Break the sending if a percentage of max execution time was exceeded. + $elapsed = _simplenews_measure_usec(); + if ($elapsed > SIMPLENEWS_SEND_TIME_LIMIT * $max_execution_time) { + watchdog('simplenews', 'Sending interrupted: PHP maximum execution time almost exceeded. Remaining newsletters will be sent during the next cron run. If this warning occurs regularly you should reduce the !cron_throttle_setting.', array('!cron_throttle_setting' => l(t('Cron throttle setting'), 'admin/settings/simplenews/mail')), WATCHDOG_WARNING); + break; + } + } + } + + // Report sent result and elapsed time. On Windows systems retrusage() is + // not implemented and hence no elapsed time is available. + if (function_exists('getrusage')) { + watchdog('simplenews', '%success emails sent in %sec seconds, %fail failed sending.', array('%success' => $count_success, '%sec' => round(_simplenews_measure_usec(), 1), '%fail' => $count_fail)); + } + else { + watchdog('simplenews', '%success emails sent, %fail failed.', array('%success' => $count_success, '%fail' => $count_fail)); + } + + variable_set('simplenews_last_cron', time()); + //@todo: set mail_sent from last batch + variable_set('simplenews_last_sent', count($mail_sent)); + } + +} + +/** + * Save mail message in mail cache table. + * + * @param array $message data array to be stored + * $message['mail'] + * $message['nid'] + * $message['vid'] + * $message['tid'] + * $message['status'] (Default: 1 = pending) + * $message['time'] (default: current unix timestamp) + + * @param array $message Mail message array + */ +function simplenews_save_spool($message) { + $status = isset($message['status']) ? $message['status'] : SIMPLENEWS_SPOOL_PENDING; + $time = isset($message['time']) ? $message['time'] : time(); + + db_query("INSERT INTO {simplenews_mail_spool} (mail, nid, vid, tid, status, timestamp) + VALUES ('%s', %d, %d, %d, %d, %d)", $message['mail'], $message['nid'], $message['vid'], $message['tid'], $status, $time); +} + +/** + * Retreive data from mail spool + * + * @param string $status Status of data to be retreived (0 = hold, 1 = pending, 2 = send) + * @param integer $nid node id + * @param integer $vid node version id + * @param integer $limit The maximum number of mails to load from the spool + * + * @return array Mail message array + * $message['msid'] + * $message['mail'] + * $message['nid'] + * $message['vid'] + * $message['tid'] + * $message['status'] + * $message['time'] + */ +function simplenews_get_spool($status, $nid = NULL, $vid = NULL, $limit = 999999) { + $messages = array(); + + $result = db_query_range("SELECT * FROM {simplenews_mail_spool} s WHERE s.status = %d ORDER BY s.timestamp ASC", $status, 0, $limit); + while ($data = db_fetch_array($result)) { + $message = array(); + foreach ($data as $key => $value) { + $message[$key] = $value; + } + $messages[$data['msid']] = $message; + } + return $messages; +} + +/** + * Update status of mail data in spool table. + * + * Time stamp is set to current time. + * + * @param array $msids + * Mail spool id of record to be updated + * @param array $result + * Array containing email sent result + * 'status' => (0 = hold, 1 = pending, 2 = send) + * 'error' => error id (optional; defaults to '') + */ +function simplenews_update_spool($msids, $result) { + $params[] = $result['status']; + $params[] = isset($result['error']) ? $result['error'] : FALSE; + $params[] = time(); + $params = array_merge($params, $msids); + db_query("UPDATE {simplenews_mail_spool} SET status = %d, error = %d, timestamp = %d WHERE msid IN(". db_placeholders($msids, 'int') .")", $params); +} + +/** + * Count data in mail spool table. + * + * @param integer $nid newsletter node id + * @param integer $vid newsletter revision id + * @param string $status email sent status + * + * @return array Mail message array + */ +function simplenews_count_spool($nid, $vid, $status = SIMPLENEWS_SPOOL_PENDING) { + return db_result(db_query("SELECT COUNT(*) FROM {simplenews_mail_spool} WHERE nid = %d AND vid = %d AND status = %d", $nid, $vid, $status)); +} + +/** + * Remove records from mail spool table. + * + * All records with status 'send' and time stamp before the expiration date + * are removed from the spool. + */ +function simplenews_clear_spool() { + $expiration_time = time() - variable_get('simplenews_spool_expire', 0) * 86400; + db_query("DELETE FROM {simplenews_mail_spool} WHERE status = %d AND timestamp <= %d", SIMPLENEWS_SPOOL_DONE, $expiration_time); +} + +/** + * Update newsletter sent status. + * + * Set newsletter sent status based on email sent status in spool table. + * Translated and untranslated nodes get a different treatment. + * + * The spool table holds data for emails to be sent and (optionally) + * already send emails. The simplenews_newsletters table contains the overall + * sent status of each newsletter issue (node). + * Newsletter issues get the status pending when sending is innitiated. As + * long as unsend emails exist in the spool, the status of the newsletter remains + * unsend. When no pending emails are found the newsletter status is set 'send'. + * + * Translated newsletters are a group of nodes that share the same tnid ({node}.tnid). + * Only one node of the group is found in the spool, but all nodes should share + * the same state. Therefore they are checked for the combined number of emails + * in the spool. + */ +function simplenews_send_status_update() { + $counts = array(); // number pending of emails in the spool + $sum = array(); // sum of emails in the spool per tnid (translation id) + $send = array(); // nodes with the status 'send' + + // For each pending newsletter count the number of pending emails in the spool. + $result = db_query("SELECT s.nid, s.vid, s.tid, n.tnid FROM {simplenews_newsletters} s JOIN {node} n ON s.nid = n.nid AND s.vid = n.vid WHERE s.s_status = %d", SIMPLENEWS_STATUS_SEND_PENDING); + while ($newsletter = db_fetch_object($result)) { + // nid-vid are combined in one unique key. + $counts[$newsletter->tnid][$newsletter->nid .'-'. $newsletter->vid] = simplenews_count_spool($newsletter->nid, $newsletter->vid); + } + + // Determine which nodes are send per translation group and per individual node. + foreach ($counts as $tnid => $node_count) { + // The sum of emails per tnid is the combined status result for the group of translated nodes. + // Untranslated nodes have tnid == 0 which will be ignored later. + $sum[$tnid] = array_sum($node_count); + foreach ($node_count as $nidvid => $count) { + // Translated nodes (tnid != 0) + if ($tnid != '0' && $sum[$tnid] == '0') { + $send[] = $nidvid; + } + // Untranslated nodes (tnid == 0) + elseif ($tnid == '0' && $count == '0') { + $send[] = $nidvid; + } + } + } + + // Update overall newsletter status + if (!empty($send)) { + foreach ($send as $nidvid) { + // Split the combined key 'nid-vid' + $nid = strtok($nidvid, '-'); + $vid = strtok('-'); + db_query("UPDATE {simplenews_newsletters} SET s_status = '%s' WHERE nid = %d AND vid = %d", SIMPLENEWS_STATUS_SEND_READY, $nid, $vid); + } + } +} + +/** + * Build header array with priority and receipt confirmation settings. + * + * @param $node: node object + * @param $from: from email address + * + * @return Header array with priority and receipt confirmation info + */ +function _simplenews_headers($node, $from) { + $headers = array(); + + // If receipt is requested, add headers. + if ($node->simplenews['receipt']) { + $headers['Disposition-Notification-To'] = $from; + $headers['X-Confirm-Reading-To'] = $from; + } + + // Add priority if set. + switch ($node->simplenews['priority']) { + case SIMPLENEWS_PRIORITY_HIGHEST: + $headers['Priority'] = 'urgent'; + $headers['X-Priority'] = '1'; + $headers['X-MSMail-Priority'] = 'Highest'; + break; + case SIMPLENEWS_PRIORITY_HIGH: + $headers['Priority'] = 'urgent'; + $headers['X-Priority'] = '2'; + $headers['X-MSMail-Priority'] = 'High'; + break; + case SIMPLENEWS_PRIORITY_NORMAL: + $headers['Priority'] = 'normal'; + $headers['X-Priority'] = '3'; + $headers['X-MSMail-Priority'] = 'Normal'; + break; + case SIMPLENEWS_PRIORITY_LOW: + $headers['Priority'] = 'non-urgent'; + $headers['X-Priority'] = '4'; + $headers['X-MSMail-Priority'] = 'Low'; + break; + case SIMPLENEWS_PRIORITY_LOWEST: + $headers['Priority'] = 'non-urgent'; + $headers['X-Priority'] = '5'; + $headers['X-MSMail-Priority'] = 'Lowest'; + break; + } + + // Add general headers + $headers['Precedence'] = 'bulk'; + + return $headers; +} + +/** + * Build formatted from-name and email for a mail object. + * + * Each newsletter (serie; tid) can have a different from address. + * The from name and address depend on the newsletter term tid which is included in the $node object + * + * @param object $node Node object of a simplenews newsletter + * + * @return array [address] = from address; [formatted] = formatted from name and address + */ +function _simplenews_set_from($node = NULL) { + $address_default = variable_get('site_mail', ini_get('sendmail_from')); + $name_default = variable_get('site_name', 'Drupal'); + + if (isset($node->simplenews['tid'])) { + $address = variable_get('simplenews_from_address_'. $node->simplenews['tid'], variable_get('simplenews_from_address', $address_default)); + $name = variable_get('simplenews_from_name_'. $node->simplenews['tid'], variable_get('simplenews_from_name', $name_default)); + } + else { + $address = variable_get('simplenews_from_address', $address_default); + $name = variable_get('simplenews_from_name', $name_default); + } + + // Windows based PHP systems don't accept formatted emails. + $formatted_address = substr(PHP_OS, 0, 3) == 'WIN' ? $address : '"'. mime_header_encode($name) .'" <'. $address .'>'; + + return array( + 'address' => $address, + 'formatted' => $formatted_address, + ); +} + +/** + * HTML to text conversion for HTML and special characters. + * + * Converts some special HTMLcharacters in addition to drupal_html_to_text() + * + * @param string $text Source text with HTML and special characters + * @param boolean $inline_hyperlinks + * TRUE: URLs will be placed inline. + * FALSE: URLs will be converted to numbered reference list. + * @return string Target text with HTML and special characters replaced + */ +function simplenews_html_to_text($text, $inline_hyperlinks = TRUE) { + // By replacing tag by only its URL the URLs will be placed inline + // in the email body and are not converted to a numbered reference list + // by drupal_html_to_text(). + // URL are converted to abolute URL as drupal_html_to_text() would have. + if ($inline_hyperlinks) { + $pattern = '@]+?href="([^"]*)"[^>]*?>(.+?)@is'; + $text = preg_replace_callback($pattern, '_simplenews_absolute_mail_urls', $text); + } + + // Replace some special characters before performing the drupal standard conversion. + $preg = _simplenews_html_replace(); + $text = preg_replace(array_keys($preg), array_values($preg), $text); + + // Perform standard drupal html to text conversion. + return drupal_html_to_text($text); +} + +/** + * Helper function for simplenews_html_to_text(). + * + * Replaces URLs with abolute URLs. + */ +function _simplenews_absolute_mail_urls($match) { + global $base_url, $base_path; + static $regexp; + $url = $label = ''; + + if ($match) { + if (empty($regexp)) { + $regexp = '@^'. preg_quote($base_path, '@') .'@'; + } + list(, $url, $label) = $match; + $url = strpos($url, '://') ? $url : preg_replace($regexp, $base_url .'/', $url); + + // If the link is formed by Drupal's URL filter, we only return the URL. + // The URL filter generates a label out of the original URL. + if (strpos($label, '...') === strlen($label) - 3) { + // Remove ellipsis from end of label. + $label = substr($label, 0, strlen($label) - 3); + } + if (strpos($url, $label) !== FALSE) { + return $url; + } + return $label .' '. $url; + } +} + +/** + * Helper function for simplenews_html_to_text(). + * + * List of preg* regular expression patterns to search for and replace with + */ +function _simplenews_html_replace() { + return array( + '/"/i' => '"', + '/>/i' => '>', + '/</i' => '<', + '/&/i' => '&', + '/©/i' => '(c)', + '/™/i' => '(tm)', + '/“/' => '"', + '/”/' => '"', + '/–/' => '-', + '/’/' => "'", + '/&/' => '&', + '/©/' => '(c)', + '/™/' => '(tm)', + '/—/' => '--', + '/“/' => '"', + '/”/' => '"', + '/•/' => '*', + '/®/i' => '(R)', + '/•/i' => '*', + '/€/i' => 'Euro ', + ); +} + +/** + * Helper function to measure PHP execution time in microseconds. + * + * @param bool $start TRUE reset the time and start counting. + * @return float: elapsed PHP execution time since start. + */ +function _simplenews_measure_usec($start = FALSE) { + // Windows systems don't implement getrusage(). There is no alternative. + if (!function_exists('getrusage')) { + return 0; + } + + static $start_time; + + $usage = getrusage(); + $now = (float)($usage["ru_utime.tv_sec"] .'.'. $usage["ru_utime.tv_usec"]); + + if ($start) { + $start_time = $now; + return 0; + } + return $now - $start_time; +} + Index: simplenews.module =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/simplenews/simplenews.module,v retrieving revision 1.220.2.41 diff -u -p -r1.220.2.41 simplenews.module --- simplenews.module 14 Aug 2010 15:58:24 -0000 1.220.2.41 +++ simplenews.module 14 Aug 2010 22:34:49 -0000 @@ -429,6 +429,7 @@ function simplenews_nodeapi(&$node, $op, } // Send newsletter or test newsletter + module_load_include('inc', 'simplenews', 'simplenews.mail'); if ($send_with_permission) { // Send newsletter to all subscribers simplenews_send_node($node); @@ -445,6 +446,7 @@ function simplenews_nodeapi(&$node, $op, } // Check if pending emails of this newsletter issue exist and delete these too. + module_load_include('inc', 'simplenews', 'simplenews.mail'); // @todo: delete directly in db, not via $pending $pending = simplenews_get_spool(SIMPLENEWS_SPOOL_PENDING, $node->nid, $node->vid); if (!empty($pending)) { @@ -706,11 +708,11 @@ function simplenews_form_alter(&$form, $ * Implementation of hook_cron(). */ function simplenews_cron() { + module_load_include('inc', 'simplenews', 'simplenews.mail'); simplenews_mail_spool(); simplenews_clear_spool(); // Update sent status for newsletter admin panel. simplenews_send_status_update(); - } /** @@ -881,6 +883,7 @@ function simplenews_user($op, &$edit, &$ break; case 'form': if ($category == 'newsletter') { + module_load_include('inc', 'simplenews', 'simplenews.mail'); $subscription = simplenews_get_subscription($account); $form = _simplenews_subscription_manager_form($subscription); $form['subscriptions']['#title'] = t('Current newsletter subscriptions'); @@ -1512,117 +1515,6 @@ function simplenews_block_form_submit($f } /** - * Send newsletter node to subcribers. - * - * @param integer or object $node Newsletter node to be sent. integer = nid; object = node object - * @param array $accounts account objects to send the newsletter to. - * account = object ( - * snid = subscription id. 0 if no subscription record exists - * tids = array(tid) array of newsletter tid's - * uid = user id. 0 if subscriber is anonymous user. - * mail = user email address. - * name = . Added for compatebility with user account object - * language = language object. User preferred of default language - * ) - * NOTE: either snid, mail or uid is required. - */ -function simplenews_send_node($node, $accounts = array()) { - $mails = array(); - - if (is_numeric($node)) { - $node = node_load($node); - } - if (is_object($node)) { - $from = _simplenews_set_from($node); - $params['context']['node'] = $node; - $params['from'] = $from; - - $node_data['tid'] = $node->simplenews['tid']; - $node_data['nid'] = $node->nid; - $node_data['vid'] = $node->vid; - - - if (empty($accounts)) { - // No accounts specified. Get email address of all accounts subscribed to this newsletter. - $result = db_query('SELECT s.mail FROM {simplenews_subscriptions} s - INNER JOIN {simplenews_snid_tid} t ON s.snid = t.snid - WHERE s.activated = %d AND t.tid = %d AND t.status = %d', - 1, $node_data['tid'], SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED); - while ($account = db_fetch_object($result)) { - $mails[] = array('mail' => $account->mail); - } - } - else { - // Get email address of specified accounts. - foreach ($accounts as $account) { - $account = simplenews_get_subscription($account); - $mails[] = array('mail' => $account->mail); - } - } - - // To send the newsletter, the node id and target email addresses - // are stored in the spool. - // When cron is not used the newsletter is send immediately to the emails - // in the spool. When cron is used newsletters are send to addresses in the - // spool during the next (and following) cron run. - foreach ($mails as $mail) { - $data = array_merge($node_data, $mail); - simplenews_save_spool($data); - } - if (variable_get('simplenews_use_cron', TRUE) == FALSE) { - simplenews_mail_spool($node_data['nid'], $node_data['vid'], 999999); - drupal_set_message(t('Newsletter sent.')); - simplenews_clear_spool(); - } - else { - drupal_set_message(t('Newsletter pending.')); - } - } -} - -/** - * Send test version of newsletter. - * - * @param integer or object $node Newsletter node to be sent. Integer = nid; Object = node object - */ -function simplenews_send_test($node) { - if (is_numeric($node)) { - $node = node_load($node); - } - if (is_object($node)) { - // Send the test newsletter to the test address(es) specified in the node. - // Build array of test email addresses - $mails = explode(',', $node->simplenews['test_address']); - - // Send newsletter to test addresses. - // Emails are send direct, not using the spool. - $recipients = array('anonymous' => array(), 'user' => array()); - foreach ($mails as $mail) { - $mail = trim($mail); - if (!empty($mail)) { - $account = _simplenews_user_load($mail); - $subscription = simplenews_get_subscription($account); - if ($account->uid) { - $recipients['user'][] = $account->name . ' <'.$mail.'>'; - } - else { - $recipients['anonymous'][] = $mail; - } - $tmpres = simplenews_mail_mail($node->nid, $node->vid, $mail, 'test'); - } - } - if (count($recipients['user'])) { - $recipients_txt = implode(', ', $recipients['user']); - drupal_set_message(t('Test newsletter sent to user %recipient.', array('%recipient' => $recipients_txt))); - } - if (count($recipients['anonymous'])) { - $recipients_txt = implode(', ', $recipients['anonymous']); - drupal_set_message(t('Test newsletter sent to anonymous %recipient.', array('%recipient' => $recipients_txt))); - } - } -} - -/** * Implementation of hook_mail(). * * Send simplenews mails using drupal mail API @@ -1643,6 +1535,7 @@ function simplenews_send_test($node) { * [tokens] : tokens for variable replacement. Defaults to: user_mail_tokens() */ function simplenews_mail($key, &$message, $params) { + module_load_include('inc', 'simplenews', 'simplenews.mail'); $context = $params['context']; $langcode = $message['language']->language; @@ -1811,326 +1704,6 @@ function simplenews_mail($key, &$message } /** - * Send a node to an email address. - * - * @param $nid node id of newsletter node - * @param $vid revision id of newsletter node - * @param $mail target email address - * @param $key email key [node|test] - * - * @return TRUE if email is succesfully delivered by php mail() - */ -function simplenews_mail_mail($nid, $vid, $mail, $key = 'node') { - static $cache; - - // Get subscription data for recipient and language - $account = new stdClass(); - $account->mail = $mail; - $subscription = simplenews_get_subscription($account); - $params['context']['account'] = $subscription; - - // Get node data for the mail - // Because node_load() only caches the most recent node we cache here based on nid and vid. - if (isset($cache["$nid:$vid"])) { - $node = $cache["$nid:$vid"]; - } - else { - $node = node_load($nid, $vid); - $cache["$nid:$vid"] = $node; - } - - if (is_object($node)) { - $params['from'] = _simplenews_set_from($node); - $params['context']['newsletter'] = taxonomy_get_term($node->simplenews['tid']); - $params['context']['node'] = $node; - - // Send mail - if (module_exists('mimemail')) { - // If mimemail module is installed ALL emails are send via this module. - // drupal_mail() builds the content of the email but does NOT send. - $message = drupal_mail('simplenews', $key, $subscription->mail, $subscription->language, $params, $params['from']['formatted'], FALSE); - $to = isset($message['params']['context']['account']) ? $message['params']['context']['account'] : $message['to']; - $plain = $message['params']['context']['node']->simplenews['s_format'] == 'plain' ? TRUE : NULL; - $message['result'] = mimemail( - $message['from'], - $to, - $message['subject'], - $message['body'], - $plain, - $message['headers'], - $plain ? $message['body'] : simplenews_html_to_text($message['body'], TRUE), - isset($message['params']['context']['node']->files) ? $message['params']['context']['node']->files : array(), - '' - ); - } - else { - $message = drupal_mail('simplenews', $key, $subscription->mail, $subscription->language, $params, $params['from']['formatted'], TRUE); - } - - // Log sent result in watchdog. - if (variable_get('simplenews_debug', FALSE)) { - if (module_exists('mimemail')) { - $via_mimemail = t('Sent via Mime Mail'); - } - //TODO Add line break before %mimemail. - if ($message['result']) { - watchdog('simplenews', 'Outgoing email. Message type: %type
Subject: %subject
Recipient: %to %mimemail', array('%type' => $key, '%to' => $message['to'], '%subject' => $message['subject'], '%mimemail' => $via_mimemail), WATCHDOG_DEBUG); - } - else { - watchdog('simplenews', 'Outgoing email failed. Message type: %type
Subject: %subject
Recipient: %to %mimemail', array('%type' => $key, '%to' => $message['to'], '%subject' => $message['subject'], '%mimemail' => $via_mimemail), WATCHDOG_ERROR); - } - } - - // Build array of sent results for spool table and reporting. - if ($message['result']) { - $message['result'] = array( - 'status' => SIMPLENEWS_SPOOL_DONE, - 'error' => FALSE, - ); - } - else { - // This error may be caused by faulty mailserver configuration or overload. - // Mark "pending" to keep trying. - $message['result'] = array( - 'status' => SIMPLENEWS_SPOOL_PENDING, - 'error' => TRUE, - ); - } - - } - else { - // Node could not be loaded. The node is probably deleted while pending to be sent. - // This error is not recoverable, mark "done". - $message['result'] = array( - 'status' => SIMPLENEWS_SPOOL_DONE, - 'error' => TRUE, - ); - watchdog('simplenews', 'Newsletter not send: newsletter issue does not exist (nid = @nid; vid = @vid).', array('@nid' => $message['nid'], '@vid' => $message['vid']), WATCHDOG_ERROR); - } - - return isset($message['result']) ? $message['result'] : FALSE; -} - -/** - * Send simplenews newsletters from the spool. - * - * Individual newsletter emails are stored in database spool. - * Sending is triggered by cron or immediately when the node is saved. - * Mail data is retreived from the spool, rendered and send one by one - * If sending is succesful the message is marked as send in the spool. - */ -function simplenews_mail_spool($nid = NULL, $vid = NULL, $limit = NULL) { - // Send pending messages from database cache - // A limited number of mails is retrieved from the spool - $limit = isset($limit) ? $limit : variable_get('simplenews_throttle', 20); - if ($messages = simplenews_get_spool(SIMPLENEWS_SPOOL_PENDING, $nid, $vid, $limit)) { - $count_fail = $count_success = 0; - - // Get PHP maximum execution time. 30 seconds default. - $max_execution_time = ini_get('max_execution_time') ? ini_get('max_execution_time') : SIMPLENEWS_MAX_EXECUTION_TIME; - - _simplenews_measure_usec(TRUE); - - $check_counter = 0; - foreach ($messages as $key => $message) { - $result = simplenews_mail_mail($message['nid'], $message['vid'], $message['mail']); - - // Update spool status. - // This is not optimal for performance but prevents duplicate emails - // in case of PHP execution time overrun. - simplenews_update_spool(array($key), $result); - if ($result['status'] == SIMPLENEWS_SPOOL_DONE) { - $count_success ++; - } - if ($result['error']) { - $count_fail ++; - } - - // Check every n emails if we exceed the limit. - // When PHP maximum execution time is almost elapsed we interrupt - // sending. The remainder will be sent during the next cron run. - if (++$check_counter >= SIMPLENEWS_SEND_CHECK_INTERVAL) { - $check_counter = 0; - // Break the sending if a percentage of max execution time was exceeded. - $elapsed = _simplenews_measure_usec(); - if ($elapsed > SIMPLENEWS_SEND_TIME_LIMIT * $max_execution_time) { - watchdog('simplenews', 'Sending interrupted: PHP maximum execution time almost exceeded. Remaining newsletters will be sent during the next cron run. If this warning occurs regularly you should reduce the !cron_throttle_setting.', array('!cron_throttle_setting' => l(t('Cron throttle setting'), 'admin/settings/simplenews/mail')), WATCHDOG_WARNING); - break; - } - } - } - - // Report sent result and elapsed time. On Windows systems retrusage() is - // not implemented and hence no elapsed time is available. - if (function_exists('getrusage')) { - watchdog('simplenews', '%success emails sent in %sec seconds, %fail failed sending.', array('%success' => $count_success, '%sec' => round(_simplenews_measure_usec(), 1), '%fail' => $count_fail)); - } - else { - watchdog('simplenews', '%success emails sent, %fail failed.', array('%success' => $count_success, '%fail' => $count_fail)); - } - - variable_set('simplenews_last_cron', time()); - //@todo: set mail_sent from last batch - variable_set('simplenews_last_sent', count($mail_sent)); - } - -} - -/** - * Save mail message in mail cache table. - * - * @param array $message data array to be stored - * $message['mail'] - * $message['nid'] - * $message['vid'] - * $message['tid'] - * $message['status'] (Default: 1 = pending) - * $message['time'] (default: current unix timestamp) - - * @param array $message Mail message array - */ -function simplenews_save_spool($message) { - $status = isset($message['status']) ? $message['status'] : SIMPLENEWS_SPOOL_PENDING; - $time = isset($message['time']) ? $message['time'] : time(); - - db_query("INSERT INTO {simplenews_mail_spool} (mail, nid, vid, tid, status, timestamp) - VALUES ('%s', %d, %d, %d, %d, %d)", $message['mail'], $message['nid'], $message['vid'], $message['tid'], $status, $time); -} - -/** - * Retreive data from mail spool - * - * @param string $status Status of data to be retreived (0 = hold, 1 = pending, 2 = send) - * @param integer $nid node id - * @param integer $vid node version id - * @param integer $limit The maximum number of mails to load from the spool - * - * @return array Mail message array - * $message['msid'] - * $message['mail'] - * $message['nid'] - * $message['vid'] - * $message['tid'] - * $message['status'] - * $message['time'] - */ -function simplenews_get_spool($status, $nid = NULL, $vid = NULL, $limit = 999999) { - $messages = array(); - - $result = db_query_range("SELECT * FROM {simplenews_mail_spool} s WHERE s.status = %d ORDER BY s.timestamp ASC", $status, 0, $limit); - while ($data = db_fetch_array($result)) { - $message = array(); - foreach ($data as $key => $value) { - $message[$key] = $value; - } - $messages[$data['msid']] = $message; - } - return $messages; -} - -/** - * Update status of mail data in spool table. - * - * Time stamp is set to current time. - * - * @param array $msids - * Mail spool id of record to be updated - * @param array $result - * Array containing email sent result - * 'status' => (0 = hold, 1 = pending, 2 = send) - * 'error' => error id (optional; defaults to '') - */ -function simplenews_update_spool($msids, $result) { - $params[] = $result['status']; - $params[] = isset($result['error']) ? $result['error'] : FALSE; - $params[] = time(); - $params = array_merge($params, $msids); - db_query("UPDATE {simplenews_mail_spool} SET status = %d, error = %d, timestamp = %d WHERE msid IN(". db_placeholders($msids, 'int') .")", $params); -} - -/** - * Count data in mail spool table. - * - * @param integer $nid newsletter node id - * @param integer $vid newsletter revision id - * @param string $status email sent status - * - * @return array Mail message array - */ -function simplenews_count_spool($nid, $vid, $status = SIMPLENEWS_SPOOL_PENDING) { - return db_result(db_query("SELECT COUNT(*) FROM {simplenews_mail_spool} WHERE nid = %d AND vid = %d AND status = %d", $nid, $vid, $status)); -} - -/** - * Remove records from mail spool table. - * - * All records with status 'send' and time stamp before the expiration date - * are removed from the spool. - */ -function simplenews_clear_spool() { - $expiration_time = time() - variable_get('simplenews_spool_expire', 0) * 86400; - db_query("DELETE FROM {simplenews_mail_spool} WHERE status = %d AND timestamp <= %d", SIMPLENEWS_SPOOL_DONE, $expiration_time); -} - -/** - * Update newsletter sent status. - * - * Set newsletter sent status based on email sent status in spool table. - * Translated and untranslated nodes get a different treatment. - * - * The spool table holds data for emails to be sent and (optionally) - * already send emails. The simplenews_newsletters table contains the overall - * sent status of each newsletter issue (node). - * Newsletter issues get the status pending when sending is innitiated. As - * long as unsend emails exist in the spool, the status of the newsletter remains - * unsend. When no pending emails are found the newsletter status is set 'send'. - * - * Translated newsletters are a group of nodes that share the same tnid ({node}.tnid). - * Only one node of the group is found in the spool, but all nodes should share - * the same state. Therefore they are checked for the combined number of emails - * in the spool. - */ -function simplenews_send_status_update() { - $counts = array(); // number pending of emails in the spool - $sum = array(); // sum of emails in the spool per tnid (translation id) - $send = array(); // nodes with the status 'send' - - // For each pending newsletter count the number of pending emails in the spool. - $result = db_query("SELECT s.nid, s.vid, s.tid, n.tnid FROM {simplenews_newsletters} s JOIN {node} n ON s.nid = n.nid AND s.vid = n.vid WHERE s.s_status = %d", SIMPLENEWS_STATUS_SEND_PENDING); - while ($newsletter = db_fetch_object($result)) { - // nid-vid are combined in one unique key. - $counts[$newsletter->tnid][$newsletter->nid .'-'. $newsletter->vid] = simplenews_count_spool($newsletter->nid, $newsletter->vid); - } - - // Determine which nodes are send per translation group and per individual node. - foreach ($counts as $tnid => $node_count) { - // The sum of emails per tnid is the combined status result for the group of translated nodes. - // Untranslated nodes have tnid == 0 which will be ignored later. - $sum[$tnid] = array_sum($node_count); - foreach ($node_count as $nidvid => $count) { - // Translated nodes (tnid != 0) - if ($tnid != '0' && $sum[$tnid] == '0') { - $send[] = $nidvid; - } - // Untranslated nodes (tnid == 0) - elseif ($tnid == '0' && $count == '0') { - $send[] = $nidvid; - } - } - } - - // Update overall newsletter status - if (!empty($send)) { - foreach ($send as $nidvid) { - // Split the combined key 'nid-vid' - $nid = strtok($nidvid, '-'); - $vid = strtok('-'); - db_query("UPDATE {simplenews_newsletters} SET s_status = '%s' WHERE nid = %d AND vid = %d", SIMPLENEWS_STATUS_SEND_READY, $nid, $vid); - } - } -} - -/** * Implementation of hook_views_api(). */ function simplenews_views_api() { @@ -2189,179 +1762,6 @@ function simplenews_get_newsletters($vid } /** - * Build formatted from-name and email for a mail object. - * - * Each newsletter (serie; tid) can have a different from address. - * The from name and address depend on the newsletter term tid which is included in the $node object - * - * @param object $node Node object of a simplenews newsletter - * - * @return array [address] = from address; [formatted] = formatted from name and address - */ -function _simplenews_set_from($node = NULL) { - $address_default = variable_get('site_mail', ini_get('sendmail_from')); - $name_default = variable_get('site_name', 'Drupal'); - - if (isset($node->simplenews['tid'])) { - $address = variable_get('simplenews_from_address_'. $node->simplenews['tid'], variable_get('simplenews_from_address', $address_default)); - $name = variable_get('simplenews_from_name_'. $node->simplenews['tid'], variable_get('simplenews_from_name', $name_default)); - } - else { - $address = variable_get('simplenews_from_address', $address_default); - $name = variable_get('simplenews_from_name', $name_default); - } - - // Windows based PHP systems don't accept formatted emails. - $formatted_address = substr(PHP_OS, 0, 3) == 'WIN' ? $address : '"'. mime_header_encode($name) .'" <'. $address .'>'; - - return array( - 'address' => $address, - 'formatted' => $formatted_address, - ); -} - -/** - * Build header array with priority and receipt confirmation settings. - * - * @param $node: node object - * @param $from: from email address - * - * @return Header array with priority and receipt confirmation info - */ -function _simplenews_headers($node, $from) { - $headers = array(); - - // If receipt is requested, add headers. - if ($node->simplenews['receipt']) { - $headers['Disposition-Notification-To'] = $from; - $headers['X-Confirm-Reading-To'] = $from; - } - - // Add priority if set. - switch ($node->simplenews['priority']) { - case SIMPLENEWS_PRIORITY_HIGHEST: - $headers['Priority'] = 'urgent'; - $headers['X-Priority'] = '1'; - $headers['X-MSMail-Priority'] = 'Highest'; - break; - case SIMPLENEWS_PRIORITY_HIGH: - $headers['Priority'] = 'urgent'; - $headers['X-Priority'] = '2'; - $headers['X-MSMail-Priority'] = 'High'; - break; - case SIMPLENEWS_PRIORITY_NORMAL: - $headers['Priority'] = 'normal'; - $headers['X-Priority'] = '3'; - $headers['X-MSMail-Priority'] = 'Normal'; - break; - case SIMPLENEWS_PRIORITY_LOW: - $headers['Priority'] = 'non-urgent'; - $headers['X-Priority'] = '4'; - $headers['X-MSMail-Priority'] = 'Low'; - break; - case SIMPLENEWS_PRIORITY_LOWEST: - $headers['Priority'] = 'non-urgent'; - $headers['X-Priority'] = '5'; - $headers['X-MSMail-Priority'] = 'Lowest'; - break; - } - - // Add general headers - $headers['Precedence'] = 'bulk'; - - return $headers; -} - -/** - * HTML to text conversion for HTML and special characters. - * - * Converts some special HTMLcharacters in addition to drupal_html_to_text() - * - * @param string $text Source text with HTML and special characters - * @param boolean $inline_hyperlinks - * TRUE: URLs will be placed inline. - * FALSE: URLs will be converted to numbered reference list. - * @return string Target text with HTML and special characters replaced - */ -function simplenews_html_to_text($text, $inline_hyperlinks = TRUE) { - // By replacing tag by only its URL the URLs will be placed inline - // in the email body and are not converted to a numbered reference list - // by drupal_html_to_text(). - // URL are converted to abolute URL as drupal_html_to_text() would have. - if ($inline_hyperlinks) { - $pattern = '@]+?href="([^"]*)"[^>]*?>(.+?)@is'; - $text = preg_replace_callback($pattern, '_simplenews_absolute_mail_urls', $text); - } - - // Replace some special characters before performing the drupal standard conversion. - $preg = _simplenews_html_replace(); - $text = preg_replace(array_keys($preg), array_values($preg), $text); - - // Perform standard drupal html to text conversion. - return drupal_html_to_text($text); -} - -/** - * Helper function for simplenews_html_to_text(). - * - * Replaces URLs with abolute URLs. - */ -function _simplenews_absolute_mail_urls($match) { - global $base_url, $base_path; - static $regexp; - $url = $label = ''; - - if ($match) { - if (empty($regexp)) { - $regexp = '@^'. preg_quote($base_path, '@') .'@'; - } - list(, $url, $label) = $match; - $url = strpos($url, '://') ? $url : preg_replace($regexp, $base_url .'/', $url); - - // If the link is formed by Drupal's URL filter, we only return the URL. - // The URL filter generates a label out of the original URL. - if (strpos($label, '...') === strlen($label) - 3) { - // Remove ellipsis from end of label. - $label = substr($label, 0, strlen($label) - 3); - } - if (strpos($url, $label) !== FALSE) { - return $url; - } - return $label .' '. $url; - } -} - -/** - * Helper function for simplenews_html_to_text(). - * - * List of preg* regular expression patterns to search for and replace with - */ -function _simplenews_html_replace() { - return array( - '/"/i' => '"', - '/>/i' => '>', - '/</i' => '<', - '/&/i' => '&', - '/©/i' => '(c)', - '/™/i' => '(tm)', - '/“/' => '"', - '/”/' => '"', - '/–/' => '-', - '/’/' => "'", - '/&/' => '&', - '/©/' => '(c)', - '/™/' => '(tm)', - '/—/' => '--', - '/“/' => '"', - '/”/' => '"', - '/•/' => '*', - '/®/i' => '(R)', - '/•/i' => '*', - '/€/i' => 'Euro ', - ); -} - -/** * Implementation of hook_token_list(). */ function simplenews_token_list($type = 'all') { @@ -2669,30 +2069,6 @@ function _simplenews_format_options() { } /** - * Helper function to measure PHP execution time in microseconds. - * - * @param bool $start TRUE reset the time and start counting. - * @return float: elapsed PHP execution time since start. - */ -function _simplenews_measure_usec($start = FALSE) { - // Windows systems don't implement getrusage(). There is no alternative. - if (!function_exists('getrusage')) { - return 0; - } - - static $start_time; - - $usage = getrusage(); - $now = (float)($usage["ru_utime.tv_sec"] .'.'. $usage["ru_utime.tv_usec"]); - - if ($start) { - $start_time = $now; - return 0; - } - return $now - $start_time; -} - -/** * Get defaults for the simplenews node form. */ function _simplenews_get_node_form_defaults() {