modules/mailout/mailout.module

<?php
// $Id$

/**
 * @file mailout.module
 *   mailout module to send email newsletters to an uploaded CSV list
 */

/**
 * Implementation of hook_menu 
 */
function mailout_menu($may_cache){
  $items = array();
  if ($may_cache) {
    $items[] = array(
      'path' => 'admin/content/mailout', 
      'callback' => 'mailout_send',      
      'title' => t('Mailout'),      
      'access' => user_access('send mailout'),
      'type' => MENU_ITEM_GROUPING
    );        
    $items[] = array('path' => 'admin/content/mailout/send',
      'title' => t('Send Mailout'),
      'callback' => 'mailout_send',
      'type' => MENU_NORMAL_ITEM,
      'access' => user_access('send mailout'),      
      'weight' => 1); 
    $items[] = array(
      'path' => 'mailout/stats_update', 
      'callback' => 'mailout_stats_update',
      'access' => TRUE,
      'type' => MENU_CALLBACK
    );    
    $items[] = array(
      'path' => 'admin/content/mailout/stats', 
      'title' => t('Mailout Stats'),      
      'callback' => 'mailout_stats',
      'access' => user_access('view mailout stats'), 
      'type' => MENU_NORMAL_ITEM
    );           
    $items[] = array(
      'path' => 'admin/content/mailout/run_cron',
      'callback' => 'mailout_run_cron',
      'access' => TRUE,
      'type' => MENU_CALLBACK
    );    
  }
  return $items;	
}

/**
 * Implementation of hook_node_info()
 */
function mailout_node_info() {
  
  return array(
    'mailout_template' => array(
      'name' => t('Mailout Template'),
      'module' => 'mailout_template',
      'description' => t("A Mailout Template type defines an email template that can be used to send a mailout to an address list."),
      'has_title' => TRUE,
      'title_label' => 'Template Name',
      'has_body' => TRUE,
      'body_label' => 'Mail Body',
    )  
  );
}

/**
 * Implemenation of hook_perm() 
 */
function mailout_perm(){
  return array('administer mailout_templates', 'administer address_lists', 'send mailout', 'view mailout stats');
}

/**
 * Implementation of hook_access() 
 * for content type mailout_template
 */
function mailout_template_access($op, $node){

  switch ($op) {
    case "create":
    case "delete":
    case "update":
    case "view":
      return user_access('administer mailout_templates');      
      break;
  }  
  
}

/**
 * implementation of hook_form() 
 * for content type mailout_template 
 */
function mailout_template_form($node){
  $type = node_get_types('type', $node);
 
  $form['title'] = array(
    '#type'=> 'textfield',
    '#title' => check_plain($type->title_label),
    '#default_value' => $node->title,
    '#required' => TRUE,
  );
  $form['email_from'] = array(
    '#type'=> 'textfield',
    '#title' => t('Mail From Address'),
    '#default_value' => $node->email_from,
    '#required' => FALSE,
  );  
  $form['email_subject'] = array(
    '#type'=> 'textfield',
    '#title' => t('Mail Subject'),
    '#default_value' => $node->email_subject,
    '#required' => FALSE,
  );    
  $form['body'] = array(
    '#type' => 'textarea',
    '#title' => check_plain($type->body_label),
    '#rows' => 10,
    '#default_value' => $node->body,
    '#required' => FALSE,
  );
  $form['email_header'] = array(
    '#type' => 'textarea',
    '#title' => t('Mail Header'),
    '#rows' => 10,
    '#default_value' => $node->email_header,   
    '#required' => FALSE,
  );
  $form['email_footer'] = array(
    '#type' => 'textarea',
    '#title' => t('Mail Footer'),
    '#rows' => 10,
    '#default_value' => $node->email_footer,     
    '#required' => FALSE,
  );    
  
  return $form;
}

