First commit

sites/all/modules/civicrm/CRM/Mailing/Selector/Browse.php

@@ -0,0 +1,654 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.7                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2017                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC (c) 2004-2017
+ */
+
+/**
+ * This class is used to browse past mailings.
+ */
+class CRM_Mailing_Selector_Browse extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
+
+  /**
+   * Array of supported links, currently null
+   *
+   * @var array
+   */
+  static $_links = NULL;
+
+  /**
+   * We use desc to remind us what that column is, name is used in the tpl
+   *
+   * @var array
+   */
+  static $_columnHeaders;
+
+  protected $_parent;
+
+  /**
+   * Class constructor.
+   *
+   *
+   * @return \CRM_Mailing_Selector_Browse
+   */
+  public function __construct() {
+  }
+
+  /**
+   * This method returns the links that are given for each search row.
+   *
+   * @return array
+   */
+  public static function &links() {
+    return self::$_links;
+  }
+
+  /**
+   * Getter for array of the parameters required for creating pager.
+   *
+   * @param $action
+   * @param array $params
+   */
+  public function getPagerParams($action, &$params) {
+    $params['csvString'] = NULL;
+    $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
+    $params['status'] = ts('Mailings %%StatusMessage%%');
+    $params['buttonTop'] = 'PagerTopButton';
+    $params['buttonBottom'] = 'PagerBottomButton';
+  }
+
+  /**
+   * Returns the column headers as an array of tuples:
+   * (name, sortName (key to the sort array))
+   *
+   * @param string $action
+   *   The action being performed.
+   * @param string $output
+   *   What should the result set include (web/email/csv).
+   *
+   * @return array
+   *   the column headers that need to be displayed
+   */
+  public function &getColumnHeaders($action = NULL, $output = NULL) {
+    $mailing = CRM_Mailing_BAO_Mailing::getTableName();
+    $job = CRM_Mailing_BAO_MailingJob::getTableName();
+    if (!isset(self::$_columnHeaders)) {
+      $completedOrder = NULL;
+
+      // Set different default sort depending on type of mailings (CRM-7652)
+      $unscheduledOrder = $scheduledOrder = $archivedOrder = CRM_Utils_Sort::DONTCARE;
+      if ($this->_parent->get('unscheduled')) {
+        $unscheduledOrder = CRM_Utils_Sort::DESCENDING;
+      }
+      elseif ($this->_parent->get('scheduled')) {
+        $scheduledOrder = CRM_Utils_Sort::DESCENDING;
+      }
+      else {
+        // sort by completed date for archived and undefined get
+        $completedOrder = CRM_Utils_Sort::DESCENDING;
+      }
+      $nameHeaderLabel = ($this->_parent->get('sms')) ? ts('SMS Name') : ts('Mailing Name');
+
+      self::$_columnHeaders = array(
+        array(
+          'name' => $nameHeaderLabel,
+          'sort' => 'name',
+          'direction' => CRM_Utils_Sort::DONTCARE,
+        ),
+      );
+
+      if (CRM_Core_I18n::isMultilingual()) {
+        self::$_columnHeaders = array_merge(
+          self::$_columnHeaders,
+          array(
+            array(
+              'name' => ts('Language'),
+              'sort' => 'language',
+              'direction' => CRM_Utils_Sort::DONTCARE,
+            ),
+          )
+        );
+      }
+
+      self::$_columnHeaders = array_merge(
+        self::$_columnHeaders,
+        array(
+          array(
+            'name' => ts('Status'),
+            'sort' => 'status',
+            'direction' => CRM_Utils_Sort::DONTCARE,
+          ),
+          array(
+            'name' => ts('Created By'),
+            'sort' => 'created_by',
+            'direction' => CRM_Utils_Sort::DONTCARE,
+          ),
+          array(
+            'name' => ts('Created Date'),
+            'sort' => 'created_date',
+            'direction' => $unscheduledOrder,
+          ),
+          array(
+            'name' => ts('Sent By'),
+            'sort' => 'scheduled_by',
+            'direction' => CRM_Utils_Sort::DONTCARE,
+          ),
+          array(
+            'name' => ts('Scheduled'),
+            'sort' => 'scheduled_date',
+            'direction' => $scheduledOrder,
+          ),
+          array(
+            'name' => ts('Started'),
+            'sort' => 'start_date',
+            'direction' => CRM_Utils_Sort::DONTCARE,
+          ),
+          array(
+            'name' => ts('Completed'),
+            'sort' => 'end_date',
+            'direction' => $completedOrder,
+          ),
+        )
+      );
+
+      if (CRM_Campaign_BAO_Campaign::isCampaignEnable()) {
+        self::$_columnHeaders[] = array(
+          'name' => ts('Campaign'),
+          'sort' => 'campaign_id',
+          'direction' => CRM_Utils_Sort::DONTCARE,
+        );
+      }
+
+      if ($output != CRM_Core_Selector_Controller::EXPORT) {
+        self::$_columnHeaders[] = array('name' => ts('Action'));
+      }
+    }
+
+    CRM_Core_Smarty::singleton()->assign('multilingual', CRM_Core_I18n::isMultilingual());
+    return self::$_columnHeaders;
+  }
+
+  /**
+   * Returns total number of rows for the query.
+   *
+   * @param string $action
+   *
+   * @return int
+   *   Total number of rows
+   */
+  public function getTotalCount($action) {
+    $job = CRM_Mailing_BAO_MailingJob::getTableName();
+    $mailing = CRM_Mailing_BAO_Mailing::getTableName();
+    $mailingACL = CRM_Mailing_BAO_Mailing::mailingACL();
+
+    // get the where clause.
+    $params = array();
+    $whereClause = "$mailingACL AND " . $this->whereClause($params);
+
+    // CRM-11919 added addition ON clauses to mailing_job to match getRows
+    $query = "
+   SELECT  COUNT( DISTINCT $mailing.id ) as count
+     FROM  $mailing
+LEFT JOIN  $job ON ( $mailing.id = $job.mailing_id AND civicrm_mailing_job.is_test = 0 AND civicrm_mailing_job.parent_id IS NULL )
+LEFT JOIN  civicrm_contact createdContact   ON ( $mailing.created_id   = createdContact.id )
+LEFT JOIN  civicrm_contact scheduledContact ON ( $mailing.scheduled_id = scheduledContact.id )
+    WHERE  $whereClause";
+
+    return CRM_Core_DAO::singleValueQuery($query, $params);
+  }
+
+  /**
+   * Returns all the rows in the given offset and rowCount.
+   *
+   * @param string $action
+   *   The action being performed.
+   * @param int $offset
+   *   The row number to start from.
+   * @param int $rowCount
+   *   The number of rows to return.
+   * @param string $sort
+   *   The sql string that describes the sort order.
+   * @param string $output
+   *   What should the result set include (web/email/csv).
+   *
+   * @return int
+   *   the total number of rows for this action
+   */
+  public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
+    static $actionLinks = NULL;
+    if (empty($actionLinks)) {
+      $cancelExtra = ts('Are you sure you want to cancel this mailing?');
+      $deleteExtra = ts('Are you sure you want to delete this mailing?');
+      $archiveExtra = ts('Are you sure you want to archive this mailing?');
+
+      $actionLinks = array(
+        CRM_Core_Action::ENABLE => array(
+          'name' => ts('Approve/Reject'),
+          'url' => 'civicrm/mailing/approve',
+          'qs' => 'mid=%%mid%%&reset=1',
+          'title' => ts('Approve/Reject Mailing'),
+        ),
+        CRM_Core_Action::VIEW => array(
+          'name' => ts('Report'),
+          'url' => 'civicrm/mailing/report',
+          'qs' => 'mid=%%mid%%&reset=1',
+          'title' => ts('View Mailing Report'),
+        ),
+        CRM_Core_Action::UPDATE => array(
+          'name' => ts('Re-Use'),
+          'url' => 'civicrm/mailing/send',
+          'qs' => 'mid=%%mid%%&reset=1',
+          'title' => ts('Re-Send Mailing'),
+        ),
+        CRM_Core_Action::DISABLE => array(
+          'name' => ts('Cancel'),
+          'url' => 'civicrm/mailing/browse',
+          'qs' => 'action=disable&mid=%%mid%%&reset=1',
+          'extra' => 'onclick="if (confirm(\'' . $cancelExtra . '\')) this.href+=\'&amp;confirmed=1\'; else return false;"',
+          'title' => ts('Cancel Mailing'),
+        ),
+        CRM_Core_Action::PREVIEW => array(
+          'name' => ts('Continue'),
+          'url' => 'civicrm/mailing/send',
+          'qs' => 'mid=%%mid%%&continue=true&reset=1',
+          'title' => ts('Continue Mailing'),
+        ),
+        CRM_Core_Action::DELETE => array(
+          'name' => ts('Delete'),
+          'url' => 'civicrm/mailing/browse',
+          'qs' => 'action=delete&mid=%%mid%%&reset=1',
+          'extra' => 'onclick="if (confirm(\'' . $deleteExtra . '\')) this.href+=\'&amp;confirmed=1\'; else return false;"',
+          'title' => ts('Delete Mailing'),
+        ),
+        CRM_Core_Action::RENEW => array(
+          'name' => ts('Archive'),
+          'url' => 'civicrm/mailing/browse/archived',
+          'qs' => 'action=renew&mid=%%mid%%&reset=1',
+          'extra' => 'onclick="if (confirm(\'' . $archiveExtra . '\')) this.href+=\'&amp;confirmed=1\'; else return false;"',
+          'title' => ts('Archive Mailing'),
+        ),
+      );
+    }
+
+    $allAccess = TRUE;
+    $workFlow = $showApprovalLinks = $showScheduleLinks = $showCreateLinks = FALSE;
+    if (CRM_Mailing_Info::workflowEnabled()) {
+      $allAccess = FALSE;
+      $workFlow = TRUE;
+      // supercedes all permission
+      if (CRM_Core_Permission::check('access CiviMail')) {
+        $allAccess = TRUE;
+      }
+
+      if (CRM_Core_Permission::check('approve mailings')) {
+        $showApprovalLinks = TRUE;
+      }
+
+      if (CRM_Core_Permission::check('create mailings')) {
+        $showCreateLinks = TRUE;
+      }
+
+      if (CRM_Core_Permission::check('schedule mailings')) {
+        $showScheduleLinks = TRUE;
+      }
+    }
+    $mailing = new CRM_Mailing_BAO_Mailing();
+
+    $params = array();
+
+    $whereClause = ' AND ' . $this->whereClause($params);
+
+    if (empty($params)) {
+      $this->_parent->assign('isSearch', 0);
+    }
+    else {
+      $this->_parent->assign('isSearch', 1);
+    }
+    $rows = &$mailing->getRows($offset, $rowCount, $sort, $whereClause, $params);
+
+    // get the search base mailing Ids, CRM-3711.
+    $searchMailings = $mailing->searchMailingIDs();
+
+    // check for delete CRM-4418
+    $allowToDelete = CRM_Core_Permission::check('delete in CiviMail');
+
+    if ($output != CRM_Core_Selector_Controller::EXPORT) {
+
+      // create the appropriate $op to use for hook_civicrm_links
+      $pageTypes = array('view', 'mailing', 'browse');
+      if ($this->_parent->_unscheduled) {
+        $pageTypes[] = 'unscheduled';
+      }
+      if ($this->_parent->_scheduled) {
+        $pageTypes[] = 'scheduled';
+      }
+      if ($this->_parent->_archived) {
+        $pageTypes[] = 'archived';
+      }
+      $opString = implode('.', $pageTypes);
+
+      // get languages for later conversion
+      $languages = CRM_Core_I18n::languages();
+
+      foreach ($rows as $key => $row) {
+        $actionMask = NULL;
+        if ($row['sms_provider_id']) {
+          $actionLinks[CRM_Core_Action::PREVIEW]['url'] = 'civicrm/sms/send';
+        }
+
+        if (!($row['status'] == 'Not scheduled') && !$row['sms_provider_id']) {
+          if ($allAccess || $showCreateLinks) {
+            $actionMask = CRM_Core_Action::VIEW;
+          }
+
+          if (!in_array($row['id'], $searchMailings)) {
+            if ($allAccess || $showCreateLinks) {
+              $actionMask |= CRM_Core_Action::UPDATE;
+            }
+          }
+        }
+        else {
+          if ($allAccess || ($showCreateLinks || $showScheduleLinks)) {
+            $actionMask = CRM_Core_Action::PREVIEW;
+          }
+        }
+        if (in_array($row['status'], array(
+          'Scheduled',
+          'Running',
+          'Paused',
+        ))) {
+          if ($allAccess ||
+            ($showApprovalLinks && $showCreateLinks && $showScheduleLinks)
+          ) {
+
+            $actionMask |= CRM_Core_Action::DISABLE;
+          }
+          if ($row['status'] == 'Scheduled' &&
+            empty($row['approval_status_id'])
+          ) {
+            if ($workFlow && ($allAccess || $showApprovalLinks)) {
+              $actionMask |= CRM_Core_Action::ENABLE;
+            }
+          }
+        }
+
+        if (in_array($row['status'], array('Complete', 'Canceled')) &&
+          !$row['archived']
+        ) {
+          if ($allAccess || $showCreateLinks) {
+            $actionMask |= CRM_Core_Action::RENEW;
+          }
+        }
+
+        // check for delete permission.
+        if ($allowToDelete) {
+          $actionMask |= CRM_Core_Action::DELETE;
+        }
+
+        if ($actionMask == NULL) {
+          $actionMask = CRM_Core_Action::ADD;
+        }
+        // get status strings as per locale settings CRM-4411.
+        $rows[$key]['status'] = CRM_Mailing_BAO_MailingJob::status($row['status']);
+
+        // get language string
+        $rows[$key]['language'] = (isset($row['language']) ? $languages[$row['language']] : NULL);
+
+        $validLinks = $actionLinks;
+        if (($mailingUrl = CRM_Mailing_BAO_Mailing::getPublicViewUrl($row['id'])) != FALSE) {
+          $validLinks[] = array(
+            'name' => ts('Public View'),
+            'url' => 'civicrm/mailing/view',
+            'qs' => 'id=%%mid%%&reset=1',
+            'title' => ts('Public View'),
+            'fe' => TRUE,
+          );
+        }
+
+        $rows[$key]['action'] = CRM_Core_Action::formLink(
+          $validLinks,
+          $actionMask,
+          array('mid' => $row['id']),
+          "more",
+          FALSE,
+          $opString,
+          "Mailing",
+          $row['id']
+        );
+
+        // unset($rows[$key]['id']);
+        // if the scheduled date is 0, replace it with an empty string
+        if ($rows[$key]['scheduled_iso'] == '0000-00-00 00:00:00') {
+          $rows[$key]['scheduled'] = '';
+        }
+        unset($rows[$key]['scheduled_iso']);
+      }
+    }
+
+    // also initialize the AtoZ pager
+    $this->pagerAtoZ();
+    return $rows;
+  }
+
+  /**
+   * Name of export file.
+   *
+   * @param string $output
+   *   Type of output.
+   *
+   * @return string
+   *   name of the file
+   */
+  public function getExportFileName($output = 'csv') {
+    return ts('CiviMail Mailings');
+  }
+
+  /**
+   * @param $parent
+   */
+  public function setParent($parent) {
+    $this->_parent = $parent;
+  }
+
+  /**
+   * @param array $params
+   * @param bool $sortBy
+   *
+   * @return int|string
+   */
+  public function whereClause(&$params, $sortBy = TRUE) {
+    $values = $clauses = array();
+    $isFormSubmitted = $this->_parent->get('hidden_find_mailings');
+
+    $title = $this->_parent->get('mailing_name');
+    if ($title) {
+      $clauses[] = 'name LIKE %1';
+      if (strpos($title, '%') !== FALSE) {
+        $params[1] = array($title, 'String', FALSE);
+      }
+      else {
+        $params[1] = array($title, 'String', TRUE);
+      }
+    }
+
+    $dateClause1 = $dateClause2 = array();
+    $from = $this->_parent->get('mailing_from');
+    if (!CRM_Utils_System::isNull($from)) {
+      if ($this->_parent->get('unscheduled')) {
+        $dateClause1[] = 'civicrm_mailing.created_date >= %2';
+      }
+      else {
+        $dateClause1[] = 'civicrm_mailing_job.start_date >= %2';
+        $dateClause2[] = 'civicrm_mailing_job.scheduled_date >= %2';
+      }
+      $params[2] = array($from, 'String');
+    }
+
+    $to = $this->_parent->get('mailing_to');
+    if (!CRM_Utils_System::isNull($to)) {
+      if ($this->_parent->get('unscheduled')) {
+        $dateClause1[] = ' civicrm_mailing.created_date <= %3 ';
+      }
+      else {
+        $dateClause1[] = 'civicrm_mailing_job.start_date <= %3';
+        $dateClause2[] = 'civicrm_mailing_job.scheduled_date <= %3';
+      }
+      $params[3] = array($to, 'String');
+    }
+
+    $dateClauses = array();
+    if (!empty($dateClause1)) {
+      $dateClauses[] = implode(' AND ', $dateClause1);
+    }
+    if (!empty($dateClause2)) {
+      $dateClauses[] = implode(' AND ', $dateClause2);
+    }
+    $dateClauses = implode(' OR ', $dateClauses);
+    if (!empty($dateClauses)) {
+      $clauses[] = "({$dateClauses})";
+    }
+
+    if ($this->_parent->get('sms')) {
+      $clauses[] = "civicrm_mailing.sms_provider_id IS NOT NULL";
+    }
+    else {
+      $clauses[] = "civicrm_mailing.sms_provider_id IS NULL";
+    }
+
+    // get values submitted by form
+    $isDraft = $this->_parent->get('status_unscheduled');
+    $isArchived = $this->_parent->get('is_archived');
+    $mailingStatus = $this->_parent->get('mailing_status');
+
+    if (!$isFormSubmitted && $this->_parent->get('scheduled')) {
+      // mimic default behavior for scheduled screen
+      $isArchived = 0;
+      $mailingStatus = array('Scheduled' => 1, 'Complete' => 1, 'Running' => 1, 'Canceled' => 1);
+    }
+    if (!$isFormSubmitted && $this->_parent->get('archived')) {
+      // mimic default behavior for archived screen
+      $isArchived = 1;
+    }
+    if (!$isFormSubmitted && $this->_parent->get('unscheduled')) {
+      // mimic default behavior for draft screen
+      $isDraft = 1;
+    }
+
+    $statusClauses = array();
+    if ($isDraft) {
+      $statusClauses[] = "civicrm_mailing.scheduled_id IS NULL";
+    }
+    if (!empty($mailingStatus)) {
+      $statusClauses[] = "civicrm_mailing_job.status IN ('" . implode("', '", array_keys($mailingStatus)) . "')";
+    }
+    if (!empty($statusClauses)) {
+      $clauses[] = "(" . implode(' OR ', $statusClauses) . ")";
+    }
+
+    if (isset($isArchived)) {
+      if ($isArchived) {
+        $clauses[] = "civicrm_mailing.is_archived = 1";
+      }
+      else {
+        $clauses[] = "(civicrm_mailing.is_archived IS NULL OR civicrm_mailing.is_archived = 0)";
+      }
+    }
+
+    if ($sortBy &&
+      $this->_parent->_sortByCharacter !== NULL
+    ) {
+      $clauses[] = "name LIKE '" . strtolower(CRM_Core_DAO::escapeWildCardString($this->_parent->_sortByCharacter)) . "%'";
+    }
+
+    // dont do a the below assignement when doing a
+    // AtoZ pager clause
+    if ($sortBy) {
+      if (count($clauses) > 1) {
+        $this->_parent->assign('isSearch', 1);
+      }
+      else {
+        $this->_parent->assign('isSearch', 0);
+      }
+    }
+
+    $createOrSentBy = $this->_parent->get('sort_name');
+    if (!CRM_Utils_System::isNull($createOrSentBy)) {
+      $clauses[] = '(createdContact.sort_name LIKE %4 OR scheduledContact.sort_name LIKE %4)';
+      $params[4] = array('%' . $createOrSentBy . '%', 'String');
+    }
+
+    $createdId = $this->_parent->get('createdId');
+    if ($createdId) {
+      $clauses[] = "(created_id = {$createdId})";
+      $params[5] = array($createdId, 'Integer');
+    }
+
+    $campainIds = $this->_parent->get('campaign_id');
+    if (!CRM_Utils_System::isNull($campainIds)) {
+      if (!is_array($campainIds)) {
+        $campaignIds = array($campaignIds);
+      }
+      $clauses[] = '( campaign_id IN ( ' . implode(' , ', array_values($campainIds)) . ' ) )';
+    }
+
+    if ($language = $this->_parent->get('language')) {
+      $clauses[] = "civicrm_mailing.language = %6";
+      $params[6] = array($language, 'String');
+    }
+
+    if (empty($clauses)) {
+      return 1;
+    }
+
+    return implode(' AND ', $clauses);
+  }
+
+  public function pagerAtoZ() {
+
+    $params = array();
+    $whereClause = $this->whereClause($params, FALSE);
+
+    $query = "
+SELECT DISTINCT UPPER(LEFT(name, 1)) as sort_name
+FROM civicrm_mailing
+LEFT JOIN civicrm_mailing_job ON (civicrm_mailing_job.mailing_id = civicrm_mailing.id)
+LEFT JOIN civicrm_contact createdContact ON ( civicrm_mailing.created_id = createdContact.id )
+LEFT JOIN civicrm_contact scheduledContact ON ( civicrm_mailing.scheduled_id = scheduledContact.id )
+WHERE $whereClause
+ORDER BY UPPER(LEFT(name, 1))
+";
+
+    $dao = CRM_Core_DAO::executeQuery($query, $params);
+
+    $aToZBar = CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_parent->_sortByCharacter, TRUE);
+    $this->_parent->assign('aToZ', $aToZBar);
+  }
+
+}

