mailinglist_members.module

Go to the documentation of this file.

<?php
define('MAILINGLIST_SUB_NO', 0);
define('MAILINGLIST_SUB_NOMAIL', 1);
define('MAILINGLIST_SUB_INDEX', 2);
define('MAILINGLIST_SUB_DIGEST', 5);
define('MAILINGLIST_SUB_MIME_DIGEST', 6);
define('MAILINGLIST_SUB_NORMAL', 10);

/******************************************************************************/
/* Drupal hooks                                                               */
/******************************************************************************/

function mailinglist_members_permission() {
  $permissions['administer mailinglist members'] = array(
      'title' => t('Administer Mailinglist Membership'),
  );
  $lists = mailinglist_list_load_all(false);
  foreach ($lists as $index => $list) {
      $permissions['mailinglist ' . $index . ' member details'] = array(
        'title' => t($list->admin_title . ' Member Details'),
      );
  }
  return $permissions;
}

function mailinglist_members_cron_queue_info() {
  $queue = array(
    'mailinglist_members' => array(
      'worker callback' => 'mailinglist_members_callback',
      'time' => '20',
    ),
  );
  return $queue;
}

function mailinglist_members_cron() {
  $queue = DrupalQueue::get('mailinglist_members');
  if($queue->numberOfItems() > 0) {
    // If still running, don't start more.
    return;
  }

  $lists = mailinglist_list_load_all(false);
  foreach ($lists as $index => $list) {
    if (isset($list->operations['members']) && $list->operations['members']) {
      $queue = DrupalQueue::get('mailinglist_members');
      $queue->createItem($list->admin_name); // Put item back on list if not done
    }
  }
}

/******************************************************************************/
/* Mailinglist hooks                                                          */
/******************************************************************************/

function mailinglist_members_mailinglist_list_created($list) {
  $rolename = 'Mailingling List Subscriber ' . $list->admin_name;
  if (!user_role_load_by_name($rolename)) {
    $role = new stdClass();
    $role->name = $rolename;
    user_role_save($role);
  }
  $list_schema = _mailinglist_members_list_schema($list);
  foreach ($list_schema as $table_name => $schema) {
    $ret = db_create_table($table_name, $schema);
    if ($ret) dpm($ret, $table_name);
  }
}

function mailinglist_members_mailinglist_list_delete($list) {
  $list_schema = _mailinglist_members_list_schema($list);
  foreach ($list_schema as $table_name => $schema) {
    $ret = db_drop_table($table_name);
  }

}

/******************************************************************************/

function _mailinglist_members_list_schema(MailinglistListInterface $list) {
  $list_name = $list->admin_name;
  $list_schema = array();
  $list_schema['mailinglist_members_subscribers__' . $list_name] = array(
    'description' => 'Table for holding the list of subscribers for the list ' . $list_name,
    'fields' => array(
      'sid' => array(
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'Primary Key for table',
      ),
      'email' => array(
        'type' => 'varchar',
        'length' => '255',
        'description' => 'EMail address of subscription'
      ),
      'domain' => array(
        'type' => 'varchar',
        'length' => '255',
        'description' => 'Domain of subscription (for stats)'
      ),
      'sub_type' => array(
        'type' => 'int',
        'description' => 'Type of subscription'
      ),
      'last_update' => _mailinglist_datetime_schema( array(
        'description' => 'Time of last update',
        'not null' => TRUE,
        'default' => '0000-00-00 00:00:00',
        )),
      'last_update_ind' => _mailinglist_datetime_schema( array(
        'description' => 'Time of last individual update',
        'not null' => TRUE,
        'default' => '0000-00-00 00:00:00',
        )),
      'moderated' => array(
        'type' => 'int',
        'description' => 'It the subcriber currently moderated',
        'default' => 0,
      ),
      'options' => array(
        'type' => 'text',
        'size' => 'big',
        'serialize' => TRUE,
        'description' => 'Misc. Options for Subscripton',
        'object default' => array(
        ),
      ),
    ),
    'primary key' => array('sid'),
    'unique key' => array(
      'email' => array('email'),
    ),
    'indexes' => array(
      'domain' => array('domain'),
      'last_update' => array('last_update'),
      'last_update_ind' => array('last_update_ind'),
    ),
  );
  $list_schema['mailinglist_members_subscriptions__' . $list_name] = array(
   'description' => 'Table for holding info about all subscription/unusubscription events for list',
   'fields' => array(
      'sub_key' => array(
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'Primary Key for table',
      ),
      'sid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'sid from subscribers table for this subscription',
      ),
      'first_seen' => _mailinglist_datetime_schema('Time of first appearance'),
      'subscribe' => array(
        'type' => 'int',
        'default' => 0,
        'not null' => TRUE,
        'description' => '1 if the first_seen time is the time of subscription',
      ),
      'last_seen' => _mailinglist_datetime_schema('Time of last appearance'),
      'first_unseen' => _mailinglist_datetime_schema('Time of first dis-appearance'),
    ),
    'primary key' => array('sub_key'),
    'indexes' => array(
      'first_seen' => array('first_seen'),
      'last_seen' => array('last_seen'),
      'first_unseen' => array('first_unseen'),
    ),
    'foreign keys' => array(
      'sid' => array(
        'table' => 'mailinglist_members_subscribers__' . $list_name,
        'columns' => array('sid', 'sid'),
      ),
    ),
  );
  $list->schema($list_schema, 'members');
  return $list_schema;
}