/**
 * knows how to take form values (file, addresses field etc.)
 * and return all addresses back in a | delimited list
 *
 * @param unknown_type $form_values
 * @return unknown
 */
function all_addresses($form_values, $delete_file = FALSE){

       //initialize arrays to hold addresses before merge
      $address_list = array();
      $form_address_list = array();
      $role_address_list = array();
      $list_address_list = array();
      $file_address_list = array();     
  
      //add addresses from specified roles
      if(count($form_values['address_roles'])){
        
        //if all users, get all user email addresses
        if($form_values['address_roles'][2] != 0){
          $sql = "SELECT distinct mail FROM {users}";
          $result = db_query($sql);
        }
        //else get users for specified roles
        else {
          $sql = "SELECT distinct mail FROM {users} JOIN {users_roles} on users.uid = users_roles.uid WHERE users_roles.rid IN (%s)";
          $result = db_query($sql, implode(",",$form_values['address_roles']));
        }   

        while($row = db_fetch_array($result)){
          array_push($role_address_list, $row['mail']);
        }
        
        //merge addresses
        $address_list = array_merge($address_list, $role_address_list);
      }
      

      //add addresses from specified mailout lists
      if(count($form_values['address_lists'])){
        
        $sql = "SELECT distinct email FROM {mailout_list_address} WHERE list_id IN (%s)";
        $result = db_query($sql, implode(",", $form_values['address_lists']));
        while($row = db_fetch_array($result)){
          array_push($list_address_list, $row['email']);
        }
        
        //merge addresses
        $address_list = array_merge($address_list, $list_address_list);
      }     
      
      //array to hold allowed file extensions
      $allowed_extensions = array('CSV');
     
      // Check for a new file upload.
      if ($file = file_check_upload('address_file')) {
        
        //get file extension
        $file_extension = array_pop(explode('.',$file->filename));
            
        //make sure uploaded file is allowed extension
        if(in_array(strtoupper($file_extension), $allowed_extensions)){
          
          //open file and add all addresses to $address_list array
          $handle = fopen($file->filepath, "r");
          $message_count = 0;
          while (($data = fgetcsv($handle, 1000, ",")) !== FALSE) {
              array_push($file_address_list, $data[0]);
          }
          fclose($handle);
          
          //delete file
          if($delete_file)
            file_delete($file->filepath);
        
        }
        else {
          form_set_error('file', t('Uploaded file must be a .CSV file.'));     
        }
      }

      //merge addresses
      $address_list = array_merge($address_list, $file_address_list);
      
      //get addresses from form field into array
      if($form_values['address_field']){
        
        //do gmail replacement
        $pattern = "#\"(.*?)\" <(.*?)>#"; 
        $replacement = '$2'; 
        $form_addresses = preg_replace($pattern, $replacement, $form_values['address_field']);

        //do splitting
        $form_addresses = str_replace("\r", "", $form_addresses);
        $form_addresses = str_replace("\n", "|", $form_addresses);        
        $form_addresses = str_replace(" ", "|", $form_addresses);    
        $form_addresses = str_replace(",", "|", $form_addresses);  
        $form_addresses = str_replace(";", "|", $form_addresses);
        $form_address_list = explode("|", $form_addresses);                    
      }
      
      //merge addresses
      $address_list = array_merge($address_list, $form_address_list);
     
      //remove blanks
      foreach($address_list as $key => $value) {
        if($value == "" || $value == " " || is_null($value)) {
          unset($address_list[$key]);
        }
      }
      
      if(count($address_list))
        return implode("|", array_unique($address_list)); 
      else 
        return 0;
}

/**
 * implementation of hook_form_alter 
 * sets promote to front page value to 0 for mailout_template
 *
 * @param unknown_type $form_id
 * @param unknown_type $form
 */
function mailout_form_alter($form_id, &$form){

  //please don't promote my types to front page
  if($form['type']['#value'] == 'mailout_template' || $form['type']['#value'] == 'address_list'){
    $form['options']['promote']['#default_value'] = 0;
  }
  
}

