mailinglist.module

Go to the documentation of this file.

<?php
/******************************************************************************/
/* Drupal hooks                                                               */
/******************************************************************************/

function mailinglist_permission() {
  $lists = mailinglist_list_load_all(false);
  $opers = mailinglist_operation_load_all();

  $permissions = array(
    'administer mailinglist' => array(
      'title' => t('Administer Mailinglist mailboxes'),
    ),
  );
  foreach ($lists as $index => $list) {
    $permissions['mailinglist ' . $index] = array(
      'title' => t('Access ' . $list->admin_title),
    );
    foreach ($opers as $oindex => $oper) {
      $permissions['mailinglist ' . $index . ' ' . $oindex] = array(
        'title' => t($list->admin_title . ' ' . $oper->plugin['name']),
      );
    }
  }
  return $permissions;
}

function mailinglist_help($path, $arg) {
  switch ($path) {
    case 'admin/help#mailinglist':
      $help = file_get_contents( dirname(__FILE__) . "/INSTALL.txt");
      return _filter_autop($help);
      break;
    case 'admin/config/system/mailinglist/list/add':
      return t('Add help here');
  }
}

function mailinglist_menu() {
  $base = variable_get('mailinglist_base', 'mailinglist');
  $items = array(
  // User Pages
    $base => array(
      'title' => 'Mailing Lists',
      'description' => 'Entry page for Mailinglist Module',
      'type' => MENU_CALLBACK,
      'page callback' => '_mailinglist_pagecallback',
      'page arguments' => array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10),
      'access arguments' => array('access content'),
      'file' => 'mailinglist.pagecallback.inc',
    ),
    $base . '/%mailinglist_list' => array(
      'title' => 'MailingList Page',
      'description' => 'Entry page for Mailinglist Module',
      'type' => MENU_CALLBACK,
      'page callback' => '_mailinglist_list_pagecallback',
      'page arguments' => array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10),
      'access arguments' => array('access content'),
      'file' => 'mailinglist.pagecallback.inc',
    ),
    $base . '/%mailinglist_list/%mailinglist_operation' => array(
      'title' => 'Mailing Lists Operation',
      'description' => 'Manage Mailing Operation Page',
      'type' => MENU_NORMAL_ITEM,
      'page callback' => 'drupal_get_form',
      'page arguments' => array('mailinglist_operation_form', 1, 2, 3, 4, 5, 6, 7, 8, 9, 10),
      'access arguments' => array('access content'),
      'file' => 'mailinglist.pagecallback.inc',
    ),
    // Admin Pages
    'admin/config/system/mailinglist' => array(
      'title' => 'Mailing Lists Configuration',
      'description' => 'Manage Mailing List Interface',
      'type' => MENU_NORMAL_ITEM,
      'page callback' => 'drupal_get_form',
      'page arguments' => array('_mailinglist_config_form'),
      'access arguments' => array('administer mailinglist'),
      'file' => 'mailinglist.admin.inc',
    ),
    'admin/config/system/mailinglist/config' => array(
      'title' => 'Config',
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'page callback' => 'drupal_get_form',
      'page arguments' => array('_mailinglist_config_form'),
      'access arguments' => array('administer mailinglist'),
      'file' => 'mailinglist.admin.inc',
    ),
  );
  return $items;
}

function mailinglist_cron_queue_info() {
  $queue = array(
    'mailinglist_message' => array(
      'worker callback' => 'mailinglist_message_callback',
      'time' => '20',
    ),
  );
  return $queue;
}


function mailinglist_cron() {

  $boxes = mailinglist_mailbox_load_all(false);
  _mailinglist_mailbox_scan();
  foreach ($boxes as $index => $box) {
//    if (isset($list1->operations['members']) && $list1->operations['members']) {
//      mailinglist_members_scan($list1);
//    }
  }
}

/*
function hook_node_info() {
return array(
  machine_name_for_node_type => array(
    'name' => 'Human Readable Name',
    'base' => 'base string to build callback function name (mailinglist_nodetype)',
    'description' => 'Brief Description',
    'help' => '(opt) Help displayed when creating nodes',
    'has_title' => TRUE,  //(or FALSE) does type have a "title" FIELD.
    'title_lable' => 'Label for Title Field',
    'locked' => TRUE, //(or FALSE), can machine name be changed in admin interface
  ),
  ...
);

// displayed to create/edit a node, return the form
function hook_form($node, &$form_state) {
}

might just be:
  return node_content_form($node, $form_state);


if node as a non-empty nid member, then node will update that nid.

function hook_insert($node){
  called by node_save() after node inserted into node table and before
}

function hook_update($node) {
  like above but for an update
}

function hook_delete($node) {
  delete specified node
}

function hook_load($nodes) {
$nodes is an array, fill in the elements with the node data based on the keys.

Something like:
 $result = db_query('SELECT nid, foo FROM {mytable} WHERE nid IN (:nids)', array(':nids' => array_keys($nodes)));
  foreach ($result as $record) {
    $nodes[$record->nid]->foo = $record->foo;
  }
}
*/

