modules/emailmarketer/emailmarketer.module

<?php
/* $Id$ */

/**
 * @file
 * This module allows visitors to subscribe to Nesox Email Marketer (http://www.nesox.com/) newsletters.
 */

// Load some helper functions
require_once('emailmarketer.inc');

define('EMAILMARKETER_TABLE', 'emailmarketer');
define('EMAILMARKETER_QUEUE', 'emailmarketer_queue');

/**
* Display help and module information
*
* @param $section
*   Which section of the site we're displaying help
*
* @return
*   Help text for section
*/
function emailmarketer_help($section = '') {
  $output = '';
  switch ($section) {
    case "admin/help#emailmarketer":
      $output = '<p>'.  t('This module add a form to Drupal that allows visitors subscribe to Nesox Email Marketer newsletters. For more informations about Nesox Email Marketer visit <a href="http://www.nesox.com/">Nesox Website</a>'). '</p>';
      break;
    case "admin/settings/emailmarketer":
      $output = '<p>' . t('Below you can find the Nesox Email Marketer newsletters defined on your site. Visitors can subscribe for each of these lists depending on their roles. Each subscription list can be configured by clicking the link \'configure\'. To add a new subscription point click on <a href="@add">Add Newsletter</a>.', array('@add' => url('admin/settings/emailmarketer'))) . '</p>';
  }
  return $output;
}

/**
 * Valid permissions for this module
 *
 * @return array
 *   An array of valid permissions for the person module
 */
function emailmarketer_perm() {
  return array('administer email marketer');
}

/**
 * Menu items provided by module
 *
 * @return array
 *   An array of menu items
 */