/**
 * mailout_stats knows how to display statistics
 * about mailouts that have been sent
 *
 */
function mailout_stats(){

  $header_row = array('ID', 'Subject', 'Messages', 'Sent', 'Read', 'Timestamp');
  //get mailout stats
  $result = db_query('SELECT l.id, l.email_subject, count(ml.id) as num_mails, sum(case when ml.sent = 1 then 1 else 0 end) as sent, sum(case when ml.opened = 1 then 1 else 0 end) as opened, l.id, l.timestamp as timestamp FROM {mailout_log} as l join {mailout_message_log} as ml on ml.mailout_log_id = l.id GROUP BY l.id ORDER BY timestamp desc');
  
  $table_rows = array();
  while ($row = db_fetch_array($result)) {
    $table_rows[] = $row;
  }
  
  $output = theme('mailout_stats', $table_rows, $header_row);

  return $output;
}

/**
 * mailout_stats_update() gets called when a user opens an email sent via
 * a mailout. The mailout includes 1x1 image whose source
 * maps to this namespace and in turn updates the mailout_message_log
 * table, setting opened = 1 where the email address and mailout
 * id equal the ones requested in the URL like 
 * /mailout/stats_update/email@address.com/3/image.jpg
 *
 */
function mailout_stats_update(){
  
  if(($email_address = arg(2)) && ($mailout = arg(3))){
    db_query("UPDATE {mailout_message_log} SET opened = 1 WHERE mailout_log_id = %d AND email_to = '%s'",
      $mailout, $email_address);
    
    return "$email_address marked as open for mailout: $mailout.";
  }
  
  return "Arguments not valid";
}

/**
 * Implementation of hook_cron()
 * send emails that need to be sent
 */
function mailout_cron(){

  global $base_url; 
  
  //get mailout stats
  $result = db_query('SELECT ml.id, l.id as log_id, ml.email_to, l.email_headers, l.email_subject, l.email_body, l.email_from FROM mailout_message_log AS ml JOIN mailout_log AS l ON ml.mailout_log_id = l.id WHERE sent = 0 AND l.scheduled < %d', time());
  
  while ($data = db_fetch_array($result)) {

    //unserialize the headers
    $email_headers = unserialize($data['email_headers']);
    
    //add custom tracking image to each email
    $final_email_body = $data['email_body']."<img src=\"$base_url/mailout/stats_update/$data[email_to]/$data[log_id]/image.jpg\" width=\"0\" height=\"0\">";    
   
    //send mail
    drupal_mail($data['id'], $data['email_to'], $data['email_subject'], $final_email_body, $data['email_from'], $email_headers);               
    db_query('UPDATE {mailout_message_log} SET sent = 1 WHERE id = %d', $data['id']);
  }        
 
}


/**
 * Menu callback: run cron manually.
 */
function mailout_run_cron() {
   // Run cron manually
   if (drupal_cron_run()) {
     drupal_set_message(t('Cron ran successfully.'));
   }
   else {
     drupal_set_message(t('Cron run failed.'));
   }

   drupal_goto('admin/content/mailout/stats');
}
/**
 * callback for mailout/send
 *
 * @return $form
 */
function mailout_send(){
  return drupal_get_form('mailout_form');
}

/**
 * multi step form for sending a mailout
 *
 * @param unknown_type $form_values
 * @return $form
 */
function mailout_form($form_values = NULL){
  
  if(!isset($form_values)){
    $step = 1;
    
    //session variable to hold email addresses for all_addresses
    $_SESSION['mailout_all_addresses'] = "";    
  }  
  else {
    $step = $form_values['step'] + 1;
  }

  if($step == 2 && !$_SESSION['mailout_all_addresses']){
    $_SESSION['mailout_all_addresses'] = all_addresses($form_values, TRUE);
  }
  
  $form['#attributes'] = array('enctype' => "multipart/form-data");  
  
  //hidden field to hold step
  $form['step'] = array(
    '#type' => 'hidden',
    '#value' => $step,
  );  

  switch ($step) {
    case 1:
      //get all mailout templates  
      $mailout_templates = array('0' => " - No Template - ");
      $result = db_query('SELECT n.nid, n.title FROM {mailout_template} as m INNER JOIN node as n ON m.nid = n.nid ORDER BY n.title');
      while ($row = db_fetch_array($result)) {
        $nid = $row['nid'];
        $title = $row['title'];
        
        $mailout_templates[$nid] = $title;
      }
  
      $form['mailout_template_id'] = array(
        '#type' => 'select',
        '#title' => t('Mailout Template'),
        '#options' => $mailout_templates,
        '#required' => FALSE,
        '#description' => t('Select a Mailout Template for the Mailout. <a href="../../../node/add/mailout-template">Create New Template</a>'),
      );

      $form['schedule_date'] = array(
        '#type' => 'date',
        '#title' => t('Scheduled Date'),
        '#description' => t("Schedule mailout to be sent at some date in the future"),
        '#required' => FALSE,
      );      
      
      $form['address_field'] = array(
        '#type' => 'textarea',
        '#title' => t('Email Addresses'),
        '#rows' => 4,
        '#default_value' => $mailout_node->body,
        '#description' => t("Dump email addresses here. Comma delimited, space delimited, or one per line."),        
        '#required' => FALSE,
      ); 
      
      //get all roles except anonymous and authenticated, set our own All Users 
      //in place of authenticated
      $role_array = array('2' => 'All Users');
      $sql = "SELECT rid, name FROM {role} WHERE rid > 2 ORDER BY name, rid";
      $result = db_query($sql);
      while($row = db_fetch_array($result)){
        $role_id = $row['rid'];
	    $role_name = $row['name'];
        $role_array[$role_id] = $role_name;
      }
      
      //this field allows sending of mailout to all users of selected role or all users
      $form['address_roles'] = array(
        '#type' => 'checkboxes',
        '#title' => t('Send to Role(s)'),
        '#options' => $role_array,
        '#description' => t("Send mailout to selected user roles"),      
        '#required' => FALSE,
       );  
 
       //build options list of all mailout lists
      $list_array = array();
      $sql = "SELECT id, list_name FROM {mailout_list} ORDER BY list_name";
      $result = db_query($sql);
      while($row = db_fetch_array($result)){
        $list_id = $row['id'];
	    $list_name = $row['list_name'];
        $list_array[$list_id] = $list_name;
      }
      
      //this field allows sending of mailout to mailout lists
      if(count($list_array)){
        $form['address_lists'] = array(
         '#type' => 'checkboxes',
         '#title' => t('Send to Mailout List(s)'),
         '#options' => $list_array,
         '#description' => t("Send mailout to one or more mailout lists"),        
         '#required' => FALSE,
        );          
      }
     
      // file upload field
      $form['address_file'] = array(
        '#type' => 'file',
        '#title' => t('CSV Address List'),
        '#size' => 40,
        '#default_value' => '', 
        '#description' => t("Please browse and upload a .CSV email list"),      
        '#required' => FALSE,
      );   
           
      // This part is important!
      $form['#multistep'] = TRUE;
      $form['#redirect'] = FALSE;
       
      $form['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Submit'),
      );      
    break;

    case 2:
      
      $mailout_node = node_load($form_values['mailout_template_id']);
   
      $form['all_addresses'] = array(
        '#type' => 'hidden',
        '#value' => $_SESSION['mailout_all_addresses'],
      ); 
      
      $form['scheduled_timestamp'] = array(
        '#type' => 'hidden',
        '#value' => mktime(0,0,0,$form_values['schedule_date']['month'],$form_values['schedule_date']['day'],$form_values['schedule_date']['year']),     
      );

      $form['mailout_template_id'] = array(
        '#type' => 'hidden',
        '#value' => $form_values['mailout_template_id'],
      );  
      $form['email_from'] = array(
        '#type'=> 'textfield',
        '#title' => t('Mailout From Address'),
        '#default_value' => $mailout_node->email_from,
        '#required' => TRUE,
      );  
      $form['email_subject'] = array(
        '#type'=> 'textfield',
        '#title' => t('Mailout Subject'),
        '#default_value' => $mailout_node->email_subject,
        '#required' => TRUE,
      );    
      $form['body'] = array(
        '#type' => 'textarea',
        '#title' => t('Mailout Body'),
        '#rows' => 10,
        '#default_value' => $mailout_node->body,
        '#required' => FALSE,
      );      
      
      // This part is important!
      $form['#multistep'] = TRUE;
      $form['#redirect'] = FALSE;
     
      $form['submit'] = array(
        '#type' => 'submit',
        '#value' => t('Send Mailout'),
      );      
      //subject / from / body fields          
      break;
  }

  return $form;  
  
}

