MailinglistArchiveOperation Class Reference

Base Class for Mailinglist extensions. More...

Inheritance diagram for MailinglistArchiveOperation:

Collaboration diagram for MailinglistArchiveOperation:

Public Member Functions
	encodeDate ($date)
	Decode a "compressed" date into normal form. More...
	decodeDate ($date)
MailinglistOperationInterface
	form (&$form, &$form_state, $list)
	Operation page form generation. More...
	validate (&$form, &$form_state, $list)
	Operation page form validation. More...
	submit (&$form, &$form_state, $list)
	Operation page form submission. More...
Public Member Functions inherited from MailinglistOperation
	isAvailable (MailinglistListInterface $list)
	Implements MailinglistOperationInterface::isAvailable(). More...
	hasPermission (MailinglistListInterface $list)
	Implements MailinglistOperationInterface::hasPermission(). More...
	enabled (MailinglistListInterface $list)
	Implements MailinglistOperationInterface::enabled(). More...
	disabled (MailinglistListInterface $list)
	Implements MailinglistOperationInterface::disabled(). More...
	form (&$form, &$form_state, $list)
	Operation page form generation. More...
	validate (&$form, &$form_state, $list)
	Operation page form validation. More...
	submit (&$form, &$form_state, $list)
	Operation page form submission. More...
MailinglistOperationInterface

Detailed Description

Base Class for Mailinglist extensions.

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

Member Function Documentation

decodeDate

(

$date

)

Definition at line 291 of file MailinglistArchiveOperation.class.php.

Referenced by form().

                             {
//  dpm($date, 'Decode Start');
    if(strlen($date) < 4) {
      $date .= '0';
    }
    if(strlen($date) > 4) {
      $date = substr($date, 0, 4) .'-' . substr($date, 4);
    }
    else {
      $date .= '-00';
    }
    if(strlen($date) > 7) {
      $date = substr($date, 0, 7) .'-' . substr($date, 7);
    }
    else {
      $date .= '-00';
    }
    if(strlen($date) > 10) {
      $date = substr($date, 0, 10) .' ' . substr($date, 10);
    }
    else {
      $date .= ' 00';
    }
    if(strlen($date) > 13) {
      $date = substr($date, 0, 13) .':' . substr($date, 13);
    }
    else {
      $date .= ':00';
    }
    if(strlen($date) > 16) {
      $date = substr($date, 0, 16) .':' . substr($date, 16);
    }
    else {
      $date .= ':00';
    }
//    dpm($date, 'Decode End');
    return $date;
  }

Here is the caller graph for this function:

encodeDate

(

$date

)

Decode a "compressed" date into normal form.

Definition at line 285 of file MailinglistArchiveOperation.class.php.

Referenced by submit().

                             {
    $time = strtotime($date);
    $str = gmdate("YmdHis", $time);
    return $str;
  }

Here is the caller graph for this function:

form	(	&	$form,
		&	$form_state,
			$list
	)

Operation page form generation.

Parameters

$form	Form for the page.
$form_state	Form state for the page.
$list	List we are generating the page for.

Page parameters: [0]: list name.

[2]: Sorting/Special: msg/search/test/author/date/subject/thread/new. [3]: date range. [4]: page number.

For Special msg: [3] = mid of message to show. following parameters are for the search that got you there (so Sort in [4])

For Special search: [3]: date range. [4]: page number of chunck. [5]: Search parameters.

Todo:

Build Archives Page

Todo:

Achives parse data range.

Todo:

add navagation menu

Todo:

Archives Search

Implements MailinglistOperationInterface.

Definition at line 43 of file MailinglistArchiveOperation.class.php.