function mailinglist_members_memberid($list, $email) {
  $email = strtolower($email);
  $list_name = $list->admin_name;
  $table = 'mailinglist_members_subscribers__' . $list_name;
  $transaction = db_transaction();
  $result = db_select($table, 's')
    -> fields('s')
    -> condition('s.email', $email, '=')
    -> execute()
    -> fetchAssoc();
  if ($result === FALSE) {
    $list->log('New Member: ' . $email);
    $domain = substr($email, strpos($email, '@') +1);
    $fields = array('email' => $email, 'domain' => $domain);
    $result['sid'] = db_insert($table) -> fields($fields) -> execute();
  }
  return (int)$result['sid'];
}

function mailinglist_members_update($list, $email, $info) {
  $email = strtolower($email);
  $list_name = $list->admin_name;
  $table = 'mailinglist_members_subscribers__' . $list_name;
  $transaction = db_transaction();
  $result = db_select($table, 's')
    -> fields('s')
    -> condition('s.email', $email, '=')
    -> execute()
    -> fetchAssoc();
  if ($result == FALSE) {
    $list->log('Update: Subscriber not present: ' . $email, $list->LOG_ERROR);
    dpm($email, 'Subscriber Not Present');
  // Updating someone not present
  } else {
    $key = (int)$result['sid'];
    $newinfo['last_update'] = _mailinglist_datetime_format(time());
    foreach ($info as $field => $value) {
      switch($field) {
        case 'Type':
          $newinfo['sub_type'] = $value;
          break;
        case 'Moderated':
          $newinfo['moderated'] = $value ? 1 : 0;
          break;
        /* Keys that match */
        case 'last_update_ind':
          $newinfo[$field] = $value;
          break;
        /* All the cases we don't process as they go elsewhere */
        case 'Email':
        case 'NoMail': /* Folded into Type */
          break;
        case 'Name':
        default:
          if (!isset($newinfo['options'])) {
            if (empty($result['options'])) {
              $newinfo['options'] = array();
            } else {
              $newinfo['options'] = unserialize($result['options']);
              unset($newinfo['options']['Email']);
            }
          }
          $newinfo['options'][$field] = $value;
      }
    }

    if (isset($newinfo['options'])) {
      $newinfo['options'] = serialize($newinfo['options']);
    }
    $res = db_update($table) -> fields($newinfo) -> condition('sid', $key) -> execute();
  }
}

function mailinglist_members_update_ind($list, $email, $info) {
  $info['last_update_ind'] = _mailinglist_datetime_format(time());
  mailinglist_members_update($list, $email, $info);
}
function mailinglist_members_subscribe($list, $email, $time = FALSE) {
  if ($time === FALSE) $time = time();
  $time = _mailinglist_datetime_format($time);
  $list->log('Subscribe @time @email', $list::LOG_DEBUG,
    array('@email' => $email, '@time' => $time));
  $sid = mailinglist_members_memberid($list, $email);
  $list_name = $list->admin_name;
  $table = 'mailinglist_members_subscriptions__' . $list_name;
}

function mailinglist_members_unsubscribe($list, $email, $time = FALSE) {
  if ($time === FALSE) $time = time();
  $time = _mailinglist_datetime_format($time);
  $list->log('Unsubscribe @time @email', $list::LOG_DEBUG,
    array('@email' => $email, '@time' => $time));
  $sid = mailinglist_members_memberid($list, $email);
  $list_name = $list->admin_name;
  $table = 'mailinglist_members_subscriptions__' . $list_name;
}

