Mailman21List Class Reference

Mailman 2.1.x List Personality Plugin. More...

Inheritance diagram for Mailman21List:

Collaboration diagram for Mailman21List:

Public Member Functions
ctools_export_ui
	edit_form (&$form, &$form_state)
	Implements ctools_export_ui::edit_form(). More...
	edit_form_submit (&$form, &$form_state)
MailinglistListInterface
	checkMessage (MailinglistMessageInterface $msg)
	checkMessage() More...
	processMessage (MailinglistMessageInterface $msg)
	processMessage() More...
	getMemberInfo ($email)
	getMemberInfo() More...
	SubscribeForm (&$form, &$form_state)
	Operation Forms. More...
	UnsubscribeForm (&$form, &$form_state)
	OptionsForm ($form, $form_state)
	getMemberPage ($page)
	getMemberPage More...
	getWebPage ($url, $post="")
	getWebPage More...
Public Member Functions inherited from MailinglistList
	getWebPage ($url, $post="")
	getWebPage More...
	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...
	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

Additional Inherited Members
Data Fields inherited from MailinglistList
	$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

Mailman 2.1.x List Personality Plugin.

Definition at line 10 of file Mailman21List.class.php.

Member Function Documentation

checkMessage

(

MailinglistMessageInterface

$msg

)

checkMessage()

Implements MailinglistList::checkMessage().

Todo:

Implement Mailman21::checkMessage().

Implements MailinglistListInterface.

Definition at line 70 of file Mailman21List.class.php.

                                                          {
    return parent::checkMessage($msg);
  }

edit_form	(	&	$form,
		&	$form_state
	)

Implements ctools_export_ui::edit_form().

Definition at line 21 of file Mailman21List.class.php.

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

                                           {
    parent::edit_form($form, $form_state);
    $form['basic']['settings']['admin_url'] = array(
      '#type' => 'textfield',
      '#title' => t('Mailman URL Base'),
      '#default_value' => $this->get_setting('admin_url'),
      '#required' => TRUE,
      '#description' => t('Base URL of admin page (typically something like http://example.com/mailman )'),
      '#weight' => 60,
    );
    $form['basic']['settings']['listname'] = array(
      '#type' => 'textfield',
      '#title' => t('List Name'),
      '#default_value' => $this->get_setting('listname'),
      '#required' => TRUE,
      '#description' => t('Name of list as appears in URLs for the list'),
      '#weight' => 60,
    );
    $form['basic']['settings']['admin_password'] = array(
      '#type' => 'textfield',
      '#title' => t('Admin Password'),
      '#default_value' => _mailinglist_decode_password($this->get_setting('admin_password')),
      '#required' => TRUE,
      '#description' => t('Password to access List Interface'),
      '#weight' => 60,
    );
  }

Here is the call graph for this function:

edit_form_submit	(	&	$form,
		&	$form_state
	)

Definition at line 51 of file Mailman21List.class.php.

References _mailinglist_encode_password().

                                                  {
      dpm($form_state, 'Mailman21List::edit_form_submit');

    $form_state['values']['settings']['admin_password'] = _mailinglist_encode_password($form_state['values']['settings']['admin_password']);
  }

Here is the call graph for this function:

getMemberInfo

(

$email

)

getMemberInfo()

Get information about a subscriber

Parameters

$email

String with email address of member to look update

Returns

If member does not exist, then returns FALSE, else returns an array with the information about the subcriber.

Todo:

Decode rest of options

Implements MailinglistListInterface.

Definition at line 94 of file Mailman21List.class.php.

References MailinglistExportable\get_setting(), getWebPage(), MAILINGLIST_SUB_DIGEST, MAILINGLIST_SUB_MIME_DIGEST, MAILINGLIST_SUB_NOMAIL, and MAILINGLIST_SUB_NORMAL.

                                 {
    $listname = $this->get_setting('listname');
    $url = $this->get_setting('admin_url') . '/options/' . $this->get_setting('listname') . '/' . str_replace('@', '--at--', $email);
    $data = $this->getWebPage($url);
    dpm($data, 'Get Info: ' . $email);
    $body = $data['body'];
    $pos = strpos($body, 'Your ' . $listname . ' Subscription Options');
    if ($pos === FALSE) {
      dpm(FALSE, 'Info');
      return FALSE;
    }
    $info = array('Email' => $email);
    $pos1 = strpos($body, 'name="fullname"');
    $pos1 = strpos($body, 'value=', $pos1)+7;
    $end = strpos($body, '"', $pos1);
    $name = substr($body, $pos1, $end-$pos1);
    $info['Name'] = $name;

    $pos = strpos($body, 'name="disablemail"', $pos);
    $pos = strpos($body, 'CHECKED', $pos);
    $no_mail = substr($body, $pos-3, 1);
    //$info['NoMail'] = $no_mail;

    $pos = strpos($body, 'name="digest"', $pos);
    $pos = strpos($body, 'CHECKED', $pos);
    $digest = substr($body, $pos-3, 1);
    //$info['Digest'] = $digest;

    $pos = strpos($body, 'name="mime"', $pos);
    $pos = strpos($body, 'CHECKED', $pos);
    $plain = substr($body, $pos-3, 1);
    //$info['Plain'] = $plain;

    $info['Type'] = ($no_mail == '1' ? MAILINGLIST_SUB_NOMAIL :
                    ($digest == '0'  ? MAILINGLIST_SUB_NORMAL :
                    ($plain == "1"    ? MAILINGLIST_SUB_DIGEST : MAILINGLIST_SUB_MIME_DIGEST)));

    dpm($info, 'Info');
    return $info;
  }

