Retrieve messages from a Mailhandler Mailbox. More...

Inheritance diagram for MailinglistList:

Collaboration diagram for MailinglistList:

Public Member Functions
	getWebPage ($url, $post="")
	getWebPage More...

MailinglistListInterface

	checkMessage (MailinglistMessageInterface $msg)
	Called on each message read from a mailbox to see if we want to process it. More...

	genericListMatch (MailinglistMessageInterface $msg)
	generic_list_match() More...

	processMessage (MailinglistMessageInterface $message)
	message_process() More...

	schema (&$schema, $type)
	schema() More...

	getMemberInfo ($email)
	getMemberInfo() More...

	getMemberPage ($page)
	getMemberPage() More...

ctools_export_ui

	edit_form (&$form, &$form_state)
	Implements ctools_export_ui::edit_form(), cross linked via mailinglist_export_ui.class.php. More...

	edit_form_validate (&$form, &$form_state)
	edit_form_validate() More...

Public Member Functions inherited from MailinglistExportable
	get_setting ($name, $def=NULL)
	get_settings() More...

	created ()
	created() More...

	edited ($old)
	edited() More...

	changedType (MailinglistPolymorpicExportableInterface $old)
	changedType() More...

	delete ()
	delete() More...

	baseName ()
	baseName() More...

	edit_form (&$form, &$form_state)
	Implements ctools_export_ui::edit_form() called via mailinglist_export_ui Build an edit form for our object. More...

	edit_form_validate (&$form, &$form_state)
	Implements ctools_export_ui::edit_form_validate(). More...

	edit_form_submit (&$form, &$form_state)
	Implements ctools_export_ui::edit_form_submit(). More...

	log ($str, $level=self::LOG_NOTICE, $parms=array())
	log() More...

	log_screen ($str, $parms=array(), $level=self::LOG_NOTICE)
	log_screen() More...

	log_db ($str, $parms=array(), $level=self::LOG_ERROR)
	log_db(). More...

	log_file ($str, $parms=array(), $level=self::LOG_INFO)
	log_file(). More...

MailinglistPolymorphicExportableInterface
MailinglistListInterface

Data Fields
	$operations

	$parameters

Data Fields inherited from MailinglistExportable
	$object_type
	The type of object we are. More...

	$settings
	Generic Array to hold misc settings so all can use same schema. More...

	$export_type
	Needed by CTools. More...

const	LOG_OFF = 0

const	LOG_SCREEN = 1

const	LOG_DB = 2

const	LOG_DB_SCREEN = 3

const	LOG_FILE = 4

const	LOG_FILE_SCREEN = 5

const	LOG_DEBUG = WATCHDOG_DEBUG

const	LOG_INFO = WATCHDOG_INFO

const	LOG_NOTICE = WATCHDOG_NOTICE

const	LOG_WARNING = WATCHDOG_WARNING

const	LOG_ERROR = WATCHDOG_ERROR

const	LOG_CRITICAL = WATCHDOG_CRITICAL

const	LOG_ALERT = WATCHDOG_ALERT

const	LOG_EMERGENCY = WATCHDOG_EMERGENCY

	$logging_screen = self::LOG_DEBUG

	$logging_db = self::LOG_INFO

	$logging_file = self::LOG_DEBUG

Detailed Description

Retrieve messages from a Mailhandler Mailbox.

Definition at line 18 of file MailinglistList.class.php.

Member Function Documentation

checkMessage ( MailinglistMessageInterface $msg )

Called on each message read from a mailbox to see if we want to process it.

Parameters

$msg	an Mailinglist_Message object with the email received

Returns: TRUE if we have processed the message, FALSE if we don't know what to do.

Implements MailinglistListInterface.

Definition at line 36 of file MailinglistList.class.php.

                                                           {
     return FALSE;
   }

edit_form	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form(), cross linked via mailinglist_export_ui.class.php.

This hook is responsible for building the edit/create form for the object.

Todo:: Should this be conditioned on operation being available for the list or will the fact that this might depend on settings give us problems.

Definition at line 169 of file MailinglistList.class.php.

References MailinglistExportable\get_setting(), and mailinglist_operation_load_all().

                                            {
     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]),
       );
     }
   }

Here is the call graph for this function:

edit_form_validate	(	&	$form,
		&	$form_state
	)

edit_form_validate()

Implements ctools_export_ui::edit_form_validate().

Definition at line 269 of file MailinglistList.class.php.

                                                     {
     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!');
     }
   }

genericListMatch ( MailinglistMessageInterface $msg )

generic_list_match()

Performs the generic list matching processes

Todo:: Check for RFC Method

Todo:

Definition at line 45 of file MailinglistList.class.php.

References MailinglistExportable\get_setting().

                                                               {
     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; 
   }

Here is the call graph for this function:

getMemberInfo ( $email )

getMemberInfo()

Implements MailinglistListInterface.

Definition at line 73 of file MailinglistList.class.php.

                                  {
     return FALSE;
   }

getMemberPage ( $page )

getMemberPage()

Implements MailinglistListInterface.

Definition at line 80 of file MailinglistList.class.php.

                                 {
     return array('next' => FALSE);
   }

getWebPage	(	$url,
		$post = `""`
	)

getWebPage

Fetch web page via cURL, and return resultant page.

Parameters

$url	The URL to fetch.
$post	Post data for request (if any)

Returns: The results web page and headers as an array.

Todo:: Look at converting to drupal_http_request() instead of cURL.

Todo:: Move cookie to private diretory (if available).

Todo:: find someplace better as backup ( user home dir?)

Definition at line 99 of file MailinglistList.class.php.

                                       {
     $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;
   }

processMessage ( MailinglistMessageInterface $message )

message_process()

Processes the receipt of a message from the list. calls hook_mailinglist_message();

Implements MailinglistListInterface.

Definition at line 59 of file MailinglistList.class.php.

Referenced by MailinglistGenericList\checkMessage().

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

Here is the caller graph for this function: