MailinglistList.class.php

Go to the documentation of this file.

<?php
abstract class MailinglistList extends MailinglistExportable implements MailinglistListInterface {
  var $operations;
  var $parameters;

  function checkMessage(MailinglistMessageInterface $msg) {
    return FALSE;
  }

  function genericListMatch(MailinglistMessageInterface $msg) {
    if (!isset($msg->headers[$this->get_setting('generic_detect_header')])) return FALSE;
    $header = $msg->headers[$this->get_setting('generic_detect_header')];
    dpm($header, 'generic_list_match');
    return TRUE; 
  }

  function processMessage(MailinglistMessageInterface $message) {
    drupal_alter('mailinglist_message', $message, $this);
    module_invoke_all('mailinglist_message', $message, $this);
  }

  function schema(&$schema, $type) {
  }

  function getMemberInfo($email) {
    return FALSE;
  }

  function getMemberPage($page) {
    return array('next' => FALSE);
  }


  function getWebPage($url, $post="") {
    $path = variable_get('file_private_path');
    // If we don/t have a private path, get a public one, with defualts
    if (empty($path)) {
      $path = file_directory_temp();
    } else {
      // convert private path to abs.
      $path = DRUPAL_ROOT . '/' . $path;
    }

    $cookie = $path . "/mailinglist_cookie.inc";
    $handle = curl_init($url);
    curl_setopt($handle, CURLOPT_CRLF, TRUE);
    curl_setopt($handle, CURLOPT_HEADER, TRUE);  // Return header to program
    curl_setopt($handle, CURLOPT_USERAGENT, $_SERVER['HTTP_USER_AGENT']);
    curl_setopt($handle, CURLOPT_FOLLOWLOCATION, TRUE);
    curl_setopt($handle, CURLOPT_COOKIEJAR, $cookie);
    curl_setopt($handle, CURLOPT_COOKIEFILE, $cookie);
    curl_setopt($handle, CURLOPT_RETURNTRANSFER, TRUE);
    if (!empty($post)) {
      curl_setopt($handle, CURLOPT_POST, TRUE);
      curl_setopt($handle, CURLOPT_POSTFIELDS, $post);
    }
    $page = curl_exec($handle);
    $page = str_replace("\r\n", "\n", $page);
    $headerbreak = strpos($page, "\n\n");
    $headers = substr($page, 0, $headerbreak);
    $body = substr($page, $headerbreak+2);

    // Fold continuation lines
    $headers = str_replace(array("\n ", "\n\t"), " ", $headers);
    $headers = explode("\n", $headers);
    $head = array();
    foreach ($headers as $header) {
      $colon = strpos($header, ':');
      if ($colon === FALSE) {
        $head[] = $header;
      }
      else {
        $sub = substr($header, 0, $colon);
        $value = substr($header, $colon+1);
        if (isset($head[$sub])) {
          if (!is_array($head[$sub])) {
            $head[$sub] = array($head[$sub]);
          }
          $head[$sub][] = trim($value);
        }
        else {
          $head[$sub] = trim($value);
        }
      }
    }
    //@todo Process headers so body is in UTF-8
    $page = array('header' => $head, 'body' => $body);
    return $page;
  }

  function edit_form(&$form, &$form_state) {
    parent::edit_form($form, $form_state);

    /* Administrative Title for the list extry (builds default list_name); */
    $form['info']['admin_title']['#description'] = t('Suggested, but not required, to be the email address of the maiinglist.');

    $form['basic']['settings']['to_address'] = array(
      '#type' => 'textfield',
      '#title' => t('To Address'),
      '#default_value' => $this->get_setting('to_address'),
      '#required' => TRUE,
      '#description' => t('The Email address to send messages to the list'),
      '#weight' => 10,
    );

    $form['basic']['settings']['from_address'] = array(
      '#type' => 'textfield',
      '#title' => t('From Address'),
      '#default_value' => $this->get_setting('from_address'),
      '#required' => TRUE,
      '#description' => t('The default From address the site should use to send Email to the list'),
      '#weight' => 20,
    );

    if (!isset($form['basic']['settings']['detect_method'])) {
      // No Detectect method defined, so add default.
      $form['basic']['settings']['detect_method'] = array(
        '#type' => 'select',
        '#title' => t('Message Detection'),
        '#options' => array('rfc' => 'RFC-2369', 'generic' => 'Generic'),
        '#default_value' => $this->get_setting('detect_method'),
        '#description' => t('The method to use to detect messages from list'),
        '#required' => TRUE,
        '#weight' => 40,
      );
    }

    // Remember the method used to build the form.
    $form['basic']['settings']['detect_method_menu'] = array(
      '#type' => 'hidden',
      '#value' => isset($form['basic']['settings']['detect_method']['#default_value']) ? $form['basic']['settings']['detect_method']['#default_value'] : $form['basic']['settings']['detect_method']['#value']
    );

    if ($form['basic']['settings']['detect_method_menu']['#value'] == 'generic') {
      $form['basic']['settings']['generic_detect_header'] = array(
        '#type' => 'textfield',
        '#title' => t('Header'),
        '#default_value' => $this->get_setting('generic_detect_header'),
        '#required' => TRUE,
        '#description' => t('The Header to check to see if message comes from the list'),
        '#weight' => 50,
      );
      $form['basic']['settings']['generic_detect_regex'] = array(
        '#type' => 'textfield',
        '#title' => t('Regex'),
        '#default_value' => $this->get_setting('generic_detect_regex'),
        '#required' => TRUE,
        '#description' => t('Regex to test Header with'),
        '#weight' => 60,
      );
    }
    elseif ($form['basic']['settings']['detect_method']['#default_value'] == 'rfc') {
      $form['basic']['settings']['list_id'] = array(
        '#type' => 'textfield',
        '#title' => t('List ID'),
        '#default_value' => $this->get_setting('list_id'),
        '#required' => TRUE,
        '#description' => t('The value if the List-ID header to check for'),
        '#weight' => 50,
      );
    }

    $form['operations'] = array(
      '#tree' => FALSE,
      '#weight' => 50,
      'operations' => array(
        '#type' => 'fieldset',
        '#title' => 'Enabled Operations',
        '#tree' => TRUE,
        '#collapsible' => TRUE,
        '#collapsed' => FALSE,
      ),
    );
    $opers = mailinglist_operation_load_all();
    foreach ($opers as $key => $oper) {
      $form['operations']['operations'][$key] = array(
        '#type' => 'checkbox',
        '#title' => check_plain($oper->plugin['name']),
        '#default_value' => isset($this->operations[$key]) && !empty($this->operations[$key]),
      );
    }
  }

  function edit_form_validate(&$form, &$form_state) {
    parent::edit_form_validate($form, $form_state);

    if (!valid_email_address($form_state['input']['settings']['to_address'])) {
      form_set_error('to_address', 'To email address is not valid');
    }
    if (!valid_email_address($form_state['input']['settings']['from_address'])) {
      form_set_error('from_address', 'From email address is not valid');
    }
    if ($form_state['input']['settings']['detect_method'] != $form_state['input']['settings']['detect_method_menu']) {
      form_set_error('detect_method', 'Type Changed, Check Settings!');
    }
  }
}