Here is the call graph for this function:

getMemberPage

(

$page

)

getMemberPage

Parameters

$page

Page code to fetch.

Returns

array of member info. Subscript is email address of subscriber element is an array of subscriber info. ['Email'] Email address. ['Name'] Name of subscriber ['Moderated'] Is subscriber on moderation? ['Hide'] Has subscriber chosen to hide their membership. ['NoMail'] Source of being on Nomail (U/A/B) ['Ack'] Should user get message Ack? ['MeToo'] Supress MeToo Setting. ['NoDups'] Suppress Duplicate messages. ['Type'] Subscription Type ( (None), Nomail, Normal, Digest, MimeDigest) ['Language'] Subscriber language setting.

Note, this function needs mailinglist_members loaded

Bug:

need to check that we HAVE multiple pages

Bug:

need to check that we have multiple pages

Implements MailinglistListInterface.

Definition at line 222 of file Mailman21List.class.php.

References MailinglistExportable\get_setting(), getWebPage(), MailinglistExportable\log(), MAILINGLIST_SUB_DIGEST, MAILINGLIST_SUB_MIME_DIGEST, MAILINGLIST_SUB_NOMAIL, and MAILINGLIST_SUB_NORMAL.

                                {
    if (!$page) {
      $pagecode = '';
    }
    else {
      $pagecode = '?letter=' . $page[0] . '&chunk=' . $page[1];
    }
    $url = $this->get_setting('admin_url') . '/admin/' . $this->get_setting('listname') . '/members' . $pagecode;
    $data = $this->getWebPage($url);
    dpm($data, 'Page Data');
    $body = $data['body'];
    $pos = strpos($body, 'Membership List');
    $liststart = $pos;
    if (!$page) {
      // If starting, find where we start
      $pos = strpos($body, 'letter=', $pos)+7;
      $page[0] = substr($body, $pos, 1);
      $page[1] = 0;
    }
    $next = $page;
    $next[1] = $next[1]+1;
    if (FALSE === strpos($body, 'chunk=' . $next[1], $pos)) {
      // Don't find a listing for next chunk for this letter.
      $next[1] = 0;
      if($pos  < 7) {
        $this->log('Bad Pos1 ' . $pos . '\n' . html_specialchars($body), SELF::LOG_ERROR);
        return array('next' => $next, 'page' => $page, 'members' => array());
      }
      $pos = strpos($body, 'letter=' . $next[0] . '"', $pos-7); // need to back up in case we found first letter
      if($pos  < 7) {
        $this->log('Bad Pos2 ' . $pos . '\n' . html_specialchars($body), SELF::LOG_ERROR);
        return array('next' => $next, 'page' => $page, 'members' => array());
      }
      $pos = strpos($body, 'letter=', $pos+7) + 7;
      $letter = substr($body, $pos, 1);
      if ($pos > 7 && $letter != $next[0]) {
        $next[0] = $letter;
      }
      else {
        $next = FALSE; // end of data.
      }
    }

    $members = array();
    $pos = strpos($body, 'member address', $pos); // Advance to Header
    $endpos = strpos($body, '</table>', $pos);  // End of table
    $pos = strpos($body, '<tr>', $pos);
    while ($pos < $endpos) {
      $pos1 = strpos($body, '</tr>', $pos);
      $record = substr($body, $pos, $pos1-$pos+5);
      $record = explode('<td>', $record);
      // record [0] is <tr>
      // record [1] is unsub.
      // record [2] is email address, real name
      $start = strpos($record[2], '>');
      $end = strpos($record[2], '</a>');
      $email = substr($record[2], $start+1, $end - $start-1);
      $info['Email'] = $email;
      $start = strpos($record[2], 'value=', $end) + 7;
      $end = strpos($record[2], '"', $start);
      $name = substr($record[2], $start, $end - $start);
      $info['Name'] = $name;
      // record[3] = Moderated.
      $start = strpos($record[3], 'value=') + 7;
      $end = strpos($record[3], '"', $start);
      $mod = substr($record[3], $start, $end - $start);
      $info['Moderated'] = $mod == "on";
      // record[4] = Hide.
      $start = strpos($record[4], 'value=') + 7;
      $end = strpos($record[4], '"', $start);
      $hide = substr($record[4], $start, $end - $start);
      $info['Hide'] = $hide == "on";
      // record[5] = NoMail.
      $start = strpos($record[5], 'value=') + 7;
      $end = strpos($record[5], '"', $start);
      $no_mail = substr($record[5], $start, $end - $start);
      if ($no_mail == 'on') {
        $start = strpos($record[5], '[', $end)+1;
        $info['NoMail'] = substr($record[5], $start, 1);
      }
      else {
        $info['NoMail'] = FALSE;
      }
      // record[6] = Ack.
      $start = strpos($record[6], 'value=') + 7;
      $end = strpos($record[6], '"', $start);
      $ack = substr($record[6], $start, $end - $start);
      $info['Ack'] = $ack == "on";
      // record[7] = MeToo.
      $start = strpos($record[7], 'value=') + 7;
      $end = strpos($record[7], '"', $start);
      $metoo = substr($record[7], $start, $end - $start);
      $info['MeToo'] = $metoo == 'on';
      // record[8] = NoDups.
      $start = strpos($record[8], 'value=') + 7;
      $end = strpos($record[8], '"', $start);
      $no_dups = substr($record[8], $start, $end - $start);
      $info['NoDups'] = $no_dups == 'on';
      // record[9] = digest.
      $start = strpos($record[9], 'value=') + 7;
      $end = strpos($record[9], '"', $start);
      $digest = substr($record[9], $start, $end - $start);
      // record[10] = Plain Digest.
      $start = strpos($record[10], 'value=') + 7;
      $end = strpos($record[10], '"', $start);
      $plain = substr($record[10], $start, $end - $start);
      $info['Type'] = ($no_mail == "on"  ? MAILINGLIST_SUB_NOMAIL :
                      ($digest == 'off'  ? MAILINGLIST_SUB_NORMAL :
                      ($plain == "on"    ? MAILINGLIST_SUB_DIGEST : MAILINGLIST_SUB_MIME_DIGEST)));

      // record[11] = Language.
      $end = strpos($record[11], 'Selected') - 2;
      $string = substr($record[11], 0, $end);
      $start = strrpos($string, '"') + 1;
      $lang = substr($record[11], $start, $end - $start);
      $info['Language'] = $lang;

      $members[$email] = $info;
      // Find next entry
      $pos = strpos($body, '<tr>', $pos1);
    }
    return array('next' => $next, 'page' => $page, 'members' => $members);
  }