function emailmarketer_menu($may_cache) {
  global $emailmarketer_lists;
  $items = array();
  if (!isset($emailmarketer_lists)) {
    $emailmarketer_lists = emailmarketer_list(NULL, true);
  }
  if ($may_cache) {
    $items[] = array(
      'path' => 'admin/settings/emailmarketer',
      'title' => t('Email Marketer'),
      'description' => t('Allow visitors to subscribe to Nesox Email Marketer.'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('emailmarketer_admin_overview', $emailmarketer_lists),
      'access' => user_access('administer email marketer'),
      'type' => MENU_NORMAL_ITEM,
    );
    $items[] = array(
      'path' => 'admin/settings/emailmarketer/list',
      'title' => t('List'),
      'description' => t('View the list of Email Merketer lists'),
      'callback' => 'emailmarketer_admin_overview',
      'access' => user_access('administer email marketer'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
    );
    $items[] = array(
      'path' => 'admin/settings/emailmarketer/setup',
      'title' => t('Setup'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('emailmarketer_admin_settings'),
      'type' => MENU_LOCAL_TASK,
      'weight' => 2,
      'access' => user_access('administer email marketer'),
    );
    $items[] = array(
      'path' => 'admin/settings/emailmarketer/add',
      'title' => t('Add Newsletter'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('emailmarketer_newsletter_form'),
      'type' => MENU_LOCAL_TASK,
      'weight' => 1,
      'access' => user_access('administer email marketer'),
    );
    $items[] = array(
      'path' => 'subscribe',
      'title' => t(variable_get('emailmarketer_title', 'Our Newsletters')),
      'description' => t('Allow visitors to subscribe to Nesox Email Marketer.'),
      'callback' => 'emailmarketer_page',
      'callback arguments' => array($emailmarketer_lists),
      'access' => user_access('administer email marketer') || count($emailmarketer_lists),
      'type' => MENU_SUGGESTED_ITEM,
    );
    $items[] = array(
      'path' => 'subscribe/confirm',
      'title' => t('Confirm your subscription'),
      'description' => t('You need to confirm your e-mail address.'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('emailmarketer_confirm', $emailmarketer_lists),
      'access' => user_access('administer email marketer') || count($emailmarketer_lists),
      'type' => MENU_CALLBACK,
    );
  }
  else {
    if (arg(0) == 'admin' && arg(1) == 'settings' && arg(2) == 'emailmarketer' && is_numeric(arg(3))) {
      if (isset($emailmarketer_lists[arg(3)])) {
        $items[] = array(
          'path' => 'admin/settings/emailmarketer/'. arg(3),
          'title' => t("Edit !list [!email]", array('!list' => $emailmarketer_lists[arg(3)]['name'], '!email' => $emailmarketer_lists[arg(3)]['email'])),
          'callback' => 'drupal_get_form',
          'callback arguments' => array('emailmarketer_newsletter_form', $emailmarketer_lists[arg(3)]),
          'type' => MENU_CALLBACK,
          'access' => user_access('administer email marketer')
        );
      }
    }
    if (arg(0) == 'admin' && arg(1) == 'settings' && arg(2) == 'emailmarketer' && arg(3) == 'delete' && is_numeric(arg(4))) {
      if (isset($emailmarketer_lists[arg(4)])) {
        $items[] = array(
          'path' => 'admin/settings/emailmarketer/delete/'. arg(4),
          'title' => t('Delete Email Marketer newsletter'),
          'callback' => 'drupal_get_form',
          'callback arguments' => array('emailmarketer_admin_delete', $emailmarketer_lists[arg(4)]),
          'type' => MENU_CALLBACK,
          'access' => user_access('administer email marketer')
        );
      }
    }  
    if (arg(0) == 'subscribe' && is_numeric(arg(1))) {
      $items[] = array(
        'path' => 'subscribe/'. arg(1),
        'title' => t("Subscribe to !list", array('!list' => $emailmarketer_lists[arg(1)]['name'], '!email' => $emailmarketer_lists[arg(1)]['email'])),
        'callback' => 'drupal_get_form',
        'callback arguments' => array('emailmarketer_subscribe', $emailmarketer_lists[arg(1)]),
        'type' => MENU_CALLBACK,
        'access' => (user_access('administer email marketer') || count($emailmarketer_lists[arg(1)])) && isset($emailmarketer_lists[arg(1)]),
      );
    }
    if (arg(0) == 'subscribe' && arg(1) == 'confirm' && preg_match("/[0-9a-z]{32,32}/", arg(2))) {
      $items[] = array(
        'path' => 'subscribe/confirm/'. arg(2),
        'title' => t('Confirmation'),
        'callback' => 'emailmarketer_confirmation',
        'callback arguments' => array($emailmarketer_lists),
        'type' => MENU_CALLBACK,
        'access' => user_access('administer email marketer') || count($emailmarketer_lists),
      );
    }  
  }
  return $items;

}

/**
 * Form function that allows setting of module general preferences.
 *
 * @return array
 *   A Drupal form array
 */
function emailmarketer_admin_settings() {
  $form['emailmarketer_title'] = array(
    '#type' => 'textfield',
    '#title' => t('The title of the Email Marketer subscribe block or page'),
    '#description' => t('Enter here the text that you want to serve as title in the Email Marketer block or page.'),
    '#default_value' => variable_get('emailmarketer_title', 'Our Newsletters'),
    '#maxlength' => 128
  );
  $form['message']['emailmarketer_message'] = array(
    '#type' => 'textarea',
    '#title' => t('Message displayed on Email Marketer subscribe block and page'),
    '#description' => t('Enter here the text that you want to appear in the Email Marketer block and page.'),
    '#default_value' => variable_get('emailmarketer_message', '<p>Select a newsletter to subscribe:</p>')
  );
  $form['message']['format'] = filter_form($node->format);
  return system_settings_form($form);
}

/**
 * Generate the admin list of available newsletters
 *
 * @param $lists
 *   An array of the available newsletters
 *
 * @return array
 *   A Drupal form array
 */
function emailmarketer_admin_overview($lists = NULL) {
  if (!count($lists)) {
    drupal_set_message(t('There is no Email Marketer newsletter configured. Please add one by filling the form below.'));
    drupal_goto('admin/settings/emailmarketer/add');
  }
  foreach ($lists as $id => $list) {
    if (empty($list['roles'])) {
      $roles = array();
    }
    else {
      $roles = explode('|', trim($list['roles'], '|'));
    }
    $effective_roles = array();
    foreach (user_roles() as $rid => $role_name) {
      if (in_array($rid, $roles)) {
        $effective_roles[] = $role_name;
      }
    }
    
    $effective_roles = empty($effective_roles) ? t('All roles may subscribe') : implode(', ', $effective_roles);
    
    $form[$list['email']]['id'] = array('#value' => $id);
    $form[$list['email']]['name'] = array('#value' => $list['name']);
    $form[$list['email']]['roles'] = array('#value' => $effective_roles);
    $form[$list['email']]['configure'] = array('#value' => l(t('configure'), 'admin/settings/emailmarketer/' . $id));
    $form[$list['email']]['delete'] = array('#value' => l(t('delete'), 'admin/settings/emailmarketer/delete/' . $id));
  }
  return $form;
}

/**
 * Theme function for the admin list of newsletters
 *
 * @param $form
 *   A form array
 *
 * @return text
 *   The HTML content of the form
 */
function theme_emailmarketer_admin_overview($form) {
  $rows = array();
  foreach ($form as $email => $element) {
    if (isset($element['id']) && is_array($element['id'])) { 
      $rows[] = array(
        check_plain($element['name']['#value']),
        check_plain($email),
        check_plain($element['roles']['#value']),
        drupal_render($element['configure']),
        drupal_render($element['delete'])
      );
      unset($form[$name]);
    }
  }
  $header = array(t('Name'), t('E-mail'), t('Roles'), array('data' => t('Operations'), 'colspan' => 2));
  $output = theme('table', $header, $rows);
  return $output;
}

/**
 * The form where to add or edit a newsletter
 *
 * @param $list
 *   A newsletter record
 *
 * @return array
 *   A Drupal form array
 */
function emailmarketer_newsletter_form($list = NULL) {
  $field_opts = array('0' => t('Not used'), '1' => t('Optional'), '2' => t('Required'));
  $fields = emailmarketer_fields();
  if ($list && $list['fields_fixed'] != '') {
    $list_fields = unserialize($list['fields_fixed']);
  }
  else {
    $list_fields = array();
  }
  $form['general'] = array(
    '#type' => 'fieldset',
    '#title' => t('General list informations'),
    '#description' => t('Enter general informations for this Email Marketer newsletter.'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE
  );
  $form['general']['email'] = array(
    '#type' => 'textfield',
    '#default_value' => $list['email'],
    '#title'  => t('List e-mail'),
    '#description' => t('Enter the e-mail address of the list.'),
    '#maxlength' => 255,
    '#required' => TRUE
  );
  $form['general']['name'] = array(
    '#type' => 'textfield',
    '#default_value' => $list['name'],
    '#title'  => t('Email Marketer newsletter title'),
    '#description' => t('Enter a name or title for this Email Marketer list.'),
    '#required' => TRUE,
    '#maxlength' => 255
  );
  $form['general']['version'] = array(
    '#type' => 'textfield',
    '#default_value' => $list['version'] ? $list['version'] : '1.80',
    '#title'  => t('Nesox Email Marketer version'),
    '#description' => t('Enter the version of Nesox Email Marketer software used to process this subscription requests.'),
    '#maxlength' => 15
  );
  $form['general']['activated'] = array(
    '#type' => 'select',
    '#title' => t('Subscription policy'),
    '#default_value' => $list['activated'] ? $list['activated'] : 'True',
    '#options' => array('True' => t('Direct subscription'), 'False' => t('Queue subscription')),
    '#description' => t('Set the subscription policy. If "Queue subscription" is selected then the list administrator approval is required. Otherwise the address is added to the list.')
  );
  $form['subscribe'] = array(
    '#type' => 'fieldset',
    '#title' => t('Subscribe informations'),
    '#description' => t('Enter subscribe informations for this Email Marketer newsletter.'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE
  );
  $form['subscribe']['email_subscribe'] = array(
    '#type' => 'textfield',
    '#default_value' => $list['email_subscribe'],
    '#title'  => t('Subscribe e-mail'),
    '#description' => t('Enter the e-mail address where the subscribing requests will be delivered. If this field is left blank then the list e-mail will be used for subscribe requests.'),
    '#maxlength' => 255
  );
  $form['subscribe']['subject_subscribe'] = array(
    '#type' => 'textfield',
    '#default_value' => $list['subject_subscribe'],
    '#title'  => t('Subscribe e-mail subject'),
    '#description' => t('Enter the text to be contained in the subject line of the e-mail request for subscribing to this newsletter.'),
    '#maxlength' => 255
  );
  $form['subscribe']['welcome_container'] = array(
    '#type' => 'fieldset',
    '#title' => t('Customize the welcome message'),
    '#description' => '<p >' . t('Customize the way that the welcome message is looking. You can define the Plain Text and the HTML part as well. If both parts are missed then the subscriber will not receivw any welcome message.') . '</p><ul><li>' . t('You can insert in the message Email Marketer fields as they are describet above. The fields will be eclosed in sqare brackets "[" and "]". Make sure that those fields are enabled using this form before use them. Example: [FullName], [LastName], [Gender], ...') . '</li><li>' . t('Additional variables can be used in the welcome message these are: [ListEmail], [ListName], [SubscribeEmail], [UnsubscribeEmail], [SubscribeSubject], [UnsubscribeSubject], [SubscribePolicyMessage], [UnsubscribePolicyMessage], [SiteName], [SiteURL].') . '</li><li>' . t('You must insert the confirmation link in the body of the message. The confirmation link is used to verify the subscriber e-mail. The confirmation link variable is [ConfirmationLink]. Additionally you may include the confirmation code [ConfirmationCode] that can be used as alternative for form validation.') .  '</li></ul>',
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['subscribe']['welcome_container']['subscribe_text'] = array(
    '#type' => 'textarea',
    '#title' => t('Plain text part'),
    '#default_value' => $list['subscribe_text'] ? $list['subscribe_text'] : t("\nDear [FullName],\n\nThank you for subscribing to our newsletter: [ListName] [[ListEmail]].\n\nIn order to confirm you subscription you must visit the link:\n\n[ConfirmationLink]\n\nIf you have problems visiting that page, copy the link into your browser. You can also paste the confirmation code provided below into the confirmation form.\n\nConfirmation code: [ConfirmationCode]\nConfirmation form: [ConfirmationForm]\n\nThe confirmation link expires after 2 days. If you don't confirm your subscription within this period you must renew your subscription.\n\nSubscribe policy: [SubscribePolicyMessage]\n\nUnsubscribe policy: [UnsubscribePolicyMessage]\n\nBest regards,\n[SiteName]\n[SiteURL]\n"),
    '#description' => t('The Plain text part of the e-mail welcome message.'),
    '#maxlength' => 1024
  );
  $form['subscribe']['welcome_container']['subscribe_html'] = array(
    '#type' => 'textarea',
    '#title' => t('HTML part'),
    '#default_value' => $list['subscribe_html'] ? $list['subscribe_html'] : t("<p>Dear [FullName],</p>\n\n<p>Thank you for subscribing to our newsletter: [ListName] [[ListEmail]].</p>\n\n<p>In order to confirm you subscription you must visit the link:</p>\n\n<p>[ConfirmationLink]</p>\n\n<p>If you have problems visiting that page, copy the link into your browser. You can also paste the confirmation code provided below into the confirmation form.</p>\n\n<p>Confirmation code: [ConfirmationCode]<br />\nConfirmation form: [ConfirmationForm]</p>\n\n<p>The confirmation link expires after 2 days. If you don't confirm your subscription within this period you must renew your subscription.</p>\n\n<p>Subscribe policy: [SubscribePolicyMessage]</p>\n\n<p>Unsubscribe policy: [UnsubscribePolicyMessage]</p>\n\n<p>Best regards,<br />\n[SiteName]<br />\n[SiteURL]</p>\n"),
    '#description' => t('The HTML part of the e-mail welcome message.'),
    '#maxlength' => 1024
  );
  $form['unsubscribe'] = array(
    '#type' => 'fieldset',
    '#title' => t('Unsubscribe informations'),
    '#description' => t('Enter unsubscribe informations for this Email Marketer newsletter.'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE
  );
  $form['unsubscribe']['email_unsubscribe'] = array(
    '#type' => 'textfield',
    '#default_value' => $list['email_unsubscribe'],
    '#title'  => t('Unsubscribe e-mail'),
    '#description' => t('Enter the e-mail address where the unsubscribing requests will be delivered. If this field is left blank then the list e-mail will be used for unsubscribe requests.'),
    '#maxlength' => 255
  );
  $form['unsubscribe']['subject_unsubscribe'] = array(
    '#type' => 'textfield',
    '#default_value' => $list['subject_unsubscribe'],
    '#title'  => t('Unsubscribe e-mail subject'),
    '#description' => t('Enter the text to be contained in the subject line of the e-mail request for unsubscribing to this newsletter.'),
    '#maxlength' => 255
  );
  $form['fields_fixed'] = array(
    '#type' => 'fieldset',
    '#title' => t('Choose fields'),
    '#description' => t('Choose which fields will be present in the subscription form.'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#tree' => TRUE,
  );
  $form['fields_fixed']['Email'] = array(
    '#type' => 'select',
    '#title' => t('Subscription e-mail') . ' [Email]',
    '#disabled' => TRUE,
    '#default_value' => '2',
    '#options' => $field_opts
  );
  foreach ($fields as $id => $field) {
    $form['fields_fixed'][$id] = array(
      '#type' => 'select',
      '#title' => $field['#title'] . ' [' . $id . ']',
      '#options' => $field_opts,
      '#default_value' => isset($list_fields[$id]) ? $list_fields[$id] : '0'
    );
  }
  $form['add_fields_container'] = array(
    '#type' => 'fieldset',
    '#title' => t('Define additional fields'),
    '#description' => t('Define additional fields that will be submitted to Email Marketer.'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['add_fields_container']['add_fields'] = array(
    '#type' => 'textarea',
    '#default_value' => empty($list['add_fields']) ? "/* Example:\n\$form['language'] = array(\n  '#type' => 'textfield',\n  '#title' => 'Subscriber language',\n  '#maxlength' => 255\n);\n*/\n" : $list['add_fields'],
    '#title'  => t('Define additional fields'),
    '#description' => t('You can declare here additional subscription fields using PHP. Additional fields can be declared by filling an associative array called <em>$form</em>. The keys of the array are the Email Marketer field names and the values are form elements defined as in Drupal Forms API. For more informations visit <a href="@url">Drupal Forms API</a>. If you are not familiar with PHP coding and Drupal Forms API do not enter here anything because your application may become unstable.', array('@url' => 'http://api.drupal.org/api/file/developer/topics/forms_api_reference.html/5')),
    '#tree' => FALSE
  );
  $form['roles'] = array(
    '#type' => 'fieldset',
    '#title' => t('Roles'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#description' => t('Choose which roles may subscribe to this newsletter. Note that roles with the "administer email marketer" permission can always subscribe to all newsletters.'),
    '#tree' => TRUE,
  );
  if (empty($list['roles']) || !isset($list['roles'])) {
    $roles = array();
  }
  else {
      $roles = explode('|', trim($list['roles'], '|'));
  }
  foreach (user_roles() as $rid => $role_name) {
    $checked = in_array($rid, $roles);
    $form['roles'][$rid] = array('#type' => 'checkbox',
      '#title' => $role_name,
      '#default_value' => $checked,
    );
  }
  if (isset($list)) {
    $form['eid'] = array('#type' => 'hidden', '#value' => $list['eid']);
  }
  $form['submit'] = array('#type' => 'submit', '#value' => t('Save configuration'));
  return $form;
}

/**
 * Theme function for the newsletter configuration form
 *
 * @param $form
 *   The Drupal form array
 *
 * @return text
 *   The HTML representation of the form
 */
function theme_emailmarketer_newsletter_form($form) {
  $output = drupal_render($form['general']);
  $output .= drupal_render($form['subscribe']);
  $output .= drupal_render($form['unsubscribe']);
  $rows = $row = array();
  $counter = 1;
  foreach($form['fields_fixed'] as $id => $element) {
    if ($id{0} != '#') {
      $row[] = drupal_render($element);
      $counter++;
      if ($counter == 5) {
        $counter = 1;
        $rows[] = $row;
        $row = array();
      }
    }
  }
  if (!empty($row)) {
    $rows[] = $row;
  }
  $fields = theme('table', array(), $rows);
  $output .= theme('fieldset', array(
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#title' => $form['fields_fixed']['#title'],
    '#description' => $form['fields_fixed']['#description'],
    '#value' => $fields
  ));
  unset($form['fields_fixed']);
  $output .= drupal_render($form);

  return $output;
}

/**
 * The validation function for the newsletter configuration form
 *
 * @param $form_id
 *   A string with the ID of the form
 *
 * @param $form_values
 *   An associative array with the POST or GET variables
 */
function emailmarketer_newsletter_form_validate($form_id, $form_values) {
  // list email
  $email = trim($form_values['email']);
  $result = db_fetch_object(db_query("SELECT email FROM {%s} WHERE email = '%s' AND eid <> %d", EMAILMARKETER_TABLE, $email, (int)$form_values['eid']));
  if ($result) {
    form_set_error('email', t('The e-mail of the list must be unique. An e-mail %name already exists.', array('%name' => $email)));
  }
  if (!valid_email_address($email)) {
    form_set_error('email', t('The e-mail of the list is not in a valid format. Please check and fix the e-mail address.'));
  }

  // subscribe
  $email = trim($form_values['email_subscribe']);
  if ($email != '') {
    $result = db_fetch_object(db_query("SELECT email_subscribe FROM {%s} WHERE email_subscribe = '%s' AND eid <> %d", EMAILMARKETER_TABLE, $email, (int)$form_values['eid']));
    if ($result) {
      form_set_error('email_subscribe', t('The e-mail used for subscribe requests must be unique or empty. An e-mail %name already exists.', array('%name' => $email)));
    }
    if (!valid_email_address($email)) {
      form_set_error('email_subscribe', t('The e-mail for subscribe requests is not in a valid format. Please check and fix the e-mail address.'));
    }
  }

  // unsubscribe
  $email = trim($form_values['email_unsubscribe']);
  if ($email != '') {
    $result = db_fetch_object(db_query("SELECT email_unsubscribe FROM {%s} WHERE email_unsubscribe = '%s' AND eid <> %d", EMAILMARKETER_TABLE, $email, (int)$form_values['eid']));
    if ($result) {
      form_set_error('email_unsubscribe', t('The e-mail used for unsubscribe requests must be unique or empty. An e-mail %name already exists.', array('%name' => $email)));
    }
    if (!valid_email_address($email)) {
      form_set_error('email_unsubscribe', t('The e-mail for unsubscribe requests is not in a valid format. Please check and fix the e-mail address.'));
    }
  }
}

/**
 * Processing the newsletter configuration form
 *
 * @param $form_id
 *   A string with the ID of the form
 *
 * @param $form_values
 *   An associative array with the POST or GET variables
 */
function emailmarketer_newsletter_form_submit($form_id, $form_values) {
  $list = isset($form_values['eid']) ? $form_values['eid'] : NULL;
  $new = !$list;

  $allowed_roles = array();
  if (isset($form_values['roles'])) {
    foreach ($form_values['roles'] as $id => $checked) {
      if ($checked) {
        $allowed_roles[] = $id;
      }
    }
  }
  $allowed_roles = empty($allowed_roles) ? '' : '|' . implode('|', $allowed_roles) . '|';
  
  $fields = serialize($form_values['fields_fixed']);

  if ($new) {
    db_query("INSERT INTO {%s} (email, version, activated, name, email_subscribe, subject_subscribe, email_unsubscribe, subject_unsubscribe, subscribe_text, subscribe_html, roles, fields_fixed, add_fields) VALUES ('%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s', '%s')", EMAILMARKETER_TABLE, $form_values['email'], $form_values['version'], $form_values['activated'], $form_values['name'], $form_values['email_subscribe'], $form_values['subject_subscribe'], $form_values['email_unsubscribe'], $form_values['subject_unsubscribe'], $form_values['subscribe_text'], $form_values['subscribe_html'], (string)$allowed_roles, $fields, $form_values['add_fields']);
    drupal_set_message(t('The newsletter %email was added.', array('%email' => $form_values['email'])));
    return 'admin/settings/emailmarketer/';
  }
  else {
    db_query("UPDATE {%s} SET email = '%s', version = '%s', activated='%s', name = '%s', email_subscribe = '%s', subject_subscribe = '%s', email_unsubscribe = '%s', subject_unsubscribe = '%s', subscribe_text = '%s', subscribe_html = '%s', roles = '%s', fields_fixed = '%s', add_fields = '%s' WHERE eid = %d", EMAILMARKETER_TABLE, $form_values['email'], $form_values['version'], $form_values['activated'], $form_values['name'], $form_values['email_subscribe'], $form_values['subject_subscribe'], $form_values['email_unsubscribe'], $form_values['subject_unsubscribe'], $form_values['subscribe_text'], $form_values['subscribe_html'], (string)$allowed_roles, $fields, $form_values['add_fields'], $form_values['eid']);
    drupal_set_message(t('The newsletter %email was updated.', array('%email' => $form_values['email'])));
    return 'admin/settings/emailmarketer/'. $list;
  }
}

/**
 * Confirm a newsletter deletion
 *
 * @param $list
 *   A record with the newsletter being deleted
 */
function emailmarketer_admin_delete($list) {
  $form['eid'] = array('#type' => 'hidden', '#value' => $list['eid']);
  $form['email'] = array('#type' => 'hidden', '#value' => $list['email']);
  return confirm_form($form, t('Are you sure you want to delete the newsletter %list?', array('%list' => $list['email'])), 'admin/settings/emailmarketer', t('This action cannot be undone.'), t('Delete'), t('Cancel'));
}

/**
 * Processing newsletter deletion
 *
 * @param $form_id
 *   A string with the ID of the form
 *
 * @param $form_values
 *   An associative array with the POST or GET variables
 */
function emailmarketer_admin_delete_submit($form_id, $form_values) {
  db_query("DELETE FROM {%s} WHERE eid = %d", EMAILMARKETER_TABLE, $form_values['eid']);
  db_query("DELETE FROM {%s} WHERE eid = %d", EMAILMARKETER_QUEUE, $form_values['eid']);
  drupal_set_message(t('Deleted Email Marketer newsletter %list.', array('%list' => $form_values['email'])));
}

/**
 * Generate block for this module. The block is used for users subscribing.
 */
function emailmarketer_block($op = 'list', $delta = 0, $edit = array()) {
  global $emailmarketer_lists;
  switch ($op) {
    case 'list':
      $blocks[1]['info'] = 'Email Marketer subscriber';
      return $blocks;
    break;
    case 'view':
      if (!isset($emailmarketer_lists)) {
        $emailmarketer_lists = emailmarketer_list(NULL, true);
      }
      if (count($emailmarketer_lists)) {
        foreach ($emailmarketer_lists as $id => $list) {
          $form['lists'][] = array(
            'href' => 'subscribe/' . $id,
            'title' => $list['name']
          );
        }
        $form['message'] = t(variable_get('emailmarketer_message', '<p>Select a newsletter to subscribe:</p>'));

        $block['content'] = theme('emailmarketer_block', $form);
        $block['subject'] = t(variable_get('emailmarketer_title', 'Our Newsletters'));
      }
      return $block;
    break;
  }
}

/**
 * Theme the module block
 */
function theme_emailmarketer_block($form) {
  $output = '';
  $output .= $form['message'];
  $output .= theme('links', $form['lists']);
  return $output;
}

function emailmarketer_page($lists) {
  $links = array();
  foreach ($lists as $id => $list) {
    $links[] = array(
      'href' => 'subscribe/' . $id,
      'title' => $list['name']
    );
  }
  $form['message'] = t(variable_get('emailmarketer_message', '<p>Select a newsletter to subscribe:</p>'));
  $form['lists'] = $links;
  

  return theme('emailmarketer_page', $form);
}

function theme_emailmarketer_page($form) {
  $output = '';
  $output .= $form['message'];
  $output .= theme('links', $form['lists']);
  return $output;
}

function emailmarketer_subscribe($list) {
  global $user;
  $form['email'] = array(
    '#type' => 'textfield',
    '#title' => t('Your e-mail'),
    '#description' => t('Provide the e-mail address used to subscribe to the newsletter.'),
    '#default_value' => $user->mail,
    '#required' => TRUE,
    '#maxlength' => 255
  );
  
  // fixed fields
  $fields_fixed = unserialize($list['fields_fixed']);
  $available_fields = emailmarketer_fields();
  foreach ($fields_fixed as $id => $field) {
    if ($field != '0') {
      $form[$id] = $available_fields[$id];
      if ($field == '2') {
        $form[$id]['#required'] = TRUE;
      }
    }
  }

  // customized fields
  eval($list['add_fields']);

  $keys = array_keys($form);
  unset($keys['email']);
  
  $form['keys'] = array(
    '#type' => 'hidden',
    '#value' => serialize($keys)

  );

  $form['list_name'] = array(
    '#type' => 'hidden',
    '#value' => $list['name'],
  );

  $form['list_email'] = array(
    '#type' => 'hidden',
    '#value' => $list['email'],
  );

  $form['eid'] = array(
    '#type' => 'hidden',
    '#value' => $list['eid'],
  );

  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Submit'),
    '#weight' => 50
  );
  
  return $form;
}

function emailmarketer_subscribe_validate($form_id, $form_values) {
  $email = trim($form_values['email']);
  if (!valid_email_address($email)) {
    form_set_error('email', t('The e-mail is not in a valid format. Please check and fix the e-mail address.'));
  }
  $result = db_query("SELECT qid FROM {%s} WHERE eid = %d AND email = '%s'", EMAILMARKETER_QUEUE, $form_values['eid'], $email);
  if (db_num_rows($result) > 0) {
    form_set_error('email', t('This e-mail address was also subscribed to the newsletter <em>"%list"</em> and the subscription needs user confirmation. You must provide other e-mail address or you have to subscribe to other newsletter.', array('%list' => $form_values['list_name'])));
  }
}

function emailmarketer_subscribe_submit($form_id, $form_values) {
  global $user, $base_url;
  $this_list = emailmarketer_list($form_values['eid']);
  $this_list = $this_list[$form_values['eid']];

  $qid = md5(serialize($form_values) . serialize($user) . time());
  $email = $form_values['email'];
  $stored_fields = array();
  $all_fields = unserialize($form_values['keys']);
  foreach ($form_values as $id => $value) {
    if (in_array($id, $all_fields)) {
      $stored_fields[$id] = $value;
    }
  }
  $fields = serialize($stored_fields);

  $sender = array('mail' => variable_get('site_mail', ini_get('sendmail_from')), 'name' => variable_get('site_name', 'Drupal')); 
  $recipient = array('mail' => $email, 'name' => $form_values['FullName']);
  
  $values = array();
  foreach ($all_fields as $token) {
    $values['[' . $token . ']'] = $form_values[$token];
  }

  // make available additional variables
  $values['[ListEmail]'] = $form_values['list_email'];
  $values['[ListName]'] = $form_values['list_name'];
  $values['[SubscribeEmail]'] = $this_list['email_subscribe'];
  $values['[UnsubscribeEmail]'] = $this_list['email_unsubscribe'];
  $values['[SubscribeSubject]'] = $this_list['subscribe_subject'];
  $values['[UnsubscribeSubject]'] = $this_list['unsubscribe_subject'];
  $values['[SubscribePolicyMessage]'] = ($this_list['activated'] == 'True') ? t('After you confirm your e-mail, you will be directly subscribed to the newsletter. No action is required on the administrators side.') : t('After you confirm your e-mail, you have to wait until the administrators approve your subscription.');
  $values['[UnsubscribePolicyMessage]'] = t('To unsubscribe send an empty message to @unsubscribe', array('@unsubscribe' => ($this_list['email_unsubscribe'] ? $this_list['email_unsubscribe'] : $form_values['list_email']))) . ' ' . (($this_list['subject_unsubscribe'] != '') ? t('and fill the subject line with "@subj"', array('@subj' => $this_list['subject_unsubscribe'])) : '') . '.';
  $values['[SiteName]'] = variable_get('site_name', 'Drupal');
  $values['[SiteURL]'] = $base_url;
  $values['[ConfirmationLink]'] = url('subscribe/confirm/' . $qid, NULL, NULL, TRUE);
  $values['[ConfirmationCode]'] = $qid;
  $values['[ConfirmationForm]'] = url('subscribe/confirm/', NULL, NULL, TRUE);

  $plain = strtr($this_list['subscribe_text'], $values);

  $url = parse_url($base_url);
  $values['[SiteURL]'] = l($url['host'], $base_url, array(), NULL, NULL, TRUE);
  $values['[ConfirmationLink]'] = l($values['[ConfirmationLink]'], 'subscribe/confirm/' . $qid);
  $values['[ConfirmationForm]'] = l($values['[ConfirmationForm]'], 'subscribe/confirm/');
  $html = strtr($this_list['subscribe_html'], $values);

  if (mimemail(
    $sender, // sender
    $recipient, // recipient
    t('Confirm your subscription to @name [@email]', array('@name' => $form_values['list_name'], '@email' => $form_values['list_email'])), // subject
    $html, // html
    false,
    array(),
    $plain // plain text
  )) {
    db_query("INSERT INTO {%s} (qid, eid, registered, email, subscribe_fields) VALUES ('%s', %d, %d, '%s', '%s')", EMAILMARKETER_QUEUE, $qid, $form_values['eid'], time(), $email, $fields);
    watchdog('emailmarketer', $email . ' ask for subscription to ' . $form_values['list_email'], WATCHDOG_NOTICE);
    drupal_set_message(t('Your subscription has been registered. In few moments you will receive a message asking you to confirm your subscription. Please follow the confirmation link included in the e-mail.'));
  }
  else {
    drupal_set_message(t('The subscription process has failed due to an unknown error related to the SMTP system installed on the server. Please contact the system administrator to report the problem.'), 'error');
    watchdog('emailmarketer', 'SMTP error: ' . $email . ' failed to subscribe to ' . $form_values['list_email'], WATCHDOG_WARNING);
  }
  drupal_goto('subscribe');
}

function emailmarketer_confirm($lists) {
  $form['code'] = array(
    '#type' => 'textfield',
    '#title' => t('Enter the confirmation code'),
    '#description' => t('Paste here the confirmation code sent to you by mail.'),
    '#maxlength' => 32
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Validate'),
    '#weight' => 50
  );
  return $form;
}

function emailmarketer_confirm_validate($form_id, $form_values) {
  if (!preg_match("/[0-9a-z]{32,32}/", $form_values['code'])) {
    form_set_error('code', t('The code entered is invalid. Wrong length or invalid characters detected.'));
  }
}

/**
 * Processing a confirmation
 */
function emailmarketer_confirm_submit($form_id, $form_values) {
  drupal_goto('subscribe/confirm/' . $form_values['code']);
}

/**
 * Confirm a subscription and sent it to Email Marketer
 *
 * @param $lists
 *   An array with the newsletters abailable to the current user
 */
function emailmarketer_confirmation($lists) {
  $qid = arg(2);
  $result = db_query("SELECT * FROM {%s} WHERE qid = '%s'", EMAILMARKETER_QUEUE, $qid);

  // Check to see if the subscription is still in the queue
  if (db_num_rows($result) == 0) {
    drupal_set_message('<p>' . t('Failed to confirm this subscription. Possible reasons:') . '</p><ul><li>' . t('The subscription has expired: Each subscription is queued for validation for 48 hours. If you don\'t confirm your subscription within this period, the subscription expires.') . '</li><li>' . t('The subscription was confirmed previously: The link provided for subscription has already been used by you or other person. The confirmation link or the confirmation code can be used only once.') . '</li><li>' . t('The newsletter was deleted: The newsletter of this subscription was deleted in the meantime by the site administrators.') . '</li><li>' . t('The confirmation code is not valid: You didn\'t handled correctly the confirmation link or the confirmation code provided in the welcome e-mail.') . '</li></ul><p>' . t('If you think that this is a site error please report this to the <a href="@webmaster">site webmaster</a>.</p>', array('@webmaster' => url('user/1/contact'))), 'error');
  }
  else {
    $subscribe = db_fetch_array($result);
    $list = $lists[$subscribe['eid']];
    $data = unserialize($subscribe['subscribe_fields']);

    $sender = array('mail' => $subscribe['email'], 'name' => $data['FullName']);
    $recipient = $list['email_subscribe'] ? $list['email_subscribe'] : $list['email'];
    $body = <<<EOS
[Marketer]
version={$list["version"]}
activated={$list["activated"]}

[Data]
EOS;
    $body .= "\n";
    foreach ($data as $id => $item) {
      if (!in_array($id, array('email', 'FullName'))) {
        $body .= $id . '=' . $item . "\n";
      }
    }
    if (mimemail(
      $sender, // sender
      $recipient, // recipient
      $list['subject_subscribe'], // subject
      '', // html
      TRUE,
      array(),
      $body // plain text
    )) {
      $message = t('You have succeded the subscription to the newsletter.') . ' ' . ($list["activated"] == 'True' ? t('No additional action is required.') : t('Your subscription will be complete after administrator approval.'));
       drupal_set_message($message);
       watchdog('emailmarketer', $subscribe['email'] . ' was accepted to ' . $list['email'], WATCHDOG_NOTICE);

    }
    else {
      drupal_set_message(t('The subscription process has failed due to an unknown error related to the SMTP system installed on the server. Please contact the system administrator to report the problem.'), 'error');
      watchdog('emailmarketer', 'SMTP error: ' . $subscribe['email'] . ' fail to confirm to ' . $list['email'], WATCHDOG_WARNING);
    }
    db_query("DELETE FROM {%s} WHERE qid = '%s'", EMAILMARKETER_QUEUE, $qid);
  }
  
  if (count($lists) == 1) {
    drupal_goto('');
  }
  else {
    drupal_goto('subscribe');
  }
}

/**
 * Implementation of hook_cron
 */
function emailmarketer_cron() {
  $expire = time() - 48 * 3600;
  db_query("DELETE FROM {%s} WHERE registered < %d", EMAILMARKETER_QUEUE, $expire);
}