/**
 * implementation of hook_validate for mailout_form
 */
function mailout_form_validate($form_id, $form_values){
  
  if($form_values['step'] == 1){
    $all_addresses = all_addresses($form_values);

    if($all_addresses){
      $num_addresses = count(explode("|",$all_addresses));
      drupal_set_message("Mailout will be sent to ".$num_addresses." recipients.", "status");
    }
    else {
      form_set_error("address_field", "No email addresses specified through any method.");
    }
  }
}

/**
 * implementation of hook_submit()
 * used for implementation of multi step form
 *
 * @param unknown_type $form_id
 * @param unknown_type $form_values
 */
function mailout_form_submit($form_id, $form_values) {

  $final_step = 2;
  
  //if first step, get emails and file emails together into hidden field
  if($form_values['step'] == 1){
  
    
  } else if ($form_values['step'] == $final_step) {

    //load address list
    $address_list = explode("|", $form_values['all_addresses']);
    
    //load address list
    $mailout_template = node_load($form_values['mailout_template_id']);

    //build headers and serialize
    $headers['Content-Type'] = " text/html; charset=utf-8";
    $headers["MIME-Version"] = '1.0';
    $headers["Content-Transfer-Encoding"] = '8bit'; 
    $serialized_headers = serialize($headers);
      
     //build message & include stat track line
    $email_body = $mailout_template->email_header;
    $email_body .= $form_values['body'];
    $email_body .= $mailout_template->email_footer;   
    
    //insert db record for send
    db_query("INSERT INTO {mailout_log} (mailout_template_id, email_headers, email_subject, email_from, email_body, scheduled) VALUES (%d, '%s', '%s', '%s', '%s', %d)", $form_values['mailout_template_id'], $serialized_headers, $form_values['email_subject'], $form_values['email_from'], $email_body, $form_values['scheduled_timestamp']);

    //get log_id just inserted
    $result = db_query('SELECT MAX(id) as max_id FROM {mailout_log}');
    $row = db_fetch_array($result);
    $max_id = $row['max_id'];
    
    $message_count = 0;
    foreach ($address_list as $key=>$value) {
 
      //insert db record for each insert
      db_query("INSERT INTO {mailout_message_log} (mailout_log_id, email_to) VALUES (%d, '%s')", $max_id, $value);
         
      $message_count++; 
    
    }
    
    //output details
    drupal_set_message("Mailout scheduled to send to $message_count addresses on next cron run.<br>".l('Click here to run cron now', 'admin/content/mailout/run_cron'));
  }
}

/**
 * Implementation of hook_insert()
 * for content type mailout_template
 */
function mailout_template_insert($node){
  db_query("INSERT INTO {mailout_template} (nid,vid,email_header,email_footer,email_from,email_subject) VALUES (%d, %d, '%s', '%s', '%s', '%s')",
    $node->nid, $node->vid, $node->email_header, $node->email_footer, $node->email_from, $node->email_subject);
}