sites/all/modules/civicrm/CRM/Mailing/Selector/Event.php

@@ -0,0 +1,475 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.7                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2017                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC (c) 2004-2017
+ */
+
+/**
+ * This class is used to retrieve and display a range of
+ * contacts that match the given criteria (specifically for
+ * results of advanced search options.
+ */
+class CRM_Mailing_Selector_Event extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
+
+  /**
+   * Array of supported links, currently null
+   *
+   * @var array
+   */
+  static $_links = NULL;
+
+  /**
+   * What event type are we browsing?
+   */
+  private $_event;
+
+  /**
+   * Should we only count distinct contacts?
+   */
+  private $_is_distinct;
+
+  /**
+   * Which mailing are we browsing events from?
+   */
+  private $_mailing_id;
+
+  /**
+   * Do we want events tied to a specific job?
+   */
+  private $_job_id;
+
+  /**
+   * For click-through events, do we only want those from a specific url?
+   */
+  private $_url_id;
+
+  /**
+   * We use desc to remind us what that column is, name is used in the tpl
+   *
+   * @var array
+   */
+  public $_columnHeaders;
+
+  /**
+   * Class constructor.
+   *
+   * @param string $event
+   *   The event type (queue/delivered/open...).
+   * @param bool $distinct
+   *   Count only distinct contact events?.
+   * @param int $mailing
+   *   ID of the mailing to query.
+   * @param int $job
+   *   ID of the job to query. If null, all jobs from $mailing are queried.
+   * @param int $url
+   *   If the event type is a click-through, do we want only those from a specific url?.
+   *
+   * @return \CRM_Mailing_Selector_Event
+   */
+  public function __construct($event, $distinct, $mailing, $job = NULL, $url = NULL) {
+    $this->_event_type = $event;
+    $this->_is_distinct = $distinct;
+    $this->_mailing_id = $mailing;
+    $this->_job_id = $job;
+    $this->_url_id = $url;
+  }
+
+  /**
+   * This method returns the links that are given for each search row.
+   *
+   * @return array
+   */
+  public static function &links() {
+    return self::$_links;
+  }
+
+  /**
+   * Getter for array of the parameters required for creating pager.
+   *
+   * @param $action
+   * @param array $params
+   */
+  public function getPagerParams($action, &$params) {
+    $params['csvString'] = NULL;
+    $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
+    $params['status'] = ts('%1 %%StatusMessage%%', array(1 => $this->eventToTitle()));
+    $params['buttonTop'] = 'PagerTopButton';
+    $params['buttonBottom'] = 'PagerBottomButton';
+  }
+
+  /**
+   * Returns the column headers as an array of tuples:
+   * (name, sortName (key to the sort array))
+   *
+   * @param string $action
+   *   The action being performed.
+   * @param string $output
+   *   What should the result set include (web/email/csv).
+   *
+   * @return array
+   *   the column headers that need to be displayed
+   */
+  public function &getColumnHeaders($action = NULL, $output = NULL) {
+    $mailing = CRM_Mailing_BAO_Mailing::getTableName();
+
+    $contact = CRM_Contact_BAO_Contact::getTableName();
+
+    $email = CRM_Core_BAO_Email::getTableName();
+
+    $job = CRM_Mailing_BAO_MailingJob::getTableName();
+    if (!isset($this->_columnHeaders)) {
+
+      $this->_columnHeaders = array(
+        'sort_name' => array(
+          'name' => ts('Contact'),
+          'sort' => $contact . '.sort_name',
+          'direction' => CRM_Utils_Sort::ASCENDING,
+        ),
+        'email' => array(
+          'name' => ts('Email Address'),
+          'sort' => $email . '.email',
+          'direction' => CRM_Utils_Sort::DONTCARE,
+        ),
+      );
+
+      switch ($this->_event_type) {
+        case 'queue':
+          $dateSort = $job . '.start_date';
+          break;
+
+        case 'delivered':
+          $this->_columnHeaders = array(
+            'contact_id' => array(
+              'name' => ts('Internal Contact ID'),
+              'sort' => $contact . '.id',
+              'direction' => CRM_Utils_Sort::ASCENDING,
+            ),
+          ) + $this->_columnHeaders;
+          $dateSort = CRM_Mailing_Event_BAO_Delivered::getTableName() . '.time_stamp';
+          break;
+
+        case 'opened':
+          $dateSort = CRM_Mailing_Event_BAO_Opened::getTableName() . '.time_stamp';
+          break;
+
+        case 'bounce':
+          $dateSort = CRM_Mailing_Event_BAO_Bounce::getTableName() . '.time_stamp';
+          $this->_columnHeaders = array_merge($this->_columnHeaders,
+            array(
+              array(
+                'name' => ts('Bounce Type'),
+              ),
+              array(
+                'name' => ts('Bounce Reason'),
+              ),
+            )
+          );
+          break;
+
+        case 'forward':
+          $dateSort = CRM_Mailing_Event_BAO_Forward::getTableName() . '.time_stamp';
+
+          $this->_columnHeaders = array_merge($this->_columnHeaders,
+            array(
+              array(
+                'name' => ts('Forwarded Email'),
+              ),
+            )
+          );
+          break;
+
+        case 'reply':
+          $dateSort = CRM_Mailing_Event_BAO_Reply::getTableName() . '.time_stamp';
+          break;
+
+        case 'unsubscribe':
+          $dateSort = CRM_Mailing_Event_BAO_Unsubscribe::getTableName() . '.time_stamp';
+          $this->_columnHeaders = array_merge($this->_columnHeaders, array(
+            array(
+              'name' => ts('Unsubscribe'),
+            ),
+          ));
+          break;
+
+        case 'optout':
+          $dateSort = CRM_Mailing_Event_BAO_Unsubscribe::getTableName() . '.time_stamp';
+          $this->_columnHeaders = array_merge($this->_columnHeaders, array(
+            array(
+              'name' => ts('Opt-Out'),
+            ),
+          ));
+          break;
+
+        case 'click':
+          $dateSort = CRM_Mailing_Event_BAO_TrackableURLOpen::getTableName() . '.time_stamp';
+          $this->_columnHeaders = array_merge($this->_columnHeaders, array(
+            array(
+              'name' => ts('URL'),
+            ),
+          ));
+          break;
+
+        default:
+          return 0;
+      }
+
+      $this->_columnHeaders = array_merge($this->_columnHeaders, array(
+        'date' => array(
+          'name' => ts('Date'),
+          'sort' => $dateSort,
+          'direction' => CRM_Utils_Sort::DESCENDING,
+        ),
+      ));
+    }
+    return $this->_columnHeaders;
+  }
+
+  /**
+   * Returns total number of rows for the query.
+   *
+   * @param string $action
+   *
+   * @return int
+   *   Total number of rows
+   */
+  public function getTotalCount($action) {
+    switch ($this->_event_type) {
+      case 'queue':
+        $event = new CRM_Mailing_Event_BAO_Queue();
+        $result = $event->getTotalCount($this->_mailing_id,
+          $this->_job_id
+        );
+        return $result;
+
+      case 'delivered':
+        $event = new CRM_Mailing_Event_BAO_Delivered();
+        $result = $event->getTotalCount($this->_mailing_id,
+          $this->_job_id,
+          $this->_is_distinct
+        );
+        return $result;
+
+      case 'opened':
+        $event = new CRM_Mailing_Event_BAO_Opened();
+        $result = $event->getTotalCount($this->_mailing_id,
+          $this->_job_id,
+          $this->_is_distinct
+        );
+        return $result;
+
+      case 'bounce':
+        $event = new CRM_Mailing_Event_BAO_Bounce();
+        $result = $event->getTotalCount($this->_mailing_id,
+          $this->_job_id,
+          $this->_is_distinct
+        );
+        return $result;
+
+      case 'forward':
+        $event = new CRM_Mailing_Event_BAO_Forward();
+        $result = $event->getTotalCount($this->_mailing_id,
+          $this->_job_id,
+          $this->_is_distinct
+        );
+        return $result;
+
+      case 'reply':
+        $event = new CRM_Mailing_Event_BAO_Reply();
+        $result = $event->getTotalCount($this->_mailing_id,
+          $this->_job_id,
+          $this->_is_distinct
+        );
+        return $result;
+
+      case 'unsubscribe':
+        $event = new CRM_Mailing_Event_BAO_Unsubscribe();
+        $result = $event->getTotalCount($this->_mailing_id,
+          $this->_job_id,
+          $this->_is_distinct
+        );
+        return $result;
+
+      case 'optout':
+        $event = new CRM_Mailing_Event_BAO_Unsubscribe();
+        $result = $event->getTotalCount($this->_mailing_id,
+          $this->_job_id,
+          $this->_is_distinct,
+          FALSE
+        );
+        return $result;
+
+      case 'click':
+        $event = new CRM_Mailing_Event_BAO_TrackableURLOpen();
+        $result = $event->getTotalCount($this->_mailing_id,
+          $this->_job_id,
+          $this->_is_distinct,
+          $this->_url_id
+        );
+        return $result;
+
+      default:
+        return 0;
+    }
+  }
+
+  /**
+   * Returns all the rows in the given offset and rowCount.
+   *
+   * @param string $action
+   *   The action being performed.
+   * @param int $offset
+   *   The row number to start from.
+   * @param int $rowCount
+   *   The number of rows to return.
+   * @param string $sort
+   *   The sql string that describes the sort order.
+   * @param string $output
+   *   What should the result set include (web/email/csv).
+   *
+   * @return int
+   *   the total number of rows for this action
+   */
+  public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
+    switch ($this->_event_type) {
+      case 'queue':
+        $rows = CRM_Mailing_Event_BAO_Queue::getRows($this->_mailing_id,
+          $this->_job_id, $offset, $rowCount, $sort
+        );
+        return $rows;
+
+      case 'delivered':
+        $rows = CRM_Mailing_Event_BAO_Delivered::getRows($this->_mailing_id,
+          $this->_job_id, $this->_is_distinct,
+          $offset, $rowCount, $sort
+        );
+        return $rows;
+
+      case 'opened':
+        $rows = CRM_Mailing_Event_BAO_Opened::getRows($this->_mailing_id,
+          $this->_job_id, $this->_is_distinct,
+          $offset, $rowCount, $sort
+        );
+        return $rows;
+
+      case 'bounce':
+        $rows = CRM_Mailing_Event_BAO_Bounce::getRows($this->_mailing_id,
+          $this->_job_id, $this->_is_distinct,
+          $offset, $rowCount, $sort
+        );
+        return $rows;
+
+      case 'forward':
+        $rows = CRM_Mailing_Event_BAO_Forward::getRows($this->_mailing_id,
+          $this->_job_id, $this->_is_distinct,
+          $offset, $rowCount, $sort
+        );
+        return $rows;
+
+      case 'reply':
+        $rows = CRM_Mailing_Event_BAO_Reply::getRows($this->_mailing_id,
+          $this->_job_id, $this->_is_distinct,
+          $offset, $rowCount, $sort
+        );
+        return $rows;
+
+      case 'unsubscribe':
+        $rows = CRM_Mailing_Event_BAO_Unsubscribe::getRows($this->_mailing_id,
+          $this->_job_id, $this->_is_distinct,
+          $offset, $rowCount, $sort, TRUE
+        );
+        return $rows;
+
+      case 'optout':
+        $rows = CRM_Mailing_Event_BAO_Unsubscribe::getRows($this->_mailing_id,
+          $this->_job_id, $this->_is_distinct,
+          $offset, $rowCount, $sort, FALSE
+        );
+        return $rows;
+
+      case 'click':
+        $rows = CRM_Mailing_Event_BAO_TrackableURLOpen::getRows(
+          $this->_mailing_id, $this->_job_id,
+          $this->_is_distinct, $this->_url_id,
+          $offset, $rowCount, $sort
+        );
+        return $rows;
+
+      default:
+        return NULL;
+    }
+  }
+
+  /**
+   * Name of export file.
+   *
+   * @param string $output
+   *   Type of output.
+   *
+   * @return string|NULL
+   *   name of the file
+   */
+  public function getExportFileName($output = 'csv') {
+    return NULL;
+  }
+
+  /**
+   * Get the title for the mailing event type.
+   *
+   * @return string
+   */
+  public function eventToTitle() {
+    static $events = NULL;
+
+    if (empty($events)) {
+      $events = array(
+        'queue' => ts('Intended Recipients'),
+        'delivered' => ts('Successful Deliveries'),
+        'bounce' => ts('Bounces'),
+        'forward' => ts('Forwards'),
+        'reply' => $this->_is_distinct ? ts('Unique Replies') : ts('Replies'),
+        'unsubscribe' => ts('Unsubscribe Requests'),
+        'optout' => ts('Opt-out Requests'),
+        'click' => $this->_is_distinct ? ts('Unique Click-throughs') : ts('Click-throughs'),
+        'opened' => $this->_is_distinct ? ts('Unique Tracked Opens') : ts('Total Tracked Opens'),
+      );
+    }
+    return $events[$this->_event_type];
+  }
+
+  /**
+   * Get the title of the event.
+   *
+   * @return string
+   */
+  public function getTitle() {
+    return $this->eventToTitle();
+  }
+
+}

