mailhandler.module in Mailhandler 7.2

Retrieves email for posting as nodes and comments.

File

mailhandler.module

<?php

/**
 * @file
 * Retrieves email for posting as nodes and comments.
 */

// Menu prefix for mailhandler mailboxes. Makes cherry-picking between D6/D7 branches easier.
define('MAILHANDLER_MENU_PREFIX', 'admin/structure');

/**
 * Implements hook_init().
 */
function mailhandler_init() {
  if (strstr(request_uri(), 'system/ajax') && $_POST['form_id'] == 'ctools_export_ui_edit_item_form') {
    ctools_include('export');
  }
}

/**
 * Implements hook_permission().
 */
function mailhandler_permission() {
  return array(
    'administer mailhandler' => array(
      'title' => t('Administer Mailhandler mailboxes'),
    ),
  );
}

/**
 * Implements hook_help().
 */
function mailhandler_help($path, $arg) {
  switch ($path) {
    case 'admin/help#mailhandler':
      $help = file_get_contents(dirname(__FILE__) . "/INSTALL.txt");
      return _filter_autop($help);
    case MAILHANDLER_MENU_PREFIX . '/mailhandler/add':
      return t('Please see the <a href="@handbook-page">handbook page on configuring mailboxes</a> for additional help.', array(
        '@handbook-page' => url('http://drupal.org/node/207366'),
      ));
    case MAILHANDLER_MENU_PREFIX . '/feeds/edit/%':
      if ($arg[6] == 'MailhandlerParser') {
        return t('Please see the <a href="@handbook-page">handbook page on configuring commands</a> for additional help.', array(
          '@handbook-page' => url('http://drupal.org/node/1158574'),
        ));
      }
      break;
  }
}

/**
 * Implements hook_ctools_plugin_type().
 */
function mailhandler_ctools_plugin_type() {
  return array(
    'authenticate' => array(),
    'commands' => array(),
    'filters' => array(),
    'retrieve' => array(),
  );
}

/**
 * Implements hook_ctools_plugin_directory().
 */
function mailhandler_ctools_plugin_directory($owner, $plugin_type) {
  return 'plugins/' . $owner . '/' . $plugin_type;
}

/**
 * Implements hook_filter_info().
 */
function mailhandler_filter_info() {
  $filters['mailhandler'] = array(
    'title' => t('Mailhandler signature remover'),
    'description' => t('Strips signatures from emails.'),
    'process callback' => '_mailhandler_filter_process',
    'settings callback' => '_mailhandler_filter_settings',
    'default settings' => array(
      'sig_separator' => '-- ',
    ),
  );
  $filters['mailhandler_quoted'] = array(
    'title' => t('Mailhandler quoted text fixer'),
    'description' => t('Removes leading carets from quoted text'),
    'process callback' => '_mailhandler_filter_process_quoted',
  );
  return $filters;
}

/**
 * Implements hook_coder_review_ignore().
 */
function mailhandler_coder_review_ignore() {
  return array(
    'path' => drupal_get_path('module', 'mailhandler'),
    'line prefix' => drupal_get_path('module', 'mailhandler'),
  );
}

/**
 * Implements hook_trigger_info().
 */
function mailhandler_trigger_info() {
  return array(
    'mailhandler' => array(
      'mailhandler_auth_failed' => array(
        'label' => t('When authentication fails on Mailhandler mail parsing'),
      ),
    ),
  );
}

/**
 * Implements hook_mailhandler_auth_failed().
 */
function mailhandler_mailhandler_auth_failed($message) {
  if (!module_exists('trigger')) {
    return;
  }
  $aids = trigger_get_assigned_actions('mailhandler_auth_failed');
  $context = array(
    'group' => 'mailhandler',
    'hook' => 'mailhandler_auth_failed',
    'message' => $message,
  );
  actions_do(array_keys($aids), $message, $context);
}

/**
 * Wrapper to load any class type.
 */
function mailhandler_plugin_load_class($module, $plugin, $type, $id, $args = NULL) {
  ctools_include('plugins');
  if ($class = ctools_plugin_load_class($module, $type, $plugin, 'handler')) {
    return new $class($args);
  }
}

/**
 * Wrapper to load plugins.
 *
 * @param string $type
 *   type of mailhandler plugins to retrieve.
 */
function mailhandler_get_plugins($module, $type) {
  ctools_include('plugins');
  $plugins = ctools_get_plugins($module, $type);
  $result = array();
  $weights = array();
  foreach ($plugins as $key => $info) {
    if (!empty($info['hidden'])) {
      continue;
    }
    if (!isset($info['weight'])) {
      $info['weight'] = 10;
    }
    $weights[] = $info['weight'];
    $result[$key] = $info;
  }
  array_multisort($weights, $result);
  return $result;
}

/**
 * Load a mailbox.
 *
 * @param string $mail
 *   This mailbox's name value.
 *
 * @return object
 *   A mailbox object.
 */
function mailhandler_mailbox_load($mail) {
  ctools_include('export');
  return ctools_export_crud_load('mailhandler_mailbox', $mail);
}

/**
 * Load all mailboxes.
 *
 * @param bool $show_disabled
 *   If TRUE, will return disabled mailboxes.
 *
 * @return array
 *   An array of mailbox objects.
 */
function mailhandler_mailbox_load_all($show_disabled = TRUE) {
  ctools_include('export');
  $mailboxes = ctools_export_crud_load_all('mailhandler_mailbox');
  foreach ($mailboxes as $mail => $mailbox) {
    if (isset($mailbox->disabled) && $mailbox->disabled && !$show_disabled) {
      unset($mailboxes[$mail]);
    }
  }
  return $mailboxes;
}

/**
 * Unified status- and error-reporting function.
 *
 * @param string $type
 *   One of 'status', 'warning', or 'error'.
 * @param string $message
 *   Tokenized message to display / log.
 * @param array $variables
 *   Array of sanitized variables to replace in message.
 */
function mailhandler_report($type, $message, $variables = array()) {

  // @ignore security_3
  drupal_set_message(t($message, $variables), $type);
  $mapping = array(
    'status' => WATCHDOG_INFO,
    'warning' => WATCHDOG_WARNING,
    'error' => WATCHDOG_ERROR,
  );
  watchdog('mailhandler', $message, $variables, $mapping[$type]);
  if ($type == 'error') {
    throw new Exception(t($message, $variables));
  }
}

/**
 * Filter callback.
 */
function _mailhandler_filter_process($text, $filter, $format, $langcode, $cache, $cache_id) {
  $strip_body_regex = $filter->settings['sig_separator'] . "\n";
  $sig_index = strpos($text, $strip_body_regex);
  if ($sig_index !== FALSE) {
    $text = drupal_substr($text, 0, $sig_index);
  }
  return $text;
}

/**
 * Filter callback.
 */
function _mailhandler_filter_process_quoted($text, $filter, $format, $langcode, $cache, $cache_id) {
  $lines = explode("\n", $text);
  foreach ($lines as $i => $line) {
    $lines[$i] = ltrim($line, '> ');
  }
  $text = implode("\n", $lines);
  return $text;
}

/**
 * Filter callback.
 */
function _mailhandler_filter_settings($form, &$form_state, $filter, $format, $defaults, $filters) {
  $filter->settings += $defaults;
  $elements = array();
  $elements['sig_separator'] = array(
    '#type' => 'textfield',
    '#title' => t('Signature separator'),
    '#default_value' => $filter->settings['sig_separator'],
    '#description' => t('After the first line matching this string, any further text will be hidden. A typical value is <strong>"-- "</strong> that is two dashes followed by a blank in an otherwise empty line. Leave blank to include signature text in nodes.'),
  );
  return $elements;
}

/**
 * Determines 'from' address.
 *
 * Determines 'from' address using either the mailbox setting or via the header.
 *
 * @param object $header
 *   Object message header information.
 * @param array $mailbox
 *   Array mailbox settings.
 *
 * @return array
 *   array of the 'from' address and 'from' name.
 */
function _mailhandler_get_fromaddress($header, $mailbox) {
  $fromheader = drupal_strtolower($mailbox->settings['fromheader']);
  $from = $header->{$fromheader};
  return array(
    $from[0]->mailbox . '@' . $from[0]->host,
    isset($from[0]->personal) ? $from[0]->personal : '',
  );
}

/**
 * Builds an options array for a select field from a source array.
 */
function _mailhandler_build_options($source, $key_name = 'name') {
  $options = array();
  foreach ($source as $key => $value) {
    $options[$key] = is_object($value) ? $value->{$key_name} : $value[$key_name];
  }
  return $options;
}

/**
 * Wrapper function for _mailhandler_mailbox_test_output().
 */
function _mailhandler_mailbox_test($form, &$form_state) {
  $mailbox = (object) $form_state['values'];
  return _mailhandler_mailbox_test_output($mailbox);
}

/**
 * Test the connection to a mailbox, and return HTML messages.
 */
function _mailhandler_mailbox_test_output($mailbox) {
  $output = '<div id="mailhandler_test_results" class="form-wrapper">';

  // Call the test function.
  if ($class = mailhandler_plugin_load_class('mailhandler', $mailbox->settings['retrieve'], 'retrieve', 'handler')) {
    $ret = $class
      ->test($mailbox);
  }
  foreach ($ret as $message) {
    $output .= '<div class="messages ' . $message['severity'] . '">' . $message['message'] . '</div>';
  }
  $output .= "</div>";
  return $output;
}

/**
 * Include JS in form element.
 */
function _mailhandler_include_js($form_element, &$form_state) {
  drupal_add_js(drupal_get_path('module', 'mailhandler') . '/mailhandler.js');
  return $form_element;
}

Functions

Name	Description
mailhandler_coder_review_ignore	Implements hook_coder_review_ignore().
mailhandler_ctools_plugin_directory	Implements hook_ctools_plugin_directory().
mailhandler_ctools_plugin_type	Implements hook_ctools_plugin_type().
mailhandler_filter_info	Implements hook_filter_info().
mailhandler_get_plugins	Wrapper to load plugins.
mailhandler_help	Implements hook_help().
mailhandler_init	Implements hook_init().
mailhandler_mailbox_load	Load a mailbox.
mailhandler_mailbox_load_all	Load all mailboxes.
mailhandler_mailhandler_auth_failed	Implements hook_mailhandler_auth_failed().
mailhandler_permission	Implements hook_permission().
mailhandler_plugin_load_class	Wrapper to load any class type.
mailhandler_report	Unified status- and error-reporting function.
mailhandler_trigger_info	Implements hook_trigger_info().
_mailhandler_build_options	Builds an options array for a select field from a source array.
_mailhandler_filter_process	Filter callback.
_mailhandler_filter_process_quoted	Filter callback.
_mailhandler_filter_settings	Filter callback.
_mailhandler_get_fromaddress	Determines 'from' address.
_mailhandler_include_js	Include JS in form element.
_mailhandler_mailbox_test	Wrapper function for _mailhandler_mailbox_test_output().
_mailhandler_mailbox_test_output	Test the connection to a mailbox, and return HTML messages.

Constants

Name	Description
MAILHANDLER_MENU_PREFIX