/**
 * Implementation of hook_update()
 * for content type mailout_template
 */
function mailout_template_update($node){
  if($node->revision){
    mailout_template_insert($node);
  }
  else {
    db_query("UPDATE {mailout_template} SET email_header = '%s', email_footer = '%s', email_from = '%s', email_subject = '%s' WHERE vid = %d",
      $node->email_header, $node->email_footer, $node->email_from, $node->email_subject, $node->vid);
  }
}

/**
 * Implementation of hook_delete()
 * for content type mailout_template
 */
function mailout_template_delete($node){
  db_query("DELETE FROM {mailout_template} WHERE nid = %d", $node->nid);
}

/**
 * Implementation of hook_load()
 * for content type mailout_template
 */
function mailout_template_load($node){
  $additions = db_fetch_object(db_query('SELECT email_header, email_footer, email_from, email_subject FROM {mailout_template} WHERE vid = %d', $node->vid));
  return $additions;
}

/**
 * Implementation of hook_block() to provide mailout list signup blocks
 *
 */
function mailout_block($op = 'list', $delta = 0, $edit = array()) {
  
  //return list of blocks
  if ($op == 'list') {

    //get all mail lists
    $sql = "SELECT id, list_name FROM mailout_list ORDER BY list_name";
    $result = db_query($sql);
   
    while($row = db_fetch_array($result)) {   
      $list_id = $row['id'];
      $list_name = $row['list_name'];
      
      $blocks[$list_id] = array('info' => t('Subscribe to '.$list_name));
    }
    
    return $blocks;
  }
  //return block view content
  else if ($op == 'view') {

    $sql = "SELECT id, list_name FROM mailout_list WHERE id = %d ORDER BY list_name";
    $result = db_query($sql, $delta);
    $row = db_fetch_array($result);
    $list_name = $row['list_name']; 
    $list_id = $row['id'];  
      
    $block = array('subject' => t('Subscribe to '.$list_name), 'content' => mailout_display_subscribe_block($list_id, $list_name));
     
    return $block;  
  
  }
}

function mailout_display_subscribe_block($list_id, $list_name){
  return drupal_get_form('subscribe_box_form', $list_id, $list_name);   
}

function subscribe_box_form($list_id, $list_name){

  $form['list_id'] = array(
    '#type' => 'hidden',
    '#value' => $list_id,
  );  
  $form['email'] = array(
    '#type'=> 'textfield',
    '#title' => t('Email'),
    '#size' => 20,
    '#default_value' => '',
    '#required' => TRUE,
  );   
  $form['name'] = array(
    '#type'=> 'textfield',
    '#title' => t('Name'),
    '#size' => 20,
    '#default_value' => '',
    '#required' => TRUE,
  );  
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Subscribe'),
  );   
  
  return $form;

}

function subscribe_box_form_submit($form_id, $form_values){
  $sql = "INSERT INTO mailout_list_addresses(email,list_id) VALUES ('%s', %d)";
  $result = db_query($sql, $form_values['email'], $form_values['list_id']); 
}

function theme_subscribe_box_form($form, $list_id, $list_name){

  $return_data = "<div id=\"subscribe_box_form_$list_id\" class=\"subscribe_box_form\">";
  $return_data .= "<div class=\"subscribe_box_form_title\">Subscribe to $list_name</div>";
  //$return_data .= drupal_get_form('subscribe_box_form', $list_id, $list_name);
  $return_data .= drupal_render($form);
  $return_data .= "</div>";
  
  return $return_data; 
}

/**
 * Theme function to theme the stats page/table
 *
 * @param $rows 
 *   table rows to theme
 * @param $headers
 *   table headers to theme
 */
function theme_mailout_stats($rows, $headers){
  return theme_table($headers, $rows);
}