function mailinglist_members_seen($list, $email, $time = FALSE) {
  $level = $list::LOG_DEBUG;
  if ($time === FALSE) $time = time();
  $time = _mailinglist_datetime_format($time);
  $sid = mailinglist_members_memberid($list, $email);
  $list_name = $list->admin_name;
  $table = 'mailinglist_members_subscriptions__' . $list_name;

  $transaction = db_transaction();

  $sql = "SELECT * FROM {" . $table . "}
            WHERE sid = :sid and (first_unseen IS NULL or first_unseen = '0000-00-00 00:00:00' or :time <= first_unseen)
            ORDER BY first_seen ASC LIMIT 1";
    $result = db_query($sql, array(':sid' => $sid, ':time' => $time)) -> fetchAssoc();
  if ($result === FALSE) {
    // No record we can update, either no record at all, or record has an unseen before now
    $list->log('Newly Seen: ' . $email);
    $result = array(
      'sid' => $sid,
      'first_seen' => $time,
      'subscribe' => 0,
      'last_seen' => $time,
      'first_unseen' => null,
    );
    $level = $list::LOG_NOTICE;
    $result['sub_key'] = db_insert($table) ->fields($result) -> execute();
  } else {
    $key = (int) $result['sub_key'];
    if ($result['first_seen'] > $time) {
      // We are before the record found.
      if ($result['subscribe'] > 0) {
        // We are before the known subsciption date of the record found, make new record.
        $ts = strtotime($result['first_seen'])-1;
        $result = array(
          'sid' => $sid,
          'first_seen' => $time,
          'subscribe' => 0,
          'last_seen' => $time,
          'first_unseen' => _mailinglist_datetime_format($ts),
        );
        $level = $list::NOTICE;
        $result['sub_key'] = db_insert($table) ->fields($result) -> execute();
      } else {
        // We are before record, but it isn't a know subscription, so extend

        $info = array(
          'first_seen' => $time,
        );
        db_update($table) -> fields($info) -> condition('sub_key', $key) -> execute();
      }
    } else if ($result['last_seen'] < $time) {
      // We are after the end of the block (and before unseen) so extend
      $info = array(
        'last_seen' => $time,
      );
      $result = db_update($table) -> fields($info) ->
        condition('sub_key', $key, '=') -> execute();
    }
  }
  $list->log('Seen @time @email', $level,
    array('@email' => $email, '@time' => $time));
}

function mailinglist_members_unseen($list, $email, $time = FALSE) {
  if ($time === FALSE) $time = time();
  $time = _mailinglist_datetime_format($time);
  $level = $list::LOG_DEBUG;
  $sid = mailinglist_members_memberid($list, $email);
  $list_name = $list->admin_name;
  $table = 'mailinglist_members_subscriptions__' . $list_name;
  $transaction = db_transaction();
  $sql = "SELECT * FROM {" . $table . "}
            WHERE sid = :sid and first_seen <= :time
            ORDER BY first_seen DESC LIMIT 1";
    $result = db_query($sql, array(':sid' => $sid, ':time' => $time)) -> fetchAssoc();

    if ($result == FALSE) {
      $list->log('Unseen too Early $time @email', $list::LOG_ERROR, array('@email' => $email, '@time' => $time));
    } else {
      $key = (int) $result['sub_key'];
      if ($time < $result['last_seen']) {
        $info = array(
          'sid' => $sid,
          'first_seen' => $result['last_seen'],
          'subscribe' => 0,
          'last_seen' => $result['first_seen'],
          'first_unseen' => $result['first_unseen'],
        );

      db_insert($table) ->fields($info) -> execute();

      $info = array(
        'last_seen' => $result['first_seen'],
        'first_unseen' => $time,
      );

      $level = $list::LOG_NOTICE;
      $result = db_update($table) -> fields($info) ->
        condition('sub_key', $key, '=') -> execute();
      } else if ($result['first_unseen'] == null || $time < $result['first_unseen']) {
      $info = array(
        'first_unseen' => $time,
      );
      $level = $list::LOG_NOTICE;
      $result = db_update($table) -> fields($info) ->
        condition('sub_key', $key, '=') -> execute();
    }
    }
  $list->log('Unseen @time @email', $level,
    array('@email' => $email, '@time' => $time));


  $table = 'mailinglist_members_subscribers__' . $list_name;
  $info = array(
    'sub_type' => MAILINGLIST_SUB_NO,
  );
  db_update($table) -> fields($info) -> condition('sid', $sid) -> execute();
}