sites/all/modules/civicrm/CRM/Mailing/Selector/Search.php

@@ -0,0 +1,415 @@
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.7                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2017                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC (c) 2004-2017
+ */
+
+/**
+ * This class is used to retrieve and display a range of
+ * contacts that match the given criteria (specifically for
+ * results of advanced search options.
+ */
+class CRM_Mailing_Selector_Search extends CRM_Core_Selector_Base implements CRM_Core_Selector_API {
+
+  /**
+   * This defines two actions- View and Edit.
+   *
+   * @var array
+   */
+  static $_links = NULL;
+
+  /**
+   * We use desc to remind us what that column is, name is used in the tpl
+   *
+   * @var array
+   */
+  static $_columnHeaders;
+
+  /**
+   * Properties of contact we're interested in displaying
+   * @var array
+   */
+  static $_properties = array(
+    'contact_id',
+    'mailing_id',
+    'mailing_name',
+    'language',
+    'sort_name',
+    'email',
+    'mailing_subject',
+    'email_on_hold',
+    'contact_opt_out',
+    'mailing_job_status',
+    'mailing_job_end_date',
+  );
+
+  /**
+   * Are we restricting ourselves to a single contact
+   *
+   * @var boolean
+   */
+  protected $_single = FALSE;
+
+  /**
+   * Are we restricting ourselves to a single contact
+   *
+   * @var boolean
+   */
+  protected $_limit = NULL;
+
+  /**
+   * What context are we being invoked from
+   *
+   * @var string
+   */
+  protected $_context = NULL;
+
+  /**
+   * What component context are we being invoked from
+   *
+   * @var string
+   */
+  protected $_compContext = NULL;
+
+  /**
+   * QueryParams is the array returned by exportValues called on
+   * the HTML_QuickForm_Controller for that page.
+   *
+   * @var array
+   */
+  public $_queryParams;
+
+  /**
+   * Represent the type of selector.
+   *
+   * @var int
+   */
+  protected $_action;
+
+  /**
+   * The additional clause that we restrict the search with.
+   *
+   * @var string
+   */
+  protected $_mailingClause = NULL;
+
+  /**
+   * The query object.
+   *
+   * @var string
+   */
+  protected $_query;
+
+  /**
+   * Class constructor.
+   *
+   * @param array $queryParams
+   *   Array of parameters for query.
+   * @param \const|int $action - action of search basic or advanced.
+   * @param string $mailingClause
+   *   If the caller wants to further restrict the search.
+   * @param bool $single
+   *   Are we dealing only with one contact?.
+   * @param int $limit
+   *   How many mailing do we want returned.
+   *
+   * @param string $context
+   * @param null $compContext
+   *
+   * @return \CRM_Mailing_Selector_Search
+   */
+  public function __construct(
+    &$queryParams,
+    $action = CRM_Core_Action::NONE,
+    $mailingClause = NULL,
+    $single = FALSE,
+    $limit = NULL,
+    $context = 'search',
+    $compContext = NULL
+  ) {
+    // submitted form values
+    $this->_queryParams = &$queryParams;
+
+    $this->_single = $single;
+    $this->_limit = $limit;
+    $this->_context = $context;
+    $this->_compContext = $compContext;
+
+    $this->_mailingClause = $mailingClause;
+
+    // type of selector
+    $this->_action = $action;
+    $this->_query = new CRM_Contact_BAO_Query($this->_queryParams,
+      CRM_Mailing_BAO_Query::defaultReturnProperties(CRM_Contact_BAO_Query::MODE_MAILING,
+        FALSE
+      ),
+      NULL, FALSE, FALSE,
+      CRM_Contact_BAO_Query::MODE_MAILING
+    );
+
+    $this->_query->_distinctComponentClause = " civicrm_mailing_recipients.id ";
+  }
+
+  /**
+   * This method returns the links that are given for each search row.
+   * currently the links added for each row are
+   *
+   * - View
+   * - Edit
+   *
+   * @return array
+   */
+  public static function &links() {
+    if (!(self::$_links)) {
+      list($context, $key) = func_get_args();
+      $extraParams = ($key) ? "&key={$key}" : NULL;
+      $searchContext = ($context) ? "&context=$context" : NULL;
+
+      self::$_links = array(
+        CRM_Core_Action::VIEW => array(
+          'name' => ts('View'),
+          'url' => 'civicrm/contact/view',
+          'qs' => "reset=1&cid=%%cid%%{$searchContext}{$extraParams}",
+          'title' => ts('View Contact Details'),
+        ),
+        CRM_Core_Action::UPDATE => array(
+          'name' => ts('Edit'),
+          'url' => 'civicrm/contact/add',
+          'qs' => "reset=1&action=update&cid=%%cid%%{$searchContext}{$extraParams}",
+          'title' => ts('Edit Contact Details'),
+        ),
+        CRM_Core_Action::DELETE => array(
+          'name' => ts('Delete'),
+          'url' => 'civicrm/contact/view/delete',
+          'qs' => "reset=1&delete=1&cid=%%cid%%{$searchContext}{$extraParams}",
+          'title' => ts('Delete Contact'),
+        ),
+      );
+    }
+    return self::$_links;
+  }
+
+  /**
+   * Getter for array of the parameters required for creating pager.
+   *
+   * @param $action
+   * @param array $params
+   */
+  public function getPagerParams($action, &$params) {
+    $params['status'] = ts('Mailing Recipient') . ' %%StatusMessage%%';
+    $params['csvString'] = NULL;
+    if ($this->_limit) {
+      $params['rowCount'] = $this->_limit;
+    }
+    else {
+      $params['rowCount'] = CRM_Utils_Pager::ROWCOUNT;
+    }
+
+    $params['buttonTop'] = 'PagerTopButton';
+    $params['buttonBottom'] = 'PagerBottomButton';
+  }
+
+  /**
+   * Returns total number of rows for the query.
+   *
+   * @param string $action
+   *
+   * @return int
+   *   Total number of rows
+   */
+  public function getTotalCount($action) {
+    return $this->_query->searchQuery(0, 0, NULL,
+      TRUE, FALSE,
+      FALSE, FALSE,
+      FALSE,
+      $this->_mailingClause
+    );
+  }
+
+  /**
+   * Returns all the rows in the given offset and rowCount.
+   *
+   * @param string $action
+   *   The action being performed.
+   * @param int $offset
+   *   The row number to start from.
+   * @param int $rowCount
+   *   The number of rows to return.
+   * @param string $sort
+   *   The sql string that describes the sort order.
+   * @param string $output
+   *   What should the result set include (web/email/csv).
+   *
+   * @return int
+   *   the total number of rows for this action
+   */
+  public function &getRows($action, $offset, $rowCount, $sort, $output = NULL) {
+    $result = $this->_query->searchQuery($offset, $rowCount, $sort,
+      FALSE, FALSE,
+      FALSE, FALSE,
+      FALSE,
+      $this->_mailingClause
+    );
+
+    // process the result of the query
+    $rows = array();
+    $permissions = array(CRM_Core_Permission::getPermission());
+    if (CRM_Core_Permission::check('delete contacts')) {
+      $permissions[] = CRM_Core_Permission::DELETE;
+    }
+    $mask = CRM_Core_Action::mask($permissions);
+    $qfKey = $this->_key;
+
+    while ($result->fetch()) {
+      $row = array();
+      // the columns we are interested in
+      foreach (self::$_properties as $property) {
+        if (property_exists($result, $property)) {
+          $row[$property] = $result->$property;
+        }
+      }
+
+      $row['checkbox'] = CRM_Core_Form::CB_PREFIX . $result->mailing_recipients_id;
+
+      $actions = array(
+        'cid' => $result->contact_id,
+        'cxt' => $this->_context,
+      );
+
+      $row['action'] = CRM_Core_Action::formLink(
+        self::links($qfKey, $this->_context),
+        $mask,
+        $actions,
+        ts('more'),
+        FALSE,
+        'contact.mailing.row',
+        'Contact',
+        $result->contact_id
+      );
+      $row['contact_type'] = CRM_Contact_BAO_Contact_Utils::getImage($result->contact_sub_type ? $result->contact_sub_type : $result->contact_type, FALSE, $result->contact_id
+      );
+
+      $rows[] = $row;
+    }
+    return $rows;
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public function getQILL() {
+    return $this->_query->qill();
+  }
+
+  /**
+   * Returns the column headers as an array of tuples:
+   * (name, sortName (key to the sort array))
+   *
+   * @param string $action
+   *   The action being performed.
+   * @param string $output
+   *   What should the result set include (web/email/csv).
+   *
+   * @return array
+   *   the column headers that need to be displayed
+   */
+  public function &getColumnHeaders($action = NULL, $output = NULL) {
+    if (!isset(self::$_columnHeaders)) {
+      self::$_columnHeaders = array(
+        array('desc' => ts('Contact Type')),
+        array(
+          'name' => ts('Name'),
+          'sort' => 'sort_name',
+          'direction' => CRM_Utils_Sort::DONTCARE,
+        ),
+        array(
+          'name' => ts('Email'),
+          'sort' => 'email',
+          'direction' => CRM_Utils_Sort::DONTCARE,
+        ),
+        array(
+          'name' => ts('Mailing Name'),
+          'sort' => 'mailing_name',
+          'direction' => CRM_Utils_Sort::DONTCARE,
+        ),
+        array(
+          'name' => ts('Language'),
+          'sort' => 'language',
+          'direction' => CRM_Utils_Sort::DONTCARE,
+        ),
+        array(
+          'name' => ts('Mailing Subject'),
+          'sort' => 'mailing_subject',
+          'direction' => CRM_Utils_Sort::DONTCARE,
+        ),
+        array(
+          'name' => ts('Mailing Status'),
+          'sort' => 'mailing_job_status',
+          'direction' => CRM_Utils_Sort::DONTCARE,
+        ),
+        array(
+          'name' => ts('Completed Date'),
+          'sort' => 'mailing_job_end_date',
+          'direction' => CRM_Utils_Sort::DONTCARE,
+        ),
+        array('desc' => ts('Actions')),
+      );
+    }
+    return self::$_columnHeaders;
+  }
+
+  /**
+   * @return mixed
+   */
+  public function alphabetQuery() {
+    return $this->_query->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
+  }
+
+  /**
+   * @return string
+   */
+  public function &getQuery() {
+    return $this->_query;
+  }
+
+  /**
+   * Name of export file.
+   *
+   * @param string $output
+   *   Type of output.
+   *
+   * @return string
+   *   name of the file
+   */
+  public function getExportFileName($output = 'csv') {
+    return ts('CiviCRM Mailing Search');
+  }
+
+}