/******************************************************************************/
/* mbox file scanning routines                                                */
/******************************************************************************/

function _mailinglist_file_path() {
  // Get path to store files for processing
  $path = variable_get('file_private_path');
  // If we don/t have a private path, get a public one, with defualts
  if (empty($path)) {
    $path = variable_get('file_public_path', conf_path() . '/files');
  }
  // Update to make absolute, and our sub directory
  $path = DRUPAL_ROOT . '/' . $path . '/mailinglist';
  $flag = file_prepare_directory($path, FILE_CREATE_DIRECTORY | FILE_MODIFY_PERMISSIONS);
  return $path;
}

function _mailinglist_base_filename($path) {
  $base = _mailinglist_file_path() . '/';
  return str_replace($base, '', $path);
}

function _mailinglist_mailbox_scan() {
  _mailinglist_maildir_scan();

  $boxes = mailinglist_mailbox_load_all(false);
  foreach ($boxes as $index => $box) {
//    dpm($box, $index);
  }
}

function _mailinglist_maildir_scan() {
  $queue = DrupalQueue::get('mailinglist_message');
  $path = _mailinglist_file_path();
  // Get the mailbox we are currently processing
  $file = variable_get('mailinglist_mailbox_current', FALSE);

  if ($file == FALSE) {
    if($queue->numberOfItems() > 100) {
      return; // If behind, don't start up a new file
    }
    $files = file_scan_directory($path, '/.*/');
    ksort($files);
    if (empty($files)) {
      dpm('Nothing', 'mailinglist_maildir_scan');
      return; // Nothing to do
    }
    $file = array_keys($files);
    $file = $file[0];

    $handle = fopen($file, 'r');
    fseek($handle, 0, SEEK_END);
    $end = ftell($handle);

    $local = substr($file, strlen($path)+1);
    $pos = strpos($local, '/');
    if ($pos > 0) {
      $listname = substr($local, 0, $pos);
    }
    else {
      $listname = FALSE;
    }
    watchdog('Mailinglist', 'Starting @file (@msg) @list',
      array('@msg' => $end,
            '@file' => _mailinglist_base_filename($file),
            '@list' => $listname),
      WATCHDOG_NOTICE);
    dpm($listname, 'list');
    $offset = 0;
    variable_set('mailinglist_mailbox_current', $file);
    variable_set('mailinglist_mailbox_current_offset', $offset);
    variable_set('mailinglist_mailbox_current_list', $listname);
    variable_set('mailinglist_mailbox_current_max', $end);
  }
  else {
    if($queue->numberOfItems() > 1000) {
      return; // If far behind, don't queue up more from file
    }
    // Continuing with a file, get rest of details.
    $offset = variable_get('mailinglist_mailbox_current_offset');
    $listname = variable_get('mailinglist_mailbox_current_list');
    $msgcnt = variable_get('mailinglist_mailbox_current_max');
  }

  if ($listname) {
    $list = mailinglist_list_load($listname);
  }
  else {
    $list = FALSE;
  }
  if ($list == FALSE) {
    $lists = mailinglist_list_load_all(FALSE);
  }

  $offset = _mailinglist_mailbox_process($list, $file, $offset);

  if ($offset === FALSE) {
    variable_set('mailinglist_mailbox_current', FALSE);
    variable_set('mailinglist_mailbox_current_offset', 0);
  }
 else {
    dpm($offset);
    variable_set('mailinglist_mailbox_current_offset', $offset);
  }
}

function _mailinglist_mailbox_process($list, $file, $offset) {
  $time = time();
  $queue = DrupalQueue::get('mailinglist_message');
  $handle = fopen($file, 'r');
  if (!$handle) {
    // File not found
    watchdog('Mailinglist', 'File not found @file',
      array('@file' => _mailinglist_base_filename($file)),
      WATCHDOG_NOTICE);
    dpm($file, 'File Not found');
    fclose($handle);
    return FALSE;
  }
  fseek($handle, $offset);

  $fromline = fgets($handle);
  $cnt = 0;
  while( time() < $time+20 && $cnt < 1000) {
    $cnt = $cnt + 1;
    $msg = "";
    while (1) {
      // Remember where we were if we are now done.
      $offset = ftell($handle);
      $line = fgets($handle);
      if ($line === FALSE || substr($line, 0, 5) == 'From ') {
        $fromline = $line;
        break; // message done
      }
      $msg .= $line;
    }
    if ($msg == "" && $fromline == FALSE) {
      watchdog('Mailinglist', 'End of File @file',
        array('@file' => _mailinglist_base_filename($file)),
        WATCHDOG_NOTICE);
      dpm('End of File: ' . $file);
      unlink($file);
      return FALSE;
    }
    $msg = new MailinglistMessage($msg);
    $headers = $msg->headers();
    if(!isset($headers['From']) || !isset($headers['Date']) || !isset($headers['Subject'])){

      watchdog('Mailinglist', 'Bad message @file @offset @from MSG: @msg' ,
        array('@file' => _mailinglist_base_filename($file),
          '@offset' => $offset,
          '@from' => $fromline,
          '@msg' => check_plain(print_r($msg, TRUE)),
        ),
        WATCHDOG_ERROR);
      continue;
    }
    $from = $msg->header('From');
    if (is_array($from)) {
      $from = $from[0];
    }
    if (strpos($from, '@') == FALSE) {
      // obfuscated from line from archives
      $from = str_replace(' at ', '@', $from);
      $msg->setHeader('From', $from);
    }

    if ($list) {
      // List Specific, give to that list, assume it is to be archived
      $msg->setHeader('XX-List', $list->admin_name);
      $msg->setHeader('XX-Archive', '1');
      $msg->setHeader('XX-Status', 0);
    }
    $queue->createItem($msg);
  }
  fclose($handle);
  return $offset;
}

/******************************************************************************/
/*  Message Pumping                                                           */
/******************************************************************************/

function mailinglist_message_callback($msg) {
  $listname = $msg->header('XX-List');

  if ($listname) {
    $list = mailinglist_list_load($listname);
  }
  else {
    $list = FALSE;
  }
  if($list) {
    $list->processMessage($msg);
  } else {
    // No valid list specified, check all the lists.
    $lists = mailinglist_list_load_all(FALSE);
    foreach ($lists as $list1) {
      $flag = $list1->checkMessage($msg);
    }
  }
}

/******************************************************************************/
/*  General Utility Functions                                                 */
/******************************************************************************/

function _mailinglist_encode_password($pass) {
  $seed = mt_rand(0, 255);
  $str = chr($seed);
  for ($i=0; $i < strlen($pass); $i++) {
    $seed = ($seed + ord($pass[$i])) % 256;
    $str .= chr($seed);
  }
  $encode = base64_encode($str);
  return $encode;
}

function _mailinglist_decode_password($code) {
  if (empty($code)) return $code;
  $decode = base64_decode($code);
  $seed = ord($decode[0]);
  $pass = '';
  for ($i=1; $i < strlen($decode); $i++) {
    $ch = ord($decode[$i]);
    $seed = $ch - $seed;
    if ($seed < 0) $seed += 256;
    $pass .= chr($seed);
    $seed = $ch;
  }
  return $pass;
}

function mailinglist_array_merge_recursive_distinct(array &$array1, array &$array2) {
  $merged = $array1;

  foreach ( $array2 as $key => &$value ) {
    if ( is_array ( $value ) && isset ( $merged [$key] ) && is_array ( $merged [$key] ) ) {
      $merged [$key] = mailinglist_array_merge_recursive_distinct($merged [$key], $value);
    }
    else {
      $merged [$key] = $value;
    }
  }

  return $merged;
}

/******************************************************************************/
/*  DateTime field support                                                    */
/******************************************************************************/

function _mailinglist_datetime_schema($desc) {
  if (!is_array($desc)) {
    $desc = array('description' => 'desc');
  }

  $desc['type'] = 'char';
  $desc['length'] = 19;
  return $desc;
}

function _mailinglist_datetime_format($ts) {
  $value = gmdate('Y-m-d H:i:s', $ts);
//  dpm($value . " ... " . date_iso8601($ts)); date_iso uses local timezone
  return $value;
}