References _mailinglist_archive_scan(), _mailinglist_base_filename(), _mailinglist_datetime_ts(), _mailinglist_mailbox_scan(), decodeDate(), mailinglist_archive_message_get(), mailinglist_archive_reply_tree(), and mailinglist_archive_summary_list().

                                             {
    $type = $form_state['build_info']['args'][2];
    if ($type == 'msg') {
      $msgid = $form_state['build_info']['args'][3];
      $sort = $form_state['build_info']['args'][4];
      $off = 2;
    }
    else {
      $off = 0;
      $sort = $type;
    }

    if(empty($sort)) {
      $sort = 'new';
    }

    $dates = $form_state['build_info']['args'][$off+3];
    if(empty($dates)) {
      $start_date = '1980-00-00 00:00:00';
      $end_date = '2030-12-31 23:59:59';
    }
    else {
      $pos = strpos($dates, '-');
      if($pos === FALSE) {
        $pos = strlen($dates);
      }
      if($pos > 0) {
        $start_date = $this->decodeDate(substr($dates, 0, $pos));
      }
      else {
        $start_date = '1980-00-00 00:00:00';
      }
      if($pos < strlen($dates) -1 ) {
        $end_date = $this->decodeDate(substr($dates, $pos+1));
      }
      else {
        $end_date = '2030-12-31 23:59:59';
      }
    }
    $start_ts = _mailinglist_datetime_ts($start_date);
    $end_ts = _mailinglist_datetime_ts($end_date);

    $page = $form_state['build_info']['args'][$off+4];

    $tablename = 'mailinglist_archives__' . $list->admin_name;

    $base = variable_get('mailinglist_base', 'mailinglist');


    $pre = "$base/{$list->admin_name}/archive/";
    $post = '';
    if(!empty($dates)) {
      $post .= '/' . $dates;
    }

    $form['#theme'] = 'mailinglist_archive_form';

    /* Build Top of Form Nav Box */
    $form['nav'] = array(
      '#theme' => 'mailinglist_archive_form_header',
      '#weight' => -10,
      'order' => array(
        '#type' => 'radios',
        '#title' => 'Sort Order:',
        '#required' => TRUE,
        '#default_value' => $sort,
        '#options' => array(
          'author' => 'Author ',
          'date' => 'Date ',
          'new' => 'Newest ',
          'subject' => 'Subject ',
          'thread' => 'Threads ',
        ),
      ),
      'start-wrap' => array(
        '#type' => 'container',
        '#attributes' => array('style' => array('float: left')),
        '#weight' => 200,
        'start' => array(
          '#type' => 'textfield',
          '#size' => 20,
          '#title' => t('Start Date'),
          '#default_value' => date('Y-m-d H:i:s', $start_ts),
          '#required' => TRUE,
          '#description' => t('The beginning of the period to use'),
        ),
      ),
      'end-wrap' => array(
        '#type' => 'container',
        '#attributes' => array('style' => array('float: left')),
        '#weight' => 210,
        'end' => array(
          '#type' => 'textfield',
          '#size' => 20,
          '#title' => t('End Date'),
          '#default_value' => date('Y-m-d H:i:s', $end_ts),
          '#required' => TRUE,
          '#description' => t('The ending of the period to use'),
        ),
      ),
      'buttons' => array(
        '#weight' => 100,
        '#type' => 'container',
        '#attributes' => array('style' => array('float: left')),
        'sort' => array(
          '#type' => 'submit',
          '#value' => t('Sort'),
        ),
      ),
      'clear' => array(
        '#type' => 'container',
        '#weight' => 999,
        '#attributes' => array('style' => array('clear: both')),
      ),
    );
    if (user_access('administer mailinglist archive')) {
      $listname = variable_get('mailinglist_mailbox_current_list');
      $path = _mailinglist_base_filename(variable_get('mailinglist_mailbox_current', FALSE));
      $offset = variable_get('mailinglist_mailbox_current_offset');
      $msgcnt = variable_get('mailinglist_mailbox_current_max');
      $queue = DrupalQueue::get('mailinglist_message');
      $numitems = $queue->numberOfItems();

      if(empty($path)) {
        $progress = 'Idle ';
      }
      else {
        $progress = "$listname:$path (" . number_format($offset) . ' / ' .
          number_format($msgcnt) . ") ";
      }
      $progress .= "Items to process " . $numitems;

      $mid = $list->parameters['ArchiveCheck'];
      $form['progress'] = array(
        '#weight' => -20,
        '#markup' => $progress,
        );
    }
    $domsglist = FALSE;
    switch  ($type) {
      case 'test':
        if (user_access('administer mailinglist archive')) {
          _mailinglist_archive_scan($list);
          _mailinglist_mailbox_scan();
        }
        break;
      case 'search':
        break;
      case 'msg':
        $result = mailinglist_archive_message_get($list, $msgid);
//        dpm($result, 'Msg');
        $form['msg']  = array(
          '#theme' => 'mailinglist_message',
          '#type' => 'item',
          '#date' => _mailinglist_datetime_ts($result['time']),
          'subject' => array('#markup' => $result['subject']),
          'email' => array('#markup' => $result['email']),
          'name' => array('#markup' => $result['name']),
          'body' => array(
            '#theme' => 'mailinglist_body',
            '#item' => $result['body'],
            '#markup' => nl2br(check_plain($result['body'])),
          ),
        );
        if($result['reply_to']){
          $form['msg']['reply_to'] = mailinglist_archive_summary_list($list, $result['reply_to']);
        }
        $form['msg']['replies'] = mailinglist_archive_reply_tree($list, $msgid);
        break;
      case 'author':
        $domsglist = TRUE;
        $order = 'ORDER BY n.name ASC';
        break;
      case 'date':
        $domsglist = TRUE;
        $order = 'ORDER BY a.time ASC';
        break;
      case 'thread':
//        break;
      case 'subject':
        $domsglist = TRUE;
        $order = 'ORDER BY a.subject ASC';
        break;
      default:
      case 'new': // Reverse date order
        $domsglist = TRUE;
        $order = 'ORDER BY a.time DESC';
    }
    if($domsglist) {
      $form['msglist'] = mailinglist_archive_summary_list($list,
        array(':start' => $start_date, ':end' => $end_date),
        'a.time >= :start AND a.time <= :end', $order, 50);
    }
//    dpm($form, 'form');
  }

Here is the call graph for this function:

submit	(	&	$form,
		&	$form_state,
			$list
	)

Operation page form submission.

Parameters

$form	Form for the page.
$form_state	Form state for the page.
$list	List we are generating the page for.

Implements MailinglistOperationInterface.

Definition at line 261 of file MailinglistArchiveOperation.class.php.

References encodeDate().

                                               {
    $base = variable_get('mailinglist_base', 'mailinglist');
    $pre = "$base/{$list->admin_name}/archive/";

//    dpm($form);
//    dpm($form_state);

    switch($form_state['values']['op']){
    case 'Sort':
      $order = $form_state['values']['order'];
      $start = $this->encodeDate($form_state['values']['start']);
      $end   = $this->encodeDate($form_state['values']['end']);
      $page  = 0;
      drupal_goto("$pre$order/$start-$end/$page");
    default:

    }
  }

Here is the call graph for this function:

validate	(	&	$form,
		&	$form_state,
			$list
	)

Operation page form validation.

Parameters

$form	Form for the page.
$form_state	Form state for the page.
$list	List we are generating the page for.

Implements MailinglistOperationInterface.

Definition at line 249 of file MailinglistArchiveOperation.class.php.

                                                 {
//    dpm($form);
//    dpm($form_state);
  }

---

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

• mailinglist/modules/mailinglist_archive/plugins/mailinglist/operation/MailinglistArchiveOperation.class.php