Here is the call graph for this function:

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:

Do we want to check for bad login and error out here?

Definition at line 357 of file Mailman21List.class.php.

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

Referenced by getMemberInfo(), and getMemberPage().

                                      {
    $page = parent::getWebPage($url, $post);
    if (strpos($page['body'], 'name="admlogin"') ) {
      $login_post = 'adminpw=' . _mailinglist_decode_password($this->get_setting('admin_password'));
      $page = parent::getWebPage( $url, $login_post);
    }
    return $page;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

OptionsForm	(		$form,
			$form_state
	)

Definition at line 184 of file Mailman21List.class.php.

                                          {
    $form['notice'] = array(
      '#markup' => '<b>** Notice: Not Fully Implemented</b>',
      '#weight' => -90);

    $form['email'] = array(
      '#type' => 'textfield',
      '#title' => t('EMail Address'),
      '#default_value' => 'somebody@example.com',
      '#required' => TRUE,
      '#description' => t('This is the Email address which email from the list will be sent'),
      '#weight' => 20,
    );

    dpm($form, 'Options Form');
  }

processMessage

(

MailinglistMessageInterface

$msg

)

processMessage()

Implements MailinglistList::processMessage().

Todo:

Implement Mailman21::processMessage().

Implements MailinglistListInterface.

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

                                                            {
    return parent::processMessage($msg);
  }

SubscribeForm	(	&	$form,
		&	$form_state
	)

Operation Forms.

Definition at line 143 of file Mailman21List.class.php.

                                              {
    global $help;
    $form['notice'] = array(
      '#markup' => '<b>** Notice: Not Fully Implemented</b>',
      '#weight' => -90);

    $form['email'] = array(
      '#type' => 'textfield',
      '#title' => t('EMail Address'),
      '#default_value' => 'somebody@example.com',
      '#required' => TRUE,
      '#description' => t('This is the Email address which email from the list will be sent'),
      '#weight' => 20,
    );

    dpm($form, 'Subscribe Form');
  }

UnsubscribeForm	(	&	$form,
		&	$form_state
	)

Definition at line 164 of file Mailman21List.class.php.

                                                {
    $form['notice'] = array(
      '#markup' => '<b>** Notice: Not Fully Implemented</b>',
      '#weight' => -90);

    $form['email'] = array(
      '#type' => 'textfield',
      '#title' => t('EMail Address'),
      '#default_value' => 'somebody@example.com',
      '#required' => TRUE,
      '#description' => t('This is the Email address which email from the list will be sent'),
      '#weight' => 20,
    );

    dpm($form, 'Unsubscribe Form');
  }

---

The documentation for this class was generated from the following file:

• mailinglist/modules/mailman21/plugins/mailinglist/list/Mailman21List.class.php