function mailinglist_members_process_memberpage($list, $page) {
  $data = $list->getMemberPage($page);
  foreach ($data['members'] as $email => $info) {
    // skip a few problematical names that we have hit
    if(substr($email, 0, 7) == 'mailto:') continue;
    if(substr($email, -1) == '.') continue;
    mailinglist_email_name($email, $info['Name']);
    mailinglist_members_seen($list, $email);
    mailinglist_members_update($list, $email, $info);
  }
  return $data['next'];
}

function mailinglist_members_scan($list) {
  // If list hasn't been scanned before, start at beginning.
  if(!isset($list->parameters['ScanNext'])) {
    $list->parameters['ScanNext'] = FALSE;
  }

  $next = $list->parameters['ScanNext'];

  if($next === TRUE) {
    // we have finished scan, check for unprocessed subscribers
    if(!isset($list->parameters['ScanStart'])) {
      // Shouldn't happen but disable the scan.
      $list->parameters['ScanStart'] = '0000';
    }

    $sql = 'SELECT * from {mailinglist_members_subscribers__' . $list->admin_name . '}
      WHERE last_update < :time AND sub_type > 0 LIMIT 1';
    $result = db_query($sql, array(':time' => $list->parameters['ScanStart']));
    $flag = 0;
    while($row = $result -> fetchAssoc()) {
dpm($row);
      $flag = 1;
      $email = $row['email'];
      $list->log('Scan Needs Update @time @email', $list::LOG_NOTICE, array('@email' => $email, '@time' => $row['last_update']));
      _mailinglist_members_lookup($list, $email);
    }
    // If we processed no straglers, than prepare to start next round.
    if (!$flag) {
      $next = FALSE;
    }
  }
  else {
    // we are scaning, start at $next (FALSE at begining)
    if($next === FALSE) {
      $list->parameters['ScanStart'] = _mailinglist_datetime_format(time());
      $list->log('Member Scan Start',$list::LOG_NOTICE);
    }

    $next = mailinglist_members_process_memberpage($list, $next);
    if($next === FALSE) {
     $next = TRUE;
    }

  }

  // Do an update on oldest not individually updated members to fill options array
  $sql = 'SELECT * from {mailinglist_members_subscribers__' . $list->admin_name . '}
    WHERE sub_type > 0 ORDER BY last_update_ind ASC, last_update ASC LIMIT 1';
  $result = db_query($sql, array(':time' => $list->parameters['ScanStart']));
  while($row = $result -> fetchAssoc()) {
    $email = $row['email'];
    $list->log('Individual Update @time @email', $list::LOG_DEBUG,
      array('@email' => $email, '@time' => $row['last_update_ind']));
    _mailinglist_members_lookup($list, $email);
  }

  $list->parameters['ScanNext'] = $next;
  $list->log('Next: ' . serialize($next), $list::LOG_DEBUG);
  ctools_export_crud_save($list->table, $list);

  return $next !== FALSE;
}
/******************************************************************************/

function mailinglist_members_callback($listname) {
  if ($listname) {
    $list = mailinglist_list_load($listname);
  }
  else {
    $list = FALSE;
  }
  if($list) {
//    $list->log('Scanning', $list::LOG_INFO);
    if(mailinglist_members_scan($list)) {
      $queue = DrupalQueue::get('mailinglist_members');
      $queue->createItem($listname); // Put item back on list if not done
    } else {
      $list->log('Scan End', $list::LOG_INFO);
    }
  }
}



function _mailinglist_members_lookup($list, $email) {
  $info = $list->getMemberInfo($email);
  if ($info) {
    mailinglist_email_name($email, $info['Name']);
    mailinglist_members_seen($list, $email);
    mailinglist_members_update_ind($list, $email, $info);
  } else {
    mailinglist_members_unseen($list, $email);
  }
}

function mailinglist_members_mailinglist_message($msg, $list) {
  if ($msg->header('XX-Archive')) {

  }
}


/*
******************************************************************************************
CTOOLS Hooks
******************************************************************************************
*/

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