function _mailinglist_datetime_ts($time) {
  return strtotime($time . " UTC");
}
function mailinglist_email_name($email, $name, $count = 0) {
  $email = strtolower($email);
  $sql = 'SELECT name_key from {mailinglist_names}
    WHERE email = :email AND name = :name';
  $result = db_query($sql, array(':email' => $email, ':name' => $name));
  $result = $result -> fetchAssoc();
  if (!$result) {
  // New Combo
    $fields = array('email' => $email, 'name' => $name);
    dpm($fields, 'New Combo');
    return (int) db_insert('mailinglist_names') -> fields($fields) -> execute();
  }
  else {
    // Existing Combo
    return (int) $result['name_key'];
  }
}

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

function mailinglist_ctools_plugin_directory($owner, $plugin_type) {
  return 'plugins/' . $owner . '/' . $plugin_type;
}

function mailinglist_ctools_plugin_type() {
  return array(
    'list' => array(),      // List Personality Modules
    'operation' => array(),    // Extension Modules
    'retrieve' => array(),  // Data Retrieval Modules
  );
}

function mailinglist_plugin_load_class($module, $type, $plugin, $class_name='handler', $args = NULL) {
  ctools_include('plugins');
  $class = ctools_plugin_load_class($module, $type, $plugin, $class_name);
  if ($class) {
    return new $class($args);
  }
}

function mailinglist_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;
}

function _mailinglist_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;
}

function _mailinglist_object_factory($schema, $data) {
  ctools_include('plugins');
  $type = FALSE;
  if (isset($data->object_type)) {
    $object_type = $data->object_type;
    $owner = $schema['export']['api']['owner'];
    $api = $schema['export']['api']['api'];
    $class_name = ctools_plugin_load_class($owner, $api, $object_type, 'handler');
    if (!class_exists($class_name)) {
      $class_name = FALSE;
      $class_name = $schema['fields']['object_type']['default'];
    }
  }
  $object = _ctools_export_unpack_object($schema, $data, $class_name);
  return $object;
}

/********* mailbox *********/

function mailinglist_mailbox_load($mbox) {
  ctools_include('export');
  $retrieve = ctools_export_crud_load('mailinglist_retrieve', $mbox);
  return $retrieve;
}

function mailinglist_mailbox_load_all($show_disabled = TRUE) {
  ctools_include('export');
  $mboxes = ctools_export_crud_load_all('mailinglist_retrieve');
  foreach ($mboxes as $email => $mbox) {
    if (isset($listdef->disabled) && $mbox->disabled && !$show_disabled) {
      unset($mboxes[$email]);
    }
  }
  return $mboxes;
}

function _mailinglist_mailbox_test($form, &$form_state) {
  $mailbox = (object)$form_state['values'];
  return _mailinglist_mailbox_test_output($mailbox);
}

function _mailinglist_mailbox_test_output($mailbox) {
  $output = '<div id="mailinglist_test_results" class="form-wrapper">';
  // Call the test function.
  if (isset($mailbox->settings['object_type'])) {
    $class = mailinglist_plugin_load_class('mailinglist', 'retrieve', $mailbox->settings['object_type'], 'handler');
    if ($class) {
      $ret = $class->test($mailbox);
      foreach ($ret as $message) {
        $output .= '<div class="messages ' . $message['severity'] . '">' . $message['message'] . '</div>';
      }
    }
  }
  $output .= "</div>";
  return $output;
}

/********* list *********/

function mailinglist_list_load($list) {
  ctools_include('export');
  $obj = ctools_export_crud_load('mailinglist_list', $list);
  return $obj;
}

function mailinglist_list_load_all($show_disabled = TRUE) {
  ctools_include('export');
  $lists = ctools_export_crud_load_all('mailinglist_list');
  foreach ($lists as $list => $listdef) {
    if (isset($listdef->disabled) && $listdef->disabled && !$show_disabled) {
      unset($lists[$list]);
    }
  }
  return $lists;
}

function mailinglist_operation_load($oper) {
  ctools_include('plugins');
  require_once(drupal_get_path('module', 'mailinglist') . '/plugins/mailinglist/operation/MailinglistOperation.class.php');
  $plugin = ctools_get_plugins('mailinglist', 'operation', $oper);
  $plugin['key'] = $oper;
  $class = ctools_plugin_get_class($plugin, 'handler');
  if (class_exists($class)) {
    $obj = new $class;
    $obj->plugin = $plugin;
  }
  else {
    $obj = NULL;
  }
  return $obj;
}

function mailinglist_operation_load_all() {
  $opers = mailinglist_get_plugins('mailinglist', 'operation');
  $ret = array();
  foreach ($opers as $key => $plugin) {
    $ret[$key] = mailinglist_operation_load($key);
  }
